b3f97e1eaea045cc2dd8c34939d0f3d5af5c70db
[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.87"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2016
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" "deferred deliveries"
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 is set at build time). 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"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
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 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 .cindex "header lines" "From:"
2631 .cindex "header lines" "Sender:"
2632 For a trusted user, there is never any check on the contents of the &'From:'&
2633 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2634 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2635
2636 Trusted users may also specify a host name, host address, interface address,
2637 protocol name, ident value, and authentication data when submitting a message
2638 locally. Thus, they are able to insert messages into Exim's queue locally that
2639 have the characteristics of messages received from a remote host. Untrusted
2640 users may in some circumstances use &%-f%&, but can never set the other values
2641 that are available to trusted users.
2642 .next
2643 .cindex "user" "admin definition of"
2644 .cindex "admin user" "definition of"
2645 The admin users are root, the Exim user, and any user that is a member of the
2646 Exim group or of any group listed in the &%admin_groups%& configuration option.
2647 The current group does not have to be one of these groups.
2648
2649 Admin users are permitted to list the queue, and to carry out certain
2650 operations on messages, for example, to force delivery failures. It is also
2651 necessary to be an admin user in order to see the full information provided by
2652 the Exim monitor, and full debugging output.
2653
2654 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2655 Exim to attempt delivery of messages on its queue is restricted to admin users.
2656 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2657 option false (that is, specifying &%no_prod_requires_admin%&).
2658
2659 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2660 is restricted to admin users unless &%queue_list_requires_admin%& is set
2661 false.
2662 .endlist
2663
2664
2665 &*Warning*&: If you configure your system so that admin users are able to
2666 edit Exim's configuration file, you are giving those users an easy way of
2667 getting root. There is further discussion of this issue at the start of chapter
2668 &<<CHAPconf>>&.
2669
2670
2671
2672
2673 .section "Command line options" "SECID39"
2674 Exim's command line options are described in alphabetical order below. If none
2675 of the options that specifies a specific action (such as starting the daemon or
2676 a queue runner, or testing an address, or receiving a message in a specific
2677 format, or listing the queue) are present, and there is at least one argument
2678 on the command line, &%-bm%& (accept a local message on the standard input,
2679 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2680 outputs a brief message about itself and exits.
2681
2682 . ////////////////////////////////////////////////////////////////////////////
2683 . Insert a stylized XML comment here, to identify the start of the command line
2684 . options. This is for the benefit of the Perl script that automatically
2685 . creates a man page for the options.
2686 . ////////////////////////////////////////////////////////////////////////////
2687
2688 .literal xml
2689 <!-- === Start of command line options === -->
2690 .literal off
2691
2692
2693 .vlist
2694 .vitem &%--%&
2695 .oindex "--"
2696 .cindex "options" "command line; terminating"
2697 This is a pseudo-option whose only purpose is to terminate the options and
2698 therefore to cause subsequent command line items to be treated as arguments
2699 rather than options, even if they begin with hyphens.
2700
2701 .vitem &%--help%&
2702 .oindex "&%--help%&"
2703 This option causes Exim to output a few sentences stating what it is.
2704 The same output is generated if the Exim binary is called with no options and
2705 no arguments.
2706
2707 .vitem &%--version%&
2708 .oindex "&%--version%&"
2709 This option is an alias for &%-bV%& and causes version information to be
2710 displayed.
2711
2712 .vitem &%-Ac%& &&&
2713        &%-Am%&
2714 .oindex "&%-Ac%&"
2715 .oindex "&%-Am%&"
2716 These options are used by Sendmail for selecting configuration files and are
2717 ignored by Exim.
2718
2719 .vitem &%-B%&<&'type'&>
2720 .oindex "&%-B%&"
2721 .cindex "8-bit characters"
2722 .cindex "Sendmail compatibility" "8-bit characters"
2723 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2724 clean; it ignores this option.
2725
2726 .vitem &%-bd%&
2727 .oindex "&%-bd%&"
2728 .cindex "daemon"
2729 .cindex "SMTP" "listener"
2730 .cindex "queue runner"
2731 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2732 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2733 that the daemon should also initiate periodic queue runs.
2734
2735 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2736 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2737 disconnect from the controlling terminal. When running this way, it can be
2738 stopped by pressing ctrl-C.
2739
2740 By default, Exim listens for incoming connections to the standard SMTP port on
2741 all the host's running interfaces. However, it is possible to listen on other
2742 ports, on multiple ports, and only on specific interfaces. Chapter
2743 &<<CHAPinterfaces>>& contains a description of the options that control this.
2744
2745 When a listening daemon
2746 .cindex "daemon" "process id (pid)"
2747 .cindex "pid (process id)" "of daemon"
2748 is started without the use of &%-oX%& (that is, without overriding the normal
2749 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2750 in Exim's spool directory. This location can be overridden by setting
2751 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2752 running as root.
2753
2754 When &%-oX%& is used on the command line to start a listening daemon, the
2755 process id is not written to the normal pid file path. However, &%-oP%& can be
2756 used to specify a path on the command line if a pid file is required.
2757
2758 The SIGHUP signal
2759 .cindex "SIGHUP"
2760 .cindex "daemon" "restarting"
2761 can be used to cause the daemon to re-execute itself. This should be done
2762 whenever Exim's configuration file, or any file that is incorporated into it by
2763 means of the &%.include%& facility, is changed, and also whenever a new version
2764 of Exim is installed. It is not necessary to do this when other files that are
2765 referenced from the configuration (for example, alias files) are changed,
2766 because these are reread each time they are used.
2767
2768 .vitem &%-bdf%&
2769 .oindex "&%-bdf%&"
2770 This option has the same effect as &%-bd%& except that it never disconnects
2771 from the controlling terminal, even when no debugging is specified.
2772
2773 .vitem &%-be%&
2774 .oindex "&%-be%&"
2775 .cindex "testing" "string expansion"
2776 .cindex "expansion" "testing"
2777 Run Exim in expansion testing mode. Exim discards its root privilege, to
2778 prevent ordinary users from using this mode to read otherwise inaccessible
2779 files. If no arguments are given, Exim runs interactively, prompting for lines
2780 of data. Otherwise, it processes each argument in turn.
2781
2782 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2783 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2784 used without command line arguments. If successful, it uses the &[readline()]&
2785 function, which provides extensive line-editing facilities, for reading the
2786 test data. A line history is supported.
2787
2788 Long expansion expressions can be split over several lines by using backslash
2789 continuations. As in Exim's run time configuration, white space at the start of
2790 continuation lines is ignored. Each argument or data line is passed through the
2791 string expansion mechanism, and the result is output. Variable values from the
2792 configuration file (for example, &$qualify_domain$&) are available, but no
2793 message-specific values (such as &$message_exim_id$&) are set, because no message
2794 is being processed (but see &%-bem%& and &%-Mset%&).
2795
2796 &*Note*&: If you use this mechanism to test lookups, and you change the data
2797 files or databases you are using, you must exit and restart Exim before trying
2798 the same lookup again. Otherwise, because each Exim process caches the results
2799 of lookups, you will just get the same result as before.
2800
2801 .vitem &%-bem%&&~<&'filename'&>
2802 .oindex "&%-bem%&"
2803 .cindex "testing" "string expansion"
2804 .cindex "expansion" "testing"
2805 This option operates like &%-be%& except that it must be followed by the name
2806 of a file. For example:
2807 .code
2808 exim -bem /tmp/testmessage
2809 .endd
2810 The file is read as a message (as if receiving a locally-submitted non-SMTP
2811 message) before any of the test expansions are done. Thus, message-specific
2812 variables such as &$message_size$& and &$header_from:$& are available. However,
2813 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2814 recipients are read from the headers in the normal way, and are shown in the
2815 &$recipients$& variable. Note that recipients cannot be given on the command
2816 line, because further arguments are taken as strings to expand (just like
2817 &%-be%&).
2818
2819 .vitem &%-bF%&&~<&'filename'&>
2820 .oindex "&%-bF%&"
2821 .cindex "system filter" "testing"
2822 .cindex "testing" "system filter"
2823 This option is the same as &%-bf%& except that it assumes that the filter being
2824 tested is a system filter. The additional commands that are available only in
2825 system filters are recognized.
2826
2827 .vitem &%-bf%&&~<&'filename'&>
2828 .oindex "&%-bf%&"
2829 .cindex "filter" "testing"
2830 .cindex "testing" "filter file"
2831 .cindex "forward file" "testing"
2832 .cindex "testing" "forward file"
2833 .cindex "Sieve filter" "testing"
2834 This option runs Exim in user filter testing mode; the file is the filter file
2835 to be tested, and a test message must be supplied on the standard input. If
2836 there are no message-dependent tests in the filter, an empty file can be
2837 supplied.
2838
2839 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2840 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2841 filter and a user filter in the same run. For example:
2842 .code
2843 exim -bF /system/filter -bf /user/filter </test/message
2844 .endd
2845 This is helpful when the system filter adds header lines or sets filter
2846 variables that are used by the user filter.
2847
2848 If the test filter file does not begin with one of the special lines
2849 .code
2850 # Exim filter
2851 # Sieve filter
2852 .endd
2853 it is taken to be a normal &_.forward_& file, and is tested for validity under
2854 that interpretation. See sections &<<SECTitenonfilred>>& to
2855 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2856 redirection lists.
2857
2858 The result of an Exim command that uses &%-bf%&, provided no errors are
2859 detected, is a list of the actions that Exim would try to take if presented
2860 with the message for real. More details of filter testing are given in the
2861 separate document entitled &'Exim's interfaces to mail filtering'&.
2862
2863 When testing a filter file,
2864 .cindex "&""From""& line"
2865 .cindex "envelope sender"
2866 .oindex "&%-f%&" "for filter testing"
2867 the envelope sender can be set by the &%-f%& option,
2868 or by a &"From&~"& line at the start of the test message. Various parameters
2869 that would normally be taken from the envelope recipient address of the message
2870 can be set by means of additional command line options (see the next four
2871 options).
2872
2873 .vitem &%-bfd%&&~<&'domain'&>
2874 .oindex "&%-bfd%&"
2875 .vindex "&$qualify_domain$&"
2876 This sets the domain of the recipient address when a filter file is being
2877 tested by means of the &%-bf%& option. The default is the value of
2878 &$qualify_domain$&.
2879
2880 .vitem &%-bfl%&&~<&'local&~part'&>
2881 .oindex "&%-bfl%&"
2882 This sets the local part of the recipient address when a filter file is being
2883 tested by means of the &%-bf%& option. The default is the username of the
2884 process that calls Exim. A local part should be specified with any prefix or
2885 suffix stripped, because that is how it appears to the filter when a message is
2886 actually being delivered.
2887
2888 .vitem &%-bfp%&&~<&'prefix'&>
2889 .oindex "&%-bfp%&"
2890 This sets the prefix of the local part of the recipient address when a filter
2891 file is being tested by means of the &%-bf%& option. The default is an empty
2892 prefix.
2893
2894 .vitem &%-bfs%&&~<&'suffix'&>
2895 .oindex "&%-bfs%&"
2896 This sets the suffix of the local part of the recipient address when a filter
2897 file is being tested by means of the &%-bf%& option. The default is an empty
2898 suffix.
2899
2900 .vitem &%-bh%&&~<&'IP&~address'&>
2901 .oindex "&%-bh%&"
2902 .cindex "testing" "incoming SMTP"
2903 .cindex "SMTP" "testing incoming"
2904 .cindex "testing" "relay control"
2905 .cindex "relaying" "testing configuration"
2906 .cindex "policy control" "testing"
2907 .cindex "debugging" "&%-bh%& option"
2908 This option runs a fake SMTP session as if from the given IP address, using the
2909 standard input and output. The IP address may include a port number at the end,
2910 after a full stop. For example:
2911 .code
2912 exim -bh 10.9.8.7.1234
2913 exim -bh fe80::a00:20ff:fe86:a061.5678
2914 .endd
2915 When an IPv6 address is given, it is converted into canonical form. In the case
2916 of the second example above, the value of &$sender_host_address$& after
2917 conversion to the canonical form is
2918 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2919
2920 Comments as to what is going on are written to the standard error file. These
2921 include lines beginning with &"LOG"& for anything that would have been logged.
2922 This facility is provided for testing configuration options for incoming
2923 messages, to make sure they implement the required policy. For example, you can
2924 test your relay controls using &%-bh%&.
2925
2926 &*Warning 1*&:
2927 .cindex "RFC 1413"
2928 You can test features of the configuration that rely on ident (RFC 1413)
2929 information by using the &%-oMt%& option. However, Exim cannot actually perform
2930 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2931 connection.
2932
2933 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2934 are also skipped when testing using &%-bh%&. If you want these callouts to
2935 occur, use &%-bhc%& instead.
2936
2937 Messages supplied during the testing session are discarded, and nothing is
2938 written to any of the real log files. There may be pauses when DNS (and other)
2939 lookups are taking place, and of course these may time out. The &%-oMi%& option
2940 can be used to specify a specific IP interface and port if this is important,
2941 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2942 session were authenticated.
2943
2944 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2945 output just states whether a given recipient address from a given host is
2946 acceptable or not. See section &<<SECTcheckaccess>>&.
2947
2948 Features such as authentication and encryption, where the client input is not
2949 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2950 specialized SMTP test program such as
2951 &url(http://jetmore.org/john/code/#swaks,swaks).
2952
2953 .vitem &%-bhc%&&~<&'IP&~address'&>
2954 .oindex "&%-bhc%&"
2955 This option operates in the same way as &%-bh%&, except that address
2956 verification callouts are performed if required. This includes consulting and
2957 updating the callout cache database.
2958
2959 .vitem &%-bi%&
2960 .oindex "&%-bi%&"
2961 .cindex "alias file" "building"
2962 .cindex "building alias file"
2963 .cindex "Sendmail compatibility" "&%-bi%& option"
2964 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2965 Exim does not have the concept of a single alias file, and so it cannot mimic
2966 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2967 tend to appear in various scripts such as NIS make files, so the option must be
2968 recognized.
2969
2970 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2971 configuration option is run, under the uid and gid of the caller of Exim. If
2972 the &%-oA%& option is used, its value is passed to the command as an argument.
2973 The command set by &%bi_command%& may not contain arguments. The command can
2974 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2975 if this is required. If the &%bi_command%& option is not set, calling Exim with
2976 &%-bi%& is a no-op.
2977
2978 . // Keep :help first, then the rest in alphabetical order
2979 .vitem &%-bI:help%&
2980 .oindex "&%-bI:help%&"
2981 .cindex "querying exim information"
2982 We shall provide various options starting &`-bI:`& for querying Exim for
2983 information.  The output of many of these will be intended for machine
2984 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2985 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2986 options shall cause Exim to exit after producing the requested output.
2987
2988 .vitem &%-bI:dscp%&
2989 .oindex "&%-bI:dscp%&"
2990 .cindex "DSCP" "values"
2991 This option causes Exim to emit an alphabetically sorted list of all
2992 recognised DSCP names.
2993
2994 .vitem &%-bI:sieve%&
2995 .oindex "&%-bI:sieve%&"
2996 .cindex "Sieve filter" "capabilities"
2997 This option causes Exim to emit an alphabetically sorted list of all supported
2998 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2999 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3000 &`SIEVE`& capability response line.  As the precise list may depend upon
3001 compile-time build options, which this option will adapt to, this is the only
3002 way to guarantee a correct response.
3003
3004 .vitem &%-bm%&
3005 .oindex "&%-bm%&"
3006 .cindex "local message reception"
3007 This option runs an Exim receiving process that accepts an incoming,
3008 locally-generated message on the standard input. The recipients are given as the
3009 command arguments (except when &%-t%& is also present &-- see below). Each
3010 argument can be a comma-separated list of RFC 2822 addresses. This is the
3011 default option for selecting the overall action of an Exim call; it is assumed
3012 if no other conflicting option is present.
3013
3014 If any addresses in the message are unqualified (have no domain), they are
3015 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3016 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3017 suppressing this for special cases.
3018
3019 Policy checks on the contents of local messages can be enforced by means of
3020 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3021
3022 .cindex "return code" "for &%-bm%&"
3023 The return code is zero if the message is successfully accepted. Otherwise, the
3024 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3025
3026 The format
3027 .cindex "message" "format"
3028 .cindex "format" "message"
3029 .cindex "&""From""& line"
3030 .cindex "UUCP" "&""From""& line"
3031 .cindex "Sendmail compatibility" "&""From""& line"
3032 of the message must be as defined in RFC 2822, except that, for
3033 compatibility with Sendmail and Smail, a line in one of the forms
3034 .code
3035 From sender Fri Jan  5 12:55 GMT 1997
3036 From sender Fri, 5 Jan 97 12:55:01
3037 .endd
3038 (with the weekday optional, and possibly with additional text after the date)
3039 is permitted to appear at the start of the message. There appears to be no
3040 authoritative specification of the format of this line. Exim recognizes it by
3041 matching against the regular expression defined by the &%uucp_from_pattern%&
3042 option, which can be changed if necessary.
3043
3044 .oindex "&%-f%&" "overriding &""From""& line"
3045 The specified sender is treated as if it were given as the argument to the
3046 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3047 preference to the address taken from the message. The caller of Exim must be a
3048 trusted user for the sender of a message to be set in this way.
3049
3050 .vitem &%-bmalware%&&~<&'filename'&>
3051 .oindex "&%-bmalware%&"
3052 .cindex "testing", "malware"
3053 .cindex "malware scan test"
3054 This debugging option causes Exim to scan the given file or directory
3055 (depending on the used scanner interface),
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 &%config%& is given as an argument, the config is
3114 output, as it was parsed, any include file resolved, any comment removed.
3115
3116 If &%config_file%& is given as an argument, the name of the run time
3117 configuration file is output. (&%configure_file%& works too, for
3118 backward compatibility.)
3119 If a list of configuration files was supplied, the value that is output here
3120 is the name of the file that was actually used.
3121
3122 .cindex "options" "hiding name of"
3123 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3124 name will not be output.
3125
3126 .cindex "daemon" "process id (pid)"
3127 .cindex "pid (process id)" "of daemon"
3128 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3129 directories where log files and daemon pid files are written are output,
3130 respectively. If these values are unset, log files are written in a
3131 sub-directory of the spool directory called &%log%&, and the pid file is
3132 written directly into the spool directory.
3133
3134 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3135 .code
3136 exim -bP +local_domains
3137 .endd
3138 it searches for a matching named list of any type (domain, host, address, or
3139 local part) and outputs what it finds.
3140
3141 .cindex "options" "router &-- extracting"
3142 .cindex "options" "transport &-- extracting"
3143 .cindex "options" "authenticator &-- extracting"
3144 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3145 followed by the name of an appropriate driver instance, the option settings for
3146 that driver are output. For example:
3147 .code
3148 exim -bP transport local_delivery
3149 .endd
3150 The generic driver options are output first, followed by the driver's private
3151 options. A list of the names of drivers of a particular type can be obtained by
3152 using one of the words &%router_list%&, &%transport_list%&, or
3153 &%authenticator_list%&, and a complete list of all drivers with their option
3154 settings can be obtained by using &%routers%&, &%transports%&, or
3155 &%authenticators%&.
3156
3157 .cindex "environment"
3158 If &%environment%& is given as an argument, the set of environment
3159 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3160 variables.
3161
3162 .cindex "options" "macro &-- extracting"
3163 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3164 are available, similarly to the drivers.  Because macros are sometimes used
3165 for storing passwords, this option is restricted.
3166 The output format is one item per line.
3167
3168 .vitem &%-bp%&
3169 .oindex "&%-bp%&"
3170 .cindex "queue" "listing messages on"
3171 .cindex "listing" "messages on the queue"
3172 This option requests a listing of the contents of the mail queue on the
3173 standard output. If the &%-bp%& option is followed by a list of message ids,
3174 just those messages are listed. By default, this option can be used only by an
3175 admin user. However, the &%queue_list_requires_admin%& option can be set false
3176 to allow any user to see the queue.
3177
3178 Each message on the queue is displayed as in the following example:
3179 .code
3180 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3181           red.king@looking-glass.fict.example
3182           <other addresses>
3183 .endd
3184 .cindex "message" "size in queue listing"
3185 .cindex "size" "of message"
3186 The first line contains the length of time the message has been on the queue
3187 (in this case 25 minutes), the size of the message (2.9K), the unique local
3188 identifier for the message, and the message sender, as contained in the
3189 envelope. For bounce messages, the sender address is empty, and appears as
3190 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3191 the default sender address, the user's login name is shown in parentheses
3192 before the sender address.
3193
3194 .cindex "frozen messages" "in queue listing"
3195 If the message is frozen (attempts to deliver it are suspended) then the text
3196 &"*** frozen ***"& is displayed at the end of this line.
3197
3198 The recipients of the message (taken from the envelope, not the headers) are
3199 displayed on subsequent lines. Those addresses to which the message has already
3200 been delivered are marked with the letter D. If an original address gets
3201 expanded into several addresses via an alias or forward file, the original is
3202 displayed with a D only when deliveries for all of its child addresses are
3203 complete.
3204
3205
3206 .vitem &%-bpa%&
3207 .oindex "&%-bpa%&"
3208 This option operates like &%-bp%&, but in addition it shows delivered addresses
3209 that were generated from the original top level address(es) in each message by
3210 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3211 of just &"D"&.
3212
3213
3214 .vitem &%-bpc%&
3215 .oindex "&%-bpc%&"
3216 .cindex "queue" "count of messages on"
3217 This option counts the number of messages on the queue, and writes the total
3218 to the standard output. It is restricted to admin users, unless
3219 &%queue_list_requires_admin%& is set false.
3220
3221
3222 .vitem &%-bpr%&
3223 .oindex "&%-bpr%&"
3224 This option operates like &%-bp%&, but the output is not sorted into
3225 chronological order of message arrival. This can speed it up when there are
3226 lots of messages on the queue, and is particularly useful if the output is
3227 going to be post-processed in a way that doesn't need the sorting.
3228
3229 .vitem &%-bpra%&
3230 .oindex "&%-bpra%&"
3231 This option is a combination of &%-bpr%& and &%-bpa%&.
3232
3233 .vitem &%-bpru%&
3234 .oindex "&%-bpru%&"
3235 This option is a combination of &%-bpr%& and &%-bpu%&.
3236
3237
3238 .vitem &%-bpu%&
3239 .oindex "&%-bpu%&"
3240 This option operates like &%-bp%& but shows only undelivered top-level
3241 addresses for each message displayed. Addresses generated by aliasing or
3242 forwarding are not shown, unless the message was deferred after processing by a
3243 router with the &%one_time%& option set.
3244
3245
3246 .vitem &%-brt%&
3247 .oindex "&%-brt%&"
3248 .cindex "testing" "retry configuration"
3249 .cindex "retry" "configuration testing"
3250 This option is for testing retry rules, and it must be followed by up to three
3251 arguments. It causes Exim to look for a retry rule that matches the values
3252 and to write it to the standard output. For example:
3253 .code
3254 exim -brt bach.comp.mus.example
3255 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3256 .endd
3257 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3258 argument, which is required, can be a complete address in the form
3259 &'local_part@domain'&, or it can be just a domain name. If the second argument
3260 contains a dot, it is interpreted as an optional second domain name; if no
3261 retry rule is found for the first argument, the second is tried. This ties in
3262 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3263 rule is found that matches the host, one that matches the mail domain is
3264 sought. Finally, an argument that is the name of a specific delivery error, as
3265 used in setting up retry rules, can be given. For example:
3266 .code
3267 exim -brt haydn.comp.mus.example quota_3d
3268 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3269 .endd
3270
3271 .vitem &%-brw%&
3272 .oindex "&%-brw%&"
3273 .cindex "testing" "rewriting"
3274 .cindex "rewriting" "testing"
3275 This option is for testing address rewriting rules, and it must be followed by
3276 a single argument, consisting of either a local part without a domain, or a
3277 complete address with a fully qualified domain. Exim outputs how this address
3278 would be rewritten for each possible place it might appear. See chapter
3279 &<<CHAPrewrite>>& for further details.
3280
3281 .vitem &%-bS%&
3282 .oindex "&%-bS%&"
3283 .cindex "SMTP" "batched incoming"
3284 .cindex "batched SMTP input"
3285 This option is used for batched SMTP input, which is an alternative interface
3286 for non-interactive local message submission. A number of messages can be
3287 submitted in a single run. However, despite its name, this is not really SMTP
3288 input. Exim reads each message's envelope from SMTP commands on the standard
3289 input, but generates no responses. If the caller is trusted, or
3290 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3291 believed; otherwise the sender is always the caller of Exim.
3292
3293 The message itself is read from the standard input, in SMTP format (leading
3294 dots doubled), terminated by a line containing just a single dot. An error is
3295 provoked if the terminating dot is missing. A further message may then follow.
3296
3297 As for other local message submissions, the contents of incoming batch SMTP
3298 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3299 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3300 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3301
3302 Some other SMTP commands are recognized in the input. HELO and EHLO act
3303 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3304 QUIT quits, ignoring the rest of the standard input.
3305
3306 .cindex "return code" "for &%-bS%&"
3307 If any error is encountered, reports are written to the standard output and
3308 error streams, and Exim gives up immediately. The return code is 0 if no error
3309 was detected; it is 1 if one or more messages were accepted before the error
3310 was detected; otherwise it is 2.
3311
3312 More details of input using batched SMTP are given in section
3313 &<<SECTincomingbatchedSMTP>>&.
3314
3315 .vitem &%-bs%&
3316 .oindex "&%-bs%&"
3317 .cindex "SMTP" "local input"
3318 .cindex "local SMTP input"
3319 This option causes Exim to accept one or more messages by reading SMTP commands
3320 on the standard input, and producing SMTP replies on the standard output. SMTP
3321 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3322 Some user agents use this interface as a way of passing locally-generated
3323 messages to the MTA.
3324
3325 In
3326 .cindex "sender" "source of"
3327 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3328 set, the senders of messages are taken from the SMTP MAIL commands.
3329 Otherwise the content of these commands is ignored and the sender is set up as
3330 the calling user. Unqualified addresses are automatically qualified using
3331 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3332 &%-bnq%& option is used.
3333
3334 .cindex "inetd"
3335 The
3336 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3337 using a listening daemon. Exim can distinguish the two cases by checking
3338 whether the standard input is a TCP/IP socket. When Exim is called from
3339 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3340 above concerning senders and qualification do not apply. In this situation,
3341 Exim behaves in exactly the same way as it does when receiving a message via
3342 the listening daemon.
3343
3344 .vitem &%-bt%&
3345 .oindex "&%-bt%&"
3346 .cindex "testing" "addresses"
3347 .cindex "address" "testing"
3348 This option runs Exim in address testing mode, in which each argument is taken
3349 as a recipient address to be tested for deliverability. The results are
3350 written to the standard output. If a test fails, and the caller is not an admin
3351 user, no details of the failure are output, because these might contain
3352 sensitive information such as usernames and passwords for database lookups.
3353
3354 If no arguments are given, Exim runs in an interactive manner, prompting with a
3355 right angle bracket for addresses to be tested.
3356
3357 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3358 &[readline()]& function, because it is running as &'root'& and there are
3359 security issues.
3360
3361 Each address is handled as if it were the recipient address of a message
3362 (compare the &%-bv%& option). It is passed to the routers and the result is
3363 written to the standard output. However, any router that has
3364 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3365 genuine routing tests if your first router passes everything to a scanner
3366 program.
3367
3368 .cindex "return code" "for &%-bt%&"
3369 The return code is 2 if any address failed outright; it is 1 if no address
3370 failed outright but at least one could not be resolved for some reason. Return
3371 code 0 is given only when all addresses succeed.
3372
3373 .cindex "duplicate addresses"
3374 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3375 addresses after routing is complete, so that only one delivery takes place.
3376 This does not happen when testing with &%-bt%&; the full results of routing are
3377 always shown.
3378
3379 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3380 routers in the configuration makes any tests on the sender address of a
3381 message,
3382 .oindex "&%-f%&" "for address testing"
3383 you can use the &%-f%& option to set an appropriate sender when running
3384 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3385 default qualifying domain. However, if you have set up (for example) routers
3386 whose behaviour depends on the contents of an incoming message, you cannot test
3387 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3388 doing such tests.
3389
3390 .vitem &%-bV%&
3391 .oindex "&%-bV%&"
3392 .cindex "version number of Exim"
3393 This option causes Exim to write the current version number, compilation
3394 number, and compilation date of the &'exim'& binary to the standard output.
3395 It also lists the DBM library that is being used, the optional modules (such as
3396 specific lookup types), the drivers that are included in the binary, and the
3397 name of the run time configuration file that is in use.
3398
3399 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3400 configuration file. However, this is a static check only. It cannot check
3401 values that are to be expanded. For example, although a misspelt ACL verb is
3402 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3403 alone to discover (for example) all the typos in the configuration; some
3404 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3405 dynamic testing facilities.
3406
3407 .vitem &%-bv%&
3408 .oindex "&%-bv%&"
3409 .cindex "verifying address" "using &%-bv%&"
3410 .cindex "address" "verification"
3411 This option runs Exim in address verification mode, in which each argument is
3412 taken as a recipient address to be verified by the routers. (This does
3413 not involve any verification callouts). During normal operation, verification
3414 happens mostly as a consequence processing a &%verify%& condition in an ACL
3415 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3416 including callouts, see the &%-bh%& and &%-bhc%& options.
3417
3418 If verification fails, and the caller is not an admin user, no details of the
3419 failure are output, because these might contain sensitive information such as
3420 usernames and passwords for database lookups.
3421
3422 If no arguments are given, Exim runs in an interactive manner, prompting with a
3423 right angle bracket for addresses to be verified.
3424
3425 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3426 &[readline()]& function, because it is running as &'exim'& and there are
3427 security issues.
3428
3429 Verification differs from address testing (the &%-bt%& option) in that routers
3430 that have &%no_verify%& set are skipped, and if the address is accepted by a
3431 router that has &%fail_verify%& set, verification fails. The address is
3432 verified as a recipient if &%-bv%& is used; to test verification for a sender
3433 address, &%-bvs%& should be used.
3434
3435 If the &%-v%& option is not set, the output consists of a single line for each
3436 address, stating whether it was verified or not, and giving a reason in the
3437 latter case. Without &%-v%&, generating more than one address by redirection
3438 causes verification to end successfully, without considering the generated
3439 addresses. However, if just one address is generated, processing continues,
3440 and the generated address must verify successfully for the overall verification
3441 to succeed.
3442
3443 When &%-v%& is set, more details are given of how the address has been handled,
3444 and in the case of address redirection, all the generated addresses are also
3445 considered. Verification may succeed for some and fail for others.
3446
3447 The
3448 .cindex "return code" "for &%-bv%&"
3449 return code is 2 if any address failed outright; it is 1 if no address
3450 failed outright but at least one could not be resolved for some reason. Return
3451 code 0 is given only when all addresses succeed.
3452
3453 If any of the routers in the configuration makes any tests on the sender
3454 address of a message, you should use the &%-f%& option to set an appropriate
3455 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3456 calling user at the default qualifying domain.
3457
3458 .vitem &%-bvs%&
3459 .oindex "&%-bvs%&"
3460 This option acts like &%-bv%&, but verifies the address as a sender rather
3461 than a recipient address. This affects any rewriting and qualification that
3462 might happen.
3463
3464 .vitem &%-bw%&
3465 .oindex "&%-bw%&"
3466 .cindex "daemon"
3467 .cindex "inetd"
3468 .cindex "inetd" "wait mode"
3469 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3470 similarly to the &%-bd%& option.  All port specifications on the command-line
3471 and in the configuration file are ignored.  Queue-running may not be specified.
3472
3473 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3474 listening for connections.  This permits the system to start up and have
3475 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3476 each port only when the first connection is received.
3477
3478 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3479 which the daemon will exit, which should cause inetd to listen once more.
3480
3481 .vitem &%-C%&&~<&'filelist'&>
3482 .oindex "&%-C%&"
3483 .cindex "configuration file" "alternate"
3484 .cindex "CONFIGURE_FILE"
3485 .cindex "alternate configuration file"
3486 This option causes Exim to find the run time configuration file from the given
3487 list instead of from the list specified by the CONFIGURE_FILE
3488 compile-time setting. Usually, the list will consist of just a single file
3489 name, but it can be a colon-separated list of names. In this case, the first
3490 file that exists is used. Failure to open an existing file stops Exim from
3491 proceeding any further along the list, and an error is generated.
3492
3493 When this option is used by a caller other than root, and the list is different
3494 from the compiled-in list, Exim gives up its root privilege immediately, and
3495 runs with the real and effective uid and gid set to those of the caller.
3496 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3497 file contains a list of full pathnames, one per line, for configuration files
3498 which are trusted. Root privilege is retained for any configuration file so
3499 listed, as long as the caller is the Exim user (or the user specified in the
3500 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3501 not writeable by inappropriate users or groups.
3502
3503 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3504 configuration using &%-C%& right through message reception and delivery,
3505 even if the caller is root. The reception works, but by that time, Exim is
3506 running as the Exim user, so when it re-executes to regain privilege for the
3507 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3508 test reception and delivery using two separate commands (one to put a message
3509 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3510
3511 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3512 prefix string with which any file named in a &%-C%& command line option
3513 must start. In addition, the file name must not contain the sequence &`/../`&.
3514 However, if the value of the &%-C%& option is identical to the value of
3515 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3516 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3517 unset, any file name can be used with &%-C%&.
3518
3519 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3520 to a directory to which only root has access. This prevents someone who has
3521 broken into the Exim account from running a privileged Exim with an arbitrary
3522 configuration file.
3523
3524 The &%-C%& facility is useful for ensuring that configuration files are
3525 syntactically correct, but cannot be used for test deliveries, unless the
3526 caller is privileged, or unless it is an exotic configuration that does not
3527 require privilege. No check is made on the owner or group of the files
3528 specified by this option.
3529
3530
3531 .vitem &%-D%&<&'macro'&>=<&'value'&>
3532 .oindex "&%-D%&"
3533 .cindex "macro" "setting on command line"
3534 This option can be used to override macro definitions in the configuration file
3535 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3536 unprivileged caller, it causes Exim to give up its root privilege.
3537 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3538 completely disabled, and its use causes an immediate error exit.
3539
3540 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3541 colon-separated list of macros which are considered safe and, if &%-D%& only
3542 supplies macros from this list, and the values are acceptable, then Exim will
3543 not give up root privilege if the caller is root, the Exim run-time user, or
3544 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3545 to be removed in the future.  Acceptable values for the macros satisfy the
3546 regexp: &`^[A-Za-z0-9_/.-]*$`&
3547
3548 The entire option (including equals sign if present) must all be within one
3549 command line item. &%-D%& can be used to set the value of a macro to the empty
3550 string, in which case the equals sign is optional. These two commands are
3551 synonymous:
3552 .code
3553 exim -DABC  ...
3554 exim -DABC= ...
3555 .endd
3556 To include spaces in a macro definition item, quotes must be used. If you use
3557 quotes, spaces are permitted around the macro name and the equals sign. For
3558 example:
3559 .code
3560 exim '-D ABC = something' ...
3561 .endd
3562 &%-D%& may be repeated up to 10 times on a command line.
3563 Only macro names up to 22 letters long can be set.
3564
3565
3566 .vitem &%-d%&<&'debug&~options'&>
3567 .oindex "&%-d%&"
3568 .cindex "debugging" "list of selectors"
3569 .cindex "debugging" "&%-d%& option"
3570 This option causes debugging information to be written to the standard
3571 error stream. It is restricted to admin users because debugging output may show
3572 database queries that contain password information. Also, the details of users'
3573 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3574 writes an error message to the standard error stream and exits with a non-zero
3575 return code.
3576
3577 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3578 standard debugging data is output. This can be reduced, or increased to include
3579 some more rarely needed information, by directly following &%-d%& with a string
3580 made up of names preceded by plus or minus characters. These add or remove sets
3581 of debugging data, respectively. For example, &%-d+filter%& adds filter
3582 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3583 no spaces are allowed in the debug setting. The available debugging categories
3584 are:
3585 .display
3586 &`acl            `& ACL interpretation
3587 &`auth           `& authenticators
3588 &`deliver        `& general delivery logic
3589 &`dns            `& DNS lookups (see also resolver)
3590 &`dnsbl          `& DNS black list (aka RBL) code
3591 &`exec           `& arguments for &[execv()]& calls
3592 &`expand         `& detailed debugging for string expansions
3593 &`filter         `& filter handling
3594 &`hints_lookup   `& hints data lookups
3595 &`host_lookup    `& all types of name-to-IP address handling
3596 &`ident          `& ident lookup
3597 &`interface      `& lists of local interfaces
3598 &`lists          `& matching things in lists
3599 &`load           `& system load checks
3600 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3601                     &<<CHAPlocalscan>>&)
3602 &`lookup         `& general lookup code and all lookups
3603 &`memory         `& memory handling
3604 &`pid            `& add pid to debug output lines
3605 &`process_info   `& setting info for the process log
3606 &`queue_run      `& queue runs
3607 &`receive        `& general message reception logic
3608 &`resolver       `& turn on the DNS resolver's debugging output
3609 &`retry          `& retry handling
3610 &`rewrite        `& address rewriting
3611 &`route          `& address routing
3612 &`timestamp      `& add timestamp to debug output lines
3613 &`tls            `& TLS logic
3614 &`transport      `& transports
3615 &`uid            `& changes of uid/gid and looking up uid/gid
3616 &`verify         `& address verification logic
3617 &`all            `& almost all of the above (see below), and also &%-v%&
3618 .endd
3619 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3620 for &`-all`&. The reason for this is that &`+all`& is something that people
3621 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3622 is included, an awful lot of output that is very rarely of interest is
3623 generated, so it now has to be explicitly requested. However, &`-all`& does
3624 turn everything off.
3625
3626 .cindex "resolver, debugging output"
3627 .cindex "DNS resolver, debugging output"
3628 The &`resolver`& option produces output only if the DNS resolver was compiled
3629 with DEBUG enabled. This is not the case in some operating systems. Also,
3630 unfortunately, debugging output from the DNS resolver is written to stdout
3631 rather than stderr.
3632
3633 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3634 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3635 However, the &`pid`& selector is forced when debugging is turned on for a
3636 daemon, which then passes it on to any re-executed Exims. Exim also
3637 automatically adds the pid to debug lines when several remote deliveries are
3638 run in parallel.
3639
3640 The &`timestamp`& selector causes the current time to be inserted at the start
3641 of all debug output lines. This can be useful when trying to track down delays
3642 in processing.
3643
3644 If the &%debug_print%& option is set in any driver, it produces output whenever
3645 any debugging is selected, or if &%-v%& is used.
3646
3647 .vitem &%-dd%&<&'debug&~options'&>
3648 .oindex "&%-dd%&"
3649 This option behaves exactly like &%-d%& except when used on a command that
3650 starts a daemon process. In that case, debugging is turned off for the
3651 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3652 behaviour of the daemon without creating as much output as full debugging does.
3653
3654 .vitem &%-dropcr%&
3655 .oindex "&%-dropcr%&"
3656 This is an obsolete option that is now a no-op. It used to affect the way Exim
3657 handled CR and LF characters in incoming messages. What happens now is
3658 described in section &<<SECTlineendings>>&.
3659
3660 .vitem &%-E%&
3661 .oindex "&%-E%&"
3662 .cindex "bounce message" "generating"
3663 This option specifies that an incoming message is a locally-generated delivery
3664 failure report. It is used internally by Exim when handling delivery failures
3665 and is not intended for external use. Its only effect is to stop Exim
3666 generating certain messages to the postmaster, as otherwise message cascades
3667 could occur in some situations. As part of the same option, a message id may
3668 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3669 new message contains the id, following &"R="&, as a cross-reference.
3670
3671 .vitem &%-e%&&'x'&
3672 .oindex "&%-e%&&'x'&"
3673 There are a number of Sendmail options starting with &%-oe%& which seem to be
3674 called by various programs without the leading &%o%& in the option. For
3675 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3676 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3677
3678 .vitem &%-F%&&~<&'string'&>
3679 .oindex "&%-F%&"
3680 .cindex "sender" "name"
3681 .cindex "name" "of sender"
3682 This option sets the sender's full name for use when a locally-generated
3683 message is being accepted. In the absence of this option, the user's &'gecos'&
3684 entry from the password data is used. As users are generally permitted to alter
3685 their &'gecos'& entries, no security considerations are involved. White space
3686 between &%-F%& and the <&'string'&> is optional.
3687
3688 .vitem &%-f%&&~<&'address'&>
3689 .oindex "&%-f%&"
3690 .cindex "sender" "address"
3691 .cindex "address" "sender"
3692 .cindex "trusted users"
3693 .cindex "envelope sender"
3694 .cindex "user" "trusted"
3695 This option sets the address of the envelope sender of a locally-generated
3696 message (also known as the return path). The option can normally be used only
3697 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3698 users to use it.
3699
3700 Processes running as root or the Exim user are always trusted. Other
3701 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3702 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3703 of a local message is set to the caller's login name at the default qualify
3704 domain.
3705
3706 There is one exception to the restriction on the use of &%-f%&: an empty sender
3707 can be specified by any user, trusted or not, to create a message that can
3708 never provoke a bounce. An empty sender can be specified either as an empty
3709 string, or as a pair of angle brackets with nothing between them, as in these
3710 examples of shell commands:
3711 .code
3712 exim -f '<>' user@domain
3713 exim -f "" user@domain
3714 .endd
3715 In addition, the use of &%-f%& is not restricted when testing a filter file
3716 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3717 &%-bv%& options.
3718
3719 Allowing untrusted users to change the sender address does not of itself make
3720 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3721 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3722 though this can be overridden by setting &%no_local_from_check%&.
3723
3724 White
3725 .cindex "&""From""& line"
3726 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3727 given as two arguments or one combined argument). The sender of a
3728 locally-generated message can also be set (when permitted) by an initial
3729 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3730 if &%-f%& is also present, it overrides &"From&~"&.
3731
3732 .vitem &%-G%&
3733 .oindex "&%-G%&"
3734 .cindex "submission fixups, suppressing (command-line)"
3735 This option is equivalent to an ACL applying:
3736 .code
3737 control = suppress_local_fixups
3738 .endd
3739 for every message received.  Note that Sendmail will complain about such
3740 bad formatting, where Exim silently just does not fix it up.  This may change
3741 in future.
3742
3743 As this affects audit information, the caller must be a trusted user to use
3744 this option.
3745
3746 .vitem &%-h%&&~<&'number'&>
3747 .oindex "&%-h%&"
3748 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3749 This option is accepted for compatibility with Sendmail, but has no effect. (In
3750 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3751 headers.)
3752
3753 .vitem &%-i%&
3754 .oindex "&%-i%&"
3755 .cindex "Solaris" "&'mail'& command"
3756 .cindex "dot" "in incoming non-SMTP message"
3757 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3758 line by itself should not terminate an incoming, non-SMTP message. I can find
3759 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3760 command in Solaris 2.4 uses it. See also &%-ti%&.
3761
3762 .vitem &%-L%&&~<&'tag'&>
3763 .oindex "&%-L%&"
3764 .cindex "syslog" "process name; set with flag"
3765 This option is equivalent to setting &%syslog_processname%& in the config
3766 file and setting &%log_file_path%& to &`syslog`&.
3767 Its use is restricted to administrators.  The configuration file has to be
3768 read and parsed, to determine access rights, before this is set and takes
3769 effect, so early configuration file errors will not honour this flag.
3770
3771 The tag should not be longer than 32 characters.
3772
3773 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3774 .oindex "&%-M%&"
3775 .cindex "forcing delivery"
3776 .cindex "delivery" "forcing attempt"
3777 .cindex "frozen messages" "forcing delivery"
3778 This option requests Exim to run a delivery attempt on each message in turn. If
3779 any of the messages are frozen, they are automatically thawed before the
3780 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3781 and &%hold_domains%& are ignored.
3782
3783 Retry
3784 .cindex "hints database" "overriding retry hints"
3785 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3786 the normal retry time has not yet been reached. This option requires the caller
3787 to be an admin user. However, there is an option called &%prod_requires_admin%&
3788 which can be set false to relax this restriction (and also the same requirement
3789 for the &%-q%&, &%-R%&, and &%-S%& options).
3790
3791 The deliveries happen synchronously, that is, the original Exim process does
3792 not terminate until all the delivery attempts have finished. No output is
3793 produced unless there is a serious error. If you want to see what is happening,
3794 use the &%-v%& option as well, or inspect Exim's main log.
3795
3796 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3797 .oindex "&%-Mar%&"
3798 .cindex "message" "adding recipients"
3799 .cindex "recipient" "adding"
3800 This option requests Exim to add the addresses to the list of recipients of the
3801 message (&"ar"& for &"add recipients"&). The first argument must be a message
3802 id, and the remaining ones must be email addresses. However, if the message is
3803 active (in the middle of a delivery attempt), it is not altered. This option
3804 can be used only by an admin user.
3805
3806 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3807         &~<&'message&~id'&>"
3808 .oindex "&%-MC%&"
3809 .cindex "SMTP" "passed connection"
3810 .cindex "SMTP" "multiple deliveries"
3811 .cindex "multiple SMTP deliveries"
3812 This option is not intended for use by external callers. It is used internally
3813 by Exim to invoke another instance of itself to deliver a waiting message using
3814 an existing SMTP connection, which is passed as the standard input. Details are
3815 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3816 must be root or the Exim user in order to use it.
3817
3818 .vitem &%-MCA%&
3819 .oindex "&%-MCA%&"
3820 This option is not intended for use by external callers. It is used internally
3821 by Exim in conjunction with the &%-MC%& option. It signifies that the
3822 connection to the remote host has been authenticated.
3823
3824 .vitem &%-MCD%&
3825 .oindex "&%-MCD%&"
3826 This option is not intended for use by external callers. It is used internally
3827 by Exim in conjunction with the &%-MC%& option. It signifies that the
3828 remote host supports the ESMTP &_DSN_& extension.
3829
3830 .new
3831 .vitem &%-MCG%&
3832 .oindex "&%-MCG%&"
3833 This option is not intended for use by external callers. It is used internally
3834 by Exim in conjunction with the &%-MC%& option. It signifies that an
3835 alternate queue is used, named by the following option.
3836 .wen
3837
3838 .vitem &%-MCP%&
3839 .oindex "&%-MCP%&"
3840 This option is not intended for use by external callers. It is used internally
3841 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3842 which Exim is connected supports pipelining.
3843
3844 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3845 .oindex "&%-MCQ%&"
3846 This option is not intended for use by external callers. It is used internally
3847 by Exim in conjunction with the &%-MC%& option when the original delivery was
3848 started by a queue runner. It passes on the process id of the queue runner,
3849 together with the file descriptor number of an open pipe. Closure of the pipe
3850 signals the final completion of the sequence of processes that are passing
3851 messages through the same SMTP connection.
3852
3853 .vitem &%-MCS%&
3854 .oindex "&%-MCS%&"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3857 SMTP SIZE option should be used on messages delivered down the existing
3858 connection.
3859
3860 .vitem &%-MCT%&
3861 .oindex "&%-MCT%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3864 host to which Exim is connected supports TLS encryption.
3865
3866 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3867 .oindex "&%-Mc%&"
3868 .cindex "hints database" "not overridden by &%-Mc%&"
3869 .cindex "delivery" "manually started &-- not forced"
3870 This option requests Exim to run a delivery attempt on each message in turn,
3871 but unlike the &%-M%& option, it does check for retry hints, and respects any
3872 that are found. This option is not very useful to external callers. It is
3873 provided mainly for internal use by Exim when it needs to re-invoke itself in
3874 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3875 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3876 respects retry times and other options such as &%hold_domains%& that are
3877 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3878 If you want to run a specific delivery as if in a queue run, you should use
3879 &%-q%& with a message id argument. A distinction between queue run deliveries
3880 and other deliveries is made in one or two places.
3881
3882 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3883 .oindex "&%-Mes%&"
3884 .cindex "message" "changing sender"
3885 .cindex "sender" "changing"
3886 This option requests Exim to change the sender address in the message to the
3887 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3888 &"edit sender"&). There must be exactly two arguments. The first argument must
3889 be a message id, and the second one an email address. However, if the message
3890 is active (in the middle of a delivery attempt), its status is not altered.
3891 This option can be used only by an admin user.
3892
3893 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3894 .oindex "&%-Mf%&"
3895 .cindex "freezing messages"
3896 .cindex "message" "manually freezing"
3897 This option requests Exim to mark each listed message as &"frozen"&. This
3898 prevents any delivery attempts taking place until the message is &"thawed"&,
3899 either manually or as a result of the &%auto_thaw%& configuration option.
3900 However, if any of the messages are active (in the middle of a delivery
3901 attempt), their status is not altered. This option can be used only by an admin
3902 user.
3903
3904 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3905 .oindex "&%-Mg%&"
3906 .cindex "giving up on messages"
3907 .cindex "message" "abandoning delivery attempts"
3908 .cindex "delivery" "abandoning further attempts"
3909 This option requests Exim to give up trying to deliver the listed messages,
3910 including any that are frozen. However, if any of the messages are active,
3911 their status is not altered. For non-bounce messages, a delivery error message
3912 is sent to the sender, containing the text &"cancelled by administrator"&.
3913 Bounce messages are just discarded. This option can be used only by an admin
3914 user.
3915
3916 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mmad%&"
3918 .cindex "delivery" "cancelling all"
3919 This option requests Exim to mark all the recipient addresses in the messages
3920 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3921 message is active (in the middle of a delivery attempt), its status is not
3922 altered. This option can be used only by an admin user.
3923
3924 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3925 .oindex "&%-Mmd%&"
3926 .cindex "delivery" "cancelling by address"
3927 .cindex "recipient" "removing"
3928 .cindex "removing recipients"
3929 This option requests Exim to mark the given addresses as already delivered
3930 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3931 the remaining ones must be email addresses. These are matched to recipient
3932 addresses in the message in a case-sensitive manner. If the message is active
3933 (in the middle of a delivery attempt), its status is not altered. This option
3934 can be used only by an admin user.
3935
3936 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3937 .oindex "&%-Mrm%&"
3938 .cindex "removing messages"
3939 .cindex "abandoning mail"
3940 .cindex "message" "manually discarding"
3941 This option requests Exim to remove the given messages from the queue. No
3942 bounce messages are sent; each message is simply forgotten. However, if any of
3943 the messages are active, their status is not altered. This option can be used
3944 only by an admin user or by the user who originally caused the message to be
3945 placed on the queue.
3946
3947 .vitem &%-Mset%&&~<&'message&~id'&>
3948 .oindex "&%-Mset%&
3949 .cindex "testing" "string expansion"
3950 .cindex "expansion" "testing"
3951 This option is useful only in conjunction with &%-be%& (that is, when testing
3952 string expansions). Exim loads the given message from its spool before doing
3953 the test expansions, thus setting message-specific variables such as
3954 &$message_size$& and the header variables. The &$recipients$& variable is made
3955 available. This feature is provided to make it easier to test expansions that
3956 make use of these variables. However, this option can be used only by an admin
3957 user. See also &%-bem%&.
3958
3959 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mt%&"
3961 .cindex "thawing messages"
3962 .cindex "unfreezing messages"
3963 .cindex "frozen messages" "thawing"
3964 .cindex "message" "thawing frozen"
3965 This option requests Exim to &"thaw"& any of the listed messages that are
3966 &"frozen"&, so that delivery attempts can resume. However, if any of the
3967 messages are active, their status is not altered. This option can be used only
3968 by an admin user.
3969
3970 .vitem &%-Mvb%&&~<&'message&~id'&>
3971 .oindex "&%-Mvb%&"
3972 .cindex "listing" "message body"
3973 .cindex "message" "listing body of"
3974 This option causes the contents of the message body (-D) spool file to be
3975 written to the standard output. This option can be used only by an admin user.
3976
3977 .vitem &%-Mvc%&&~<&'message&~id'&>
3978 .oindex "&%-Mvc%&"
3979 .cindex "message" "listing in RFC 2822 format"
3980 .cindex "listing" "message in RFC 2822 format"
3981 This option causes a copy of the complete message (header lines plus body) to
3982 be written to the standard output in RFC 2822 format. This option can be used
3983 only by an admin user.
3984
3985 .vitem &%-Mvh%&&~<&'message&~id'&>
3986 .oindex "&%-Mvh%&"
3987 .cindex "listing" "message headers"
3988 .cindex "header lines" "listing"
3989 .cindex "message" "listing header lines"
3990 This option causes the contents of the message headers (-H) spool file to be
3991 written to the standard output. This option can be used only by an admin user.
3992
3993 .vitem &%-Mvl%&&~<&'message&~id'&>
3994 .oindex "&%-Mvl%&"
3995 .cindex "listing" "message log"
3996 .cindex "message" "listing message log"
3997 This option causes the contents of the message log spool file to be written to
3998 the standard output. This option can be used only by an admin user.
3999
4000 .vitem &%-m%&
4001 .oindex "&%-m%&"
4002 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4003 treats it that way too.
4004
4005 .vitem &%-N%&
4006 .oindex "&%-N%&"
4007 .cindex "debugging" "&%-N%& option"
4008 .cindex "debugging" "suppressing delivery"
4009 This is a debugging option that inhibits delivery of a message at the transport
4010 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4011 it just doesn't actually transport the message, but instead behaves as if it
4012 had successfully done so. However, it does not make any updates to the retry
4013 database, and the log entries for deliveries are flagged with &"*>"& rather
4014 than &"=>"&.
4015
4016 Because &%-N%& discards any message to which it applies, only root or the Exim
4017 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4018 words, an ordinary user can use it only when supplying an incoming message to
4019 which it will apply. Although transportation never fails when &%-N%& is set, an
4020 address may be deferred because of a configuration problem on a transport, or a
4021 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4022 the message, and applies to any subsequent delivery attempts that may happen
4023 for that message.
4024
4025 .vitem &%-n%&
4026 .oindex "&%-n%&"
4027 This option is interpreted by Sendmail to mean &"no aliasing"&.
4028 For normal modes of operation, it is ignored by Exim.
4029 When combined with &%-bP%& it makes the output more terse (suppresses
4030 option names, environment values and config pretty printing).
4031
4032 .vitem &%-O%&&~<&'data'&>
4033 .oindex "&%-O%&"
4034 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4035 Exim.
4036
4037 .vitem &%-oA%&&~<&'file&~name'&>
4038 .oindex "&%-oA%&"
4039 .cindex "Sendmail compatibility" "&%-oA%& option"
4040 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4041 alternative alias file name. Exim handles &%-bi%& differently; see the
4042 description above.
4043
4044 .vitem &%-oB%&&~<&'n'&>
4045 .oindex "&%-oB%&"
4046 .cindex "SMTP" "passed connection"
4047 .cindex "SMTP" "multiple deliveries"
4048 .cindex "multiple SMTP deliveries"
4049 This is a debugging option which limits the maximum number of messages that can
4050 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4051 transport. If <&'n'&> is omitted, the limit is set to 1.
4052
4053 .vitem &%-odb%&
4054 .oindex "&%-odb%&"
4055 .cindex "background delivery"
4056 .cindex "delivery" "in the background"
4057 This option applies to all modes in which Exim accepts incoming messages,
4058 including the listening daemon. It requests &"background"& delivery of such
4059 messages, which means that the accepting process automatically starts a
4060 delivery process for each message received, but does not wait for the delivery
4061 processes to finish.
4062
4063 When all the messages have been received, the reception process exits,
4064 leaving the delivery processes to finish in their own time. The standard output
4065 and error streams are closed at the start of each delivery process.
4066 This is the default action if none of the &%-od%& options are present.
4067
4068 If one of the queueing options in the configuration file
4069 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4070 overrides it if &%queue_only_override%& is set true, which is the default
4071 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4072
4073 .vitem &%-odf%&
4074 .oindex "&%-odf%&"
4075 .cindex "foreground delivery"
4076 .cindex "delivery" "in the foreground"
4077 This option requests &"foreground"& (synchronous) delivery when Exim has
4078 accepted a locally-generated message. (For the daemon it is exactly the same as
4079 &%-odb%&.) A delivery process is automatically started to deliver the message,
4080 and Exim waits for it to complete before proceeding.
4081
4082 The original Exim reception process does not finish until the delivery
4083 process for the final message has ended. The standard error stream is left open
4084 during deliveries.
4085
4086 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4087 false and one of the queueing options in the configuration file is in effect.
4088
4089 If there is a temporary delivery error during foreground delivery, the
4090 message is left on the queue for later delivery, and the original reception
4091 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4092 restricted configuration that never queues messages.
4093
4094
4095 .vitem &%-odi%&
4096 .oindex "&%-odi%&"
4097 This option is synonymous with &%-odf%&. It is provided for compatibility with
4098 Sendmail.
4099
4100 .vitem &%-odq%&
4101 .oindex "&%-odq%&"
4102 .cindex "non-immediate delivery"
4103 .cindex "delivery" "suppressing immediate"
4104 .cindex "queueing incoming messages"
4105 This option applies to all modes in which Exim accepts incoming messages,
4106 including the listening daemon. It specifies that the accepting process should
4107 not automatically start a delivery process for each message received. Messages
4108 are placed on the queue, and remain there until a subsequent queue runner
4109 process encounters them. There are several configuration options (such as
4110 &%queue_only%&) that can be used to queue incoming messages under certain
4111 conditions. This option overrides all of them and also &%-odqs%&. It always
4112 forces queueing.
4113
4114 .vitem &%-odqs%&
4115 .oindex "&%-odqs%&"
4116 .cindex "SMTP" "delaying delivery"
4117 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4118 However, like &%-odb%& and &%-odi%&, this option has no effect if
4119 &%queue_only_override%& is false and one of the queueing options in the
4120 configuration file is in effect.
4121
4122 When &%-odqs%& does operate, a delivery process is started for each incoming
4123 message, in the background by default, but in the foreground if &%-odi%& is
4124 also present. The recipient addresses are routed, and local deliveries are done
4125 in the normal way. However, if any SMTP deliveries are required, they are not
4126 done at this time, so the message remains on the queue until a subsequent queue
4127 runner process encounters it. Because routing was done, Exim knows which
4128 messages are waiting for which hosts, and so a number of messages for the same
4129 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4130 configuration option has the same effect for specific domains. See also the
4131 &%-qq%& option.
4132
4133 .vitem &%-oee%&
4134 .oindex "&%-oee%&"
4135 .cindex "error" "reporting"
4136 If an error is detected while a non-SMTP message is being received (for
4137 example, a malformed address), the error is reported to the sender in a mail
4138 message.
4139
4140 .cindex "return code" "for &%-oee%&"
4141 Provided
4142 this error message is successfully sent, the Exim receiving process
4143 exits with a return code of zero. If not, the return code is 2 if the problem
4144 is that the original message has no recipients, or 1 for any other error.
4145 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4146
4147 .vitem &%-oem%&
4148 .oindex "&%-oem%&"
4149 .cindex "error" "reporting"
4150 .cindex "return code" "for &%-oem%&"
4151 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4152 return code, whether or not the error message was successfully sent.
4153 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4154
4155 .vitem &%-oep%&
4156 .oindex "&%-oep%&"
4157 .cindex "error" "reporting"
4158 If an error is detected while a non-SMTP message is being received, the
4159 error is reported by writing a message to the standard error file (stderr).
4160 .cindex "return code" "for &%-oep%&"
4161 The return code is 1 for all errors.
4162
4163 .vitem &%-oeq%&
4164 .oindex "&%-oeq%&"
4165 .cindex "error" "reporting"
4166 This option is supported for compatibility with Sendmail, but has the same
4167 effect as &%-oep%&.
4168
4169 .vitem &%-oew%&
4170 .oindex "&%-oew%&"
4171 .cindex "error" "reporting"
4172 This option is supported for compatibility with Sendmail, but has the same
4173 effect as &%-oem%&.
4174
4175 .vitem &%-oi%&
4176 .oindex "&%-oi%&"
4177 .cindex "dot" "in incoming non-SMTP message"
4178 This option, which has the same effect as &%-i%&, specifies that a dot on a
4179 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4180 single dot does terminate, though Exim does no special processing for other
4181 lines that start with a dot. This option is set by default if Exim is called as
4182 &'rmail'&. See also &%-ti%&.
4183
4184 .vitem &%-oitrue%&
4185 .oindex "&%-oitrue%&"
4186 This option is treated as synonymous with &%-oi%&.
4187
4188 .vitem &%-oMa%&&~<&'host&~address'&>
4189 .oindex "&%-oMa%&"
4190 .cindex "sender" "host address, specifying for local message"
4191 A number of options starting with &%-oM%& can be used to set values associated
4192 with remote hosts on locally-submitted messages (that is, messages not received
4193 over TCP/IP). These options can be used by any caller in conjunction with the
4194 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4195 other circumstances, they are ignored unless the caller is trusted.
4196
4197 The &%-oMa%& option sets the sender host address. This may include a port
4198 number at the end, after a full stop (period). For example:
4199 .code
4200 exim -bs -oMa 10.9.8.7.1234
4201 .endd
4202 An alternative syntax is to enclose the IP address in square brackets,
4203 followed by a colon and the port number:
4204 .code
4205 exim -bs -oMa [10.9.8.7]:1234
4206 .endd
4207 The IP address is placed in the &$sender_host_address$& variable, and the
4208 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4209 are present on the command line, the sender host IP address is taken from
4210 whichever one is last.
4211
4212 .vitem &%-oMaa%&&~<&'name'&>
4213 .oindex "&%-oMaa%&"
4214 .cindex "authentication" "name, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4216 option sets the value of &$sender_host_authenticated$& (the authenticator
4217 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4218 This option can be used with &%-bh%& and &%-bs%& to set up an
4219 authenticated SMTP session without actually using the SMTP AUTH command.
4220
4221 .vitem &%-oMai%&&~<&'string'&>
4222 .oindex "&%-oMai%&"
4223 .cindex "authentication" "id, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4225 option sets the value of &$authenticated_id$& (the id that was authenticated).
4226 This overrides the default value (the caller's login id, except with &%-bh%&,
4227 where there is no default) for messages from local sources. See chapter
4228 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4229
4230 .vitem &%-oMas%&&~<&'address'&>
4231 .oindex "&%-oMas%&"
4232 .cindex "authentication" "sender, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4234 option sets the authenticated sender value in &$authenticated_sender$&. It
4235 overrides the sender address that is created from the caller's login id for
4236 messages from local sources, except when &%-bh%& is used, when there is no
4237 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4238 specified on a MAIL command overrides this value. See chapter
4239 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4240
4241 .vitem &%-oMi%&&~<&'interface&~address'&>
4242 .oindex "&%-oMi%&"
4243 .cindex "interface" "address, specifying for local message"
4244 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4245 option sets the IP interface address value. A port number may be included,
4246 using the same syntax as for &%-oMa%&. The interface address is placed in
4247 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4248
4249 .vitem &%-oMm%&&~<&'message&~reference'&>
4250 .oindex "&%-oMm%&"
4251 .cindex "message reference" "message reference, specifying for local message"
4252 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4253 option sets the message reference, e.g. message-id, and is logged during
4254 delivery. This is useful when some kind of audit trail is required to tie
4255 messages together. The format of the message reference is checked and will
4256 abort if the format is invalid. The option will only be accepted if exim is
4257 running in trusted mode, not as any regular user.
4258
4259 The best example of a message reference is when Exim sends a bounce message.
4260 The message reference is the message-id of the original message for which Exim
4261 is sending the bounce.
4262
4263 .vitem &%-oMr%&&~<&'protocol&~name'&>
4264 .oindex "&%-oMr%&"
4265 .cindex "protocol, specifying for local message"
4266 .vindex "&$received_protocol$&"
4267 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4268 option sets the received protocol value that is stored in
4269 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4270 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4271 SMTP protocol names (see the description of &$received_protocol$& in section
4272 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4273 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4274 be set by &%-oMr%&.
4275
4276 .vitem &%-oMs%&&~<&'host&~name'&>
4277 .oindex "&%-oMs%&"
4278 .cindex "sender" "host name, specifying for local message"
4279 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4280 option sets the sender host name in &$sender_host_name$&. When this option is
4281 present, Exim does not attempt to look up a host name from an IP address; it
4282 uses the name it is given.
4283
4284 .vitem &%-oMt%&&~<&'ident&~string'&>
4285 .oindex "&%-oMt%&"
4286 .cindex "sender" "ident string, specifying for local message"
4287 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4288 option sets the sender ident value in &$sender_ident$&. The default setting for
4289 local callers is the login id of the calling process, except when &%-bh%& is
4290 used, when there is no default.
4291
4292 .vitem &%-om%&
4293 .oindex "&%-om%&"
4294 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4295 In Sendmail, this option means &"me too"&, indicating that the sender of a
4296 message should receive a copy of the message if the sender appears in an alias
4297 expansion. Exim always does this, so the option does nothing.
4298
4299 .vitem &%-oo%&
4300 .oindex "&%-oo%&"
4301 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4302 This option is ignored. In Sendmail it specifies &"old style headers"&,
4303 whatever that means.
4304
4305 .vitem &%-oP%&&~<&'path'&>
4306 .oindex "&%-oP%&"
4307 .cindex "pid (process id)" "of daemon"
4308 .cindex "daemon" "process id (pid)"
4309 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4310 value. The option specifies the file to which the process id of the daemon is
4311 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4312 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4313 because in those cases, the normal pid file is not used.
4314
4315 .vitem &%-or%&&~<&'time'&>
4316 .oindex "&%-or%&"
4317 .cindex "timeout" "for non-SMTP input"
4318 This option sets a timeout value for incoming non-SMTP messages. If it is not
4319 set, Exim will wait forever for the standard input. The value can also be set
4320 by the &%receive_timeout%& option. The format used for specifying times is
4321 described in section &<<SECTtimeformat>>&.
4322
4323 .vitem &%-os%&&~<&'time'&>
4324 .oindex "&%-os%&"
4325 .cindex "timeout" "for SMTP input"
4326 .cindex "SMTP" "input timeout"
4327 This option sets a timeout value for incoming SMTP messages. The timeout
4328 applies to each SMTP command and block of data. The value can also be set by
4329 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4330 for specifying times is described in section &<<SECTtimeformat>>&.
4331
4332 .vitem &%-ov%&
4333 .oindex "&%-ov%&"
4334 This option has exactly the same effect as &%-v%&.
4335
4336 .vitem &%-oX%&&~<&'number&~or&~string'&>
4337 .oindex "&%-oX%&"
4338 .cindex "TCP/IP" "setting listening ports"
4339 .cindex "TCP/IP" "setting listening interfaces"
4340 .cindex "port" "receiving TCP/IP"
4341 This option is relevant only when the &%-bd%& (start listening daemon) option
4342 is also given. It controls which ports and interfaces the daemon uses. Details
4343 of the syntax, and how it interacts with configuration file options, are given
4344 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4345 file is written unless &%-oP%& is also present to specify a pid file name.
4346
4347 .vitem &%-pd%&
4348 .oindex "&%-pd%&"
4349 .cindex "Perl" "starting the interpreter"
4350 This option applies when an embedded Perl interpreter is linked with Exim (see
4351 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4352 option, forcing the starting of the interpreter to be delayed until it is
4353 needed.
4354
4355 .vitem &%-ps%&
4356 .oindex "&%-ps%&"
4357 .cindex "Perl" "starting the interpreter"
4358 This option applies when an embedded Perl interpreter is linked with Exim (see
4359 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4360 option, forcing the starting of the interpreter to occur as soon as Exim is
4361 started.
4362
4363 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4364 .oindex "&%-p%&"
4365 For compatibility with Sendmail, this option is equivalent to
4366 .display
4367 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4368 .endd
4369 It sets the incoming protocol and host name (for trusted callers). The
4370 host name and its colon can be omitted when only the protocol is to be set.
4371 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4372 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4373 or &`s`& using this option (but that does not seem a real limitation).
4374
4375 .vitem &%-q%&
4376 .oindex "&%-q%&"
4377 .cindex "queue runner" "starting manually"
4378 This option is normally restricted to admin users. However, there is a
4379 configuration option called &%prod_requires_admin%& which can be set false to
4380 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4381 and &%-S%& options).
4382
4383 .cindex "queue runner" "description of operation"
4384 .new
4385 If other commandline options do not specify an action,
4386 .wen
4387 the &%-q%& option starts one queue runner process. This scans the queue of
4388 waiting messages, and runs a delivery process for each one in turn. It waits
4389 for each delivery process to finish before starting the next one. A delivery
4390 process may not actually do any deliveries if the retry times for the addresses
4391 have not been reached. Use &%-qf%& (see below) if you want to override this.
4392
4393 If
4394 .cindex "SMTP" "passed connection"
4395 .cindex "SMTP" "multiple deliveries"
4396 .cindex "multiple SMTP deliveries"
4397 the delivery process spawns other processes to deliver other messages down
4398 passed SMTP connections, the queue runner waits for these to finish before
4399 proceeding.
4400
4401 When all the queued messages have been considered, the original queue runner
4402 process terminates. In other words, a single pass is made over the waiting
4403 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4404 this to be repeated periodically.
4405
4406 Exim processes the waiting messages in an unpredictable order. It isn't very
4407 random, but it is likely to be different each time, which is all that matters.
4408 If one particular message screws up a remote MTA, other messages to the same
4409 MTA have a chance of getting through if they get tried first.
4410
4411 It is possible to cause the messages to be processed in lexical message id
4412 order, which is essentially the order in which they arrived, by setting the
4413 &%queue_run_in_order%& option, but this is not recommended for normal use.
4414
4415 .vitem &%-q%&<&'qflags'&>
4416 The &%-q%& option may be followed by one or more flag letters that change its
4417 behaviour. They are all optional, but if more than one is present, they must
4418 appear in the correct order. Each flag is described in a separate item below.
4419
4420 .vitem &%-qq...%&
4421 .oindex "&%-qq%&"
4422 .cindex "queue" "double scanning"
4423 .cindex "queue" "routing"
4424 .cindex "routing" "whole queue before delivery"
4425 An option starting with &%-qq%& requests a two-stage queue run. In the first
4426 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4427 every domain. Addresses are routed, local deliveries happen, but no remote
4428 transports are run.
4429
4430 .cindex "hints database" "remembering routing"
4431 The hints database that remembers which messages are waiting for specific hosts
4432 is updated, as if delivery to those hosts had been deferred. After this is
4433 complete, a second, normal queue scan happens, with routing and delivery taking
4434 place as normal. Messages that are routed to the same host should mostly be
4435 delivered down a single SMTP
4436 .cindex "SMTP" "passed connection"
4437 .cindex "SMTP" "multiple deliveries"
4438 .cindex "multiple SMTP deliveries"
4439 connection because of the hints that were set up during the first queue scan.
4440 This option may be useful for hosts that are connected to the Internet
4441 intermittently.
4442
4443 .vitem &%-q[q]i...%&
4444 .oindex "&%-qi%&"
4445 .cindex "queue" "initial delivery"
4446 If the &'i'& flag is present, the queue runner runs delivery processes only for
4447 those messages that haven't previously been tried. (&'i'& stands for &"initial
4448 delivery"&.) This can be helpful if you are putting messages on the queue using
4449 &%-odq%& and want a queue runner just to process the new messages.
4450
4451 .vitem &%-q[q][i]f...%&
4452 .oindex "&%-qf%&"
4453 .cindex "queue" "forcing delivery"
4454 .cindex "delivery" "forcing in queue run"
4455 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4456 message, whereas without &'f'& only those non-frozen addresses that have passed
4457 their retry times are tried.
4458
4459 .vitem &%-q[q][i]ff...%&
4460 .oindex "&%-qff%&"
4461 .cindex "frozen messages" "forcing delivery"
4462 If &'ff'& is present, a delivery attempt is forced for every message, whether
4463 frozen or not.
4464
4465 .vitem &%-q[q][i][f[f]]l%&
4466 .oindex "&%-ql%&"
4467 .cindex "queue" "local deliveries only"
4468 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4469 be done. If a message requires any remote deliveries, it remains on the queue
4470 for later delivery.
4471
4472 .new
4473 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4474 .oindex "&%-qG%&"
4475 .cindex queue named
4476 .cindex "named queues"
4477 .cindex "queue" "delivering specific messages"
4478 If the &'G'& flag and a name is present, the queue runner operates on the
4479 queue with the given name rather than the default queue.
4480 The name should not contain a &'/'& character.
4481 For a periodic queue run (see below)
4482 append to the name a slash and a time value.
4483
4484 If other commandline options speicify an action, a &'-qG<name>'& option
4485 will specify a queue to operate on.
4486 For example:
4487 .code
4488 exim -bp -qGquarantine
4489 mailq -qGquarantime
4490 exim -qGoffpeak -Rf @special.domain.example
4491 .endd
4492 .wen
4493
4494 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4495 When scanning the queue, Exim can be made to skip over messages whose ids are
4496 lexically less than a given value by following the &%-q%& option with a
4497 starting message id. For example:
4498 .code
4499 exim -q 0t5C6f-0000c8-00
4500 .endd
4501 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4502 second message id is given, messages whose ids are lexically greater than it
4503 are also skipped. If the same id is given twice, for example,
4504 .code
4505 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4506 .endd
4507 just one delivery process is started, for that message. This differs from
4508 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4509 that it counts as a delivery from a queue run. Note that the selection
4510 mechanism does not affect the order in which the messages are scanned. There
4511 are also other ways of selecting specific sets of messages for delivery in a
4512 queue run &-- see &%-R%& and &%-S%&.
4513
4514 .vitem &%-q%&<&'qflags'&><&'time'&>
4515 .cindex "queue runner" "starting periodically"
4516 .cindex "periodic queue running"
4517 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4518 starting a queue runner process at intervals specified by the given time value
4519 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4520 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4521 single daemon process handles both functions. A common way of starting up a
4522 combined daemon at system boot time is to use a command such as
4523 .code
4524 /usr/exim/bin/exim -bd -q30m
4525 .endd
4526 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4527 process every 30 minutes.
4528
4529 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4530 pid file is written unless one is explicitly requested by the &%-oP%& option.
4531
4532 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4533 .oindex "&%-qR%&"
4534 This option is synonymous with &%-R%&. It is provided for Sendmail
4535 compatibility.
4536
4537 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4538 .oindex "&%-qS%&"
4539 This option is synonymous with &%-S%&.
4540
4541 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4542 .oindex "&%-R%&"
4543 .cindex "queue runner" "for specific recipients"
4544 .cindex "delivery" "to given domain"
4545 .cindex "domain" "delivery to"
4546 The <&'rsflags'&> may be empty, in which case the white space before the string
4547 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4548 which are the possible values for <&'rsflags'&>. White space is required if
4549 <&'rsflags'&> is not empty.
4550
4551 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4552 perform a single queue run, except that, when scanning the messages on the
4553 queue, Exim processes only those that have at least one undelivered recipient
4554 address containing the given string, which is checked in a case-independent
4555 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4556 regular expression; otherwise it is a literal string.
4557
4558 If you want to do periodic queue runs for messages with specific recipients,
4559 you can combine &%-R%& with &%-q%& and a time value. For example:
4560 .code
4561 exim -q25m -R @special.domain.example
4562 .endd
4563 This example does a queue run for messages with recipients in the given domain
4564 every 25 minutes. Any additional flags that are specified with &%-q%& are
4565 applied to each queue run.
4566
4567 Once a message is selected for delivery by this mechanism, all its addresses
4568 are processed. For the first selected message, Exim overrides any retry
4569 information and forces a delivery attempt for each undelivered address. This
4570 means that if delivery of any address in the first message is successful, any
4571 existing retry information is deleted, and so delivery attempts for that
4572 address in subsequently selected messages (which are processed without forcing)
4573 will run. However, if delivery of any address does not succeed, the retry
4574 information is updated, and in subsequently selected messages, the failing
4575 address will be skipped.
4576
4577 .cindex "frozen messages" "forcing delivery"
4578 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4579 all selected messages, not just the first; frozen messages are included when
4580 &'ff'& is present.
4581
4582 The &%-R%& option makes it straightforward to initiate delivery of all messages
4583 to a given domain after a host has been down for some time. When the SMTP
4584 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4585 effect is to run Exim with the &%-R%& option, but it can be configured to run
4586 an arbitrary command instead.
4587
4588 .vitem &%-r%&
4589 .oindex "&%-r%&"
4590 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4591
4592 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4593 .oindex "&%-S%&"
4594 .cindex "delivery" "from given sender"
4595 .cindex "queue runner" "for specific senders"
4596 This option acts like &%-R%& except that it checks the string against each
4597 message's sender instead of against the recipients. If &%-R%& is also set, both
4598 conditions must be met for a message to be selected. If either of the options
4599 has &'f'& or &'ff'& in its flags, the associated action is taken.
4600
4601 .vitem &%-Tqt%&&~<&'times'&>
4602 .oindex "&%-Tqt%&"
4603 This is an option that is exclusively for use by the Exim testing suite. It is not
4604 recognized when Exim is run normally. It allows for the setting up of explicit
4605 &"queue times"& so that various warning/retry features can be tested.
4606
4607 .vitem &%-t%&
4608 .oindex "&%-t%&"
4609 .cindex "recipient" "extracting from header lines"
4610 .cindex "&'Bcc:'& header line"
4611 .cindex "&'Cc:'& header line"
4612 .cindex "&'To:'& header line"
4613 When Exim is receiving a locally-generated, non-SMTP message on its standard
4614 input, the &%-t%& option causes the recipients of the message to be obtained
4615 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4616 from the command arguments. The addresses are extracted before any rewriting
4617 takes place and the &'Bcc:'& header line, if present, is then removed.
4618
4619 .cindex "Sendmail compatibility" "&%-t%& option"
4620 If the command has any arguments, they specify addresses to which the message
4621 is &'not'& to be delivered. That is, the argument addresses are removed from
4622 the recipients list obtained from the headers. This is compatible with Smail 3
4623 and in accordance with the documented behaviour of several versions of
4624 Sendmail, as described in man pages on a number of operating systems (e.g.
4625 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4626 argument addresses to those obtained from the headers, and the O'Reilly
4627 Sendmail book documents it that way. Exim can be made to add argument addresses
4628 instead of subtracting them by setting the option
4629 &%extract_addresses_remove_arguments%& false.
4630
4631 .cindex "&%Resent-%& header lines" "with &%-t%&"
4632 If there are any &%Resent-%& header lines in the message, Exim extracts
4633 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4634 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4635 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4636 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4637
4638 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4639 message is resent several times). The RFC also specifies that they should be
4640 added at the front of the message, and separated by &'Received:'& lines. It is
4641 not at all clear how &%-t%& should operate in the present of multiple sets,
4642 nor indeed exactly what constitutes a &"set"&.
4643 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4644 are often added at the end of the header, and if a message is resent more than
4645 once, it is common for the original set of &%Resent-%& headers to be renamed as
4646 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4647
4648 .vitem &%-ti%&
4649 .oindex "&%-ti%&"
4650 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4651 compatibility with Sendmail.
4652
4653 .vitem &%-tls-on-connect%&
4654 .oindex "&%-tls-on-connect%&"
4655 .cindex "TLS" "use without STARTTLS"
4656 .cindex "TLS" "automatic start"
4657 This option is available when Exim is compiled with TLS support. It forces all
4658 incoming SMTP connections to behave as if the incoming port is listed in the
4659 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4660 &<<CHAPTLS>>& for further details.
4661
4662
4663 .vitem &%-U%&
4664 .oindex "&%-U%&"
4665 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4666 Sendmail uses this option for &"initial message submission"&, and its
4667 documentation states that in future releases, it may complain about
4668 syntactically invalid messages rather than fixing them when this flag is not
4669 set. Exim ignores this option.
4670
4671 .vitem &%-v%&
4672 .oindex "&%-v%&"
4673 This option causes Exim to write information to the standard error stream,
4674 describing what it is doing. In particular, it shows the log lines for
4675 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4676 dialogue is shown. Some of the log lines shown may not actually be written to
4677 the log if the setting of &%log_selector%& discards them. Any relevant
4678 selectors are shown with each log line. If none are shown, the logging is
4679 unconditional.
4680
4681 .vitem &%-x%&
4682 .oindex "&%-x%&"
4683 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4684 National Language Support extended characters in the body of the mail item"&).
4685 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4686 this option.
4687
4688 .vitem &%-X%&&~<&'logfile'&>
4689 .oindex "&%-X%&"
4690 This option is interpreted by Sendmail to cause debug information to be sent
4691 to the named file.  It is ignored by Exim.
4692
4693 .vitem &%-z%&&~<&'log-line'&>
4694 .oindex "&%-z%&"
4695 This option writes its argument to Exim's logfile.
4696 Use is restricted to administrators; the intent is for operational notes.
4697 Quotes should be used to maintain a multi-word item as a single argument,
4698 under most shells.
4699 .endlist
4700
4701 .ecindex IIDclo1
4702 .ecindex IIDclo2
4703
4704
4705 . ////////////////////////////////////////////////////////////////////////////
4706 . Insert a stylized DocBook comment here, to identify the end of the command
4707 . line options. This is for the benefit of the Perl script that automatically
4708 . creates a man page for the options.
4709 . ////////////////////////////////////////////////////////////////////////////
4710
4711 .literal xml
4712 <!-- === End of command line options === -->
4713 .literal off
4714
4715
4716
4717
4718
4719 . ////////////////////////////////////////////////////////////////////////////
4720 . ////////////////////////////////////////////////////////////////////////////
4721
4722
4723 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4724          "The runtime configuration file"
4725
4726 .cindex "run time configuration"
4727 .cindex "configuration file" "general description"
4728 .cindex "CONFIGURE_FILE"
4729 .cindex "configuration file" "errors in"
4730 .cindex "error" "in configuration file"
4731 .cindex "return code" "for bad configuration"
4732 Exim uses a single run time configuration file that is read whenever an Exim
4733 binary is executed. Note that in normal operation, this happens frequently,
4734 because Exim is designed to operate in a distributed manner, without central
4735 control.
4736
4737 If a syntax error is detected while reading the configuration file, Exim
4738 writes a message on the standard error, and exits with a non-zero return code.
4739 The message is also written to the panic log. &*Note*&: Only simple syntax
4740 errors can be detected at this time. The values of any expanded options are
4741 not checked until the expansion happens, even when the expansion does not
4742 actually alter the string.
4743
4744 The name of the configuration file is compiled into the binary for security
4745 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4746 most configurations, this specifies a single file. However, it is permitted to
4747 give a colon-separated list of file names, in which case Exim uses the first
4748 existing file in the list.
4749
4750 .cindex "EXIM_USER"
4751 .cindex "EXIM_GROUP"
4752 .cindex "CONFIGURE_OWNER"
4753 .cindex "CONFIGURE_GROUP"
4754 .cindex "configuration file" "ownership"
4755 .cindex "ownership" "configuration file"
4756 The run time configuration file must be owned by root or by the user that is
4757 specified at compile time by the CONFIGURE_OWNER option (if set). The
4758 configuration file must not be world-writeable, or group-writeable unless its
4759 group is the root group or the one specified at compile time by the
4760 CONFIGURE_GROUP option.
4761
4762 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4763 to root, anybody who is able to edit the run time configuration file has an
4764 easy way to run commands as root. If you specify a user or group in the
4765 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4766 who are members of that group will trivially be able to obtain root privileges.
4767
4768 Up to Exim version 4.72, the run time configuration file was also permitted to
4769 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4770 since it offered a simple privilege escalation for any attacker who managed to
4771 compromise the Exim user account.
4772
4773 A default configuration file, which will work correctly in simple situations,
4774 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4775 defines just one file name, the installation process copies the default
4776 configuration to a new file of that name if it did not previously exist. If
4777 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4778 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4779 configuration.
4780
4781
4782
4783 .section "Using a different configuration file" "SECID40"
4784 .cindex "configuration file" "alternate"
4785 A one-off alternate configuration can be specified by the &%-C%& command line
4786 option, which may specify a single file or a list of files. However, when
4787 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4788 unless the argument for &%-C%& is identical to the built-in value from
4789 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4790 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4791 is useful mainly for checking the syntax of configuration files before
4792 installing them. No owner or group checks are done on a configuration file
4793 specified by &%-C%&, if root privilege has been dropped.
4794
4795 Even the Exim user is not trusted to specify an arbitrary configuration file
4796 with the &%-C%& option to be used with root privileges, unless that file is
4797 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4798 testing a configuration using &%-C%& right through message reception and
4799 delivery, even if the caller is root. The reception works, but by that time,
4800 Exim is running as the Exim user, so when it re-execs to regain privilege for
4801 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4802 can test reception and delivery using two separate commands (one to put a
4803 message on the queue, using &%-odq%&, and another to do the delivery, using
4804 &%-M%&).
4805
4806 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4807 prefix string with which any file named in a &%-C%& command line option must
4808 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4809 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4810 name can be used with &%-C%&.
4811
4812 One-off changes to a configuration can be specified by the &%-D%& command line
4813 option, which defines and overrides values for macros used inside the
4814 configuration file. However, like &%-C%&, the use of this option by a
4815 non-privileged user causes Exim to discard its root privilege.
4816 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4817 completely disabled, and its use causes an immediate error exit.
4818
4819 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4820 to declare certain macro names trusted, such that root privilege will not
4821 necessarily be discarded.
4822 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4823 considered safe and, if &%-D%& only supplies macros from this list, and the
4824 values are acceptable, then Exim will not give up root privilege if the caller
4825 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4826 transition mechanism and is expected to be removed in the future.  Acceptable
4827 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4828
4829 Some sites may wish to use the same Exim binary on different machines that
4830 share a file system, but to use different configuration files on each machine.
4831 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4832 looks for a file whose name is the configuration file name followed by a dot
4833 and the machine's node name, as obtained from the &[uname()]& function. If this
4834 file does not exist, the standard name is tried. This processing occurs for
4835 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4836
4837 In some esoteric situations different versions of Exim may be run under
4838 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4839 help with this. See the comments in &_src/EDITME_& for details.
4840
4841
4842
4843 .section "Configuration file format" "SECTconffilfor"
4844 .cindex "configuration file" "format of"
4845 .cindex "format" "configuration file"
4846 Exim's configuration file is divided into a number of different parts. General
4847 option settings must always appear at the start of the file. The other parts
4848 are all optional, and may appear in any order. Each part other than the first
4849 is introduced by the word &"begin"& followed by at least one literal
4850 space, and the name of the part. The optional parts are:
4851
4852 .ilist
4853 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4854 &<<CHAPACL>>&).
4855 .next
4856 .cindex "AUTH" "configuration"
4857 &'authenticators'&: Configuration settings for the authenticator drivers. These
4858 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4859 .next
4860 &'routers'&: Configuration settings for the router drivers. Routers process
4861 addresses and determine how the message is to be delivered (see chapters
4862 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4863 .next
4864 &'transports'&: Configuration settings for the transport drivers. Transports
4865 define mechanisms for copying messages to destinations (see chapters
4866 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4867 .next
4868 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4869 If there is no retry section, or if it is empty (that is, no retry rules are
4870 defined), Exim will not retry deliveries. In this situation, temporary errors
4871 are treated the same as permanent errors. Retry rules are discussed in chapter
4872 &<<CHAPretry>>&.
4873 .next
4874 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4875 when new addresses are generated during delivery. Rewriting is discussed in
4876 chapter &<<CHAPrewrite>>&.
4877 .next
4878 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4879 want to use this feature, you must set
4880 .code
4881 LOCAL_SCAN_HAS_OPTIONS=yes
4882 .endd
4883 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4884 facility are given in chapter &<<CHAPlocalscan>>&.
4885 .endlist
4886
4887 .cindex "configuration file" "leading white space in"
4888 .cindex "configuration file" "trailing white space in"
4889 .cindex "white space" "in configuration file"
4890 Leading and trailing white space in configuration lines is always ignored.
4891
4892 Blank lines in the file, and lines starting with a # character (ignoring
4893 leading white space) are treated as comments and are ignored. &*Note*&: A
4894 # character other than at the beginning of a line is not treated specially,
4895 and does not introduce a comment.
4896
4897 Any non-comment line can be continued by ending it with a backslash. Note that
4898 the general rule for white space means that trailing white space after the
4899 backslash and leading white space at the start of continuation
4900 lines is ignored. Comment lines beginning with # (but not empty lines) may
4901 appear in the middle of a sequence of continuation lines.
4902
4903 A convenient way to create a configuration file is to start from the
4904 default, which is supplied in &_src/configure.default_&, and add, delete, or
4905 change settings as required.
4906
4907 The ACLs, retry rules, and rewriting rules have their own syntax which is
4908 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4909 respectively. The other parts of the configuration file have some syntactic
4910 items in common, and these are described below, from section &<<SECTcos>>&
4911 onwards. Before that, the inclusion, macro, and conditional facilities are
4912 described.
4913
4914
4915
4916 .section "File inclusions in the configuration file" "SECID41"
4917 .cindex "inclusions in configuration file"
4918 .cindex "configuration file" "including other files"
4919 .cindex "&`.include`& in configuration file"
4920 .cindex "&`.include_if_exists`& in configuration file"
4921 You can include other files inside Exim's run time configuration file by
4922 using this syntax:
4923 .display
4924 &`.include`& <&'file name'&>
4925 &`.include_if_exists`& <&'file name'&>
4926 .endd
4927 on a line by itself. Double quotes round the file name are optional. If you use
4928 the first form, a configuration error occurs if the file does not exist; the
4929 second form does nothing for non-existent files. In all cases, an absolute file
4930 name is required.
4931
4932 Includes may be nested to any depth, but remember that Exim reads its
4933 configuration file often, so it is a good idea to keep them to a minimum.
4934 If you change the contents of an included file, you must HUP the daemon,
4935 because an included file is read only when the configuration itself is read.
4936
4937 The processing of inclusions happens early, at a physical line level, so, like
4938 comment lines, an inclusion can be used in the middle of an option setting,
4939 for example:
4940 .code
4941 hosts_lookup = a.b.c \
4942                .include /some/file
4943 .endd
4944 Include processing happens after macro processing (see below). Its effect is to
4945 process the lines of the included file as if they occurred inline where the
4946 inclusion appears.
4947
4948
4949
4950 .section "Macros in the configuration file" "SECTmacrodefs"
4951 .cindex "macro" "description of"
4952 .cindex "configuration file" "macros"
4953 If a line in the main part of the configuration (that is, before the first
4954 &"begin"& line) begins with an upper case letter, it is taken as a macro
4955 definition, and must be of the form
4956 .display
4957 <&'name'&> = <&'rest of line'&>
4958 .endd
4959 The name must consist of letters, digits, and underscores, and need not all be
4960 in upper case, though that is recommended. The rest of the line, including any
4961 continuations, is the replacement text, and has leading and trailing white
4962 space removed. Quotes are not removed. The replacement text can never end with
4963 a backslash character, but this doesn't seem to be a serious limitation.
4964
4965 Macros may also be defined between router, transport, authenticator, or ACL
4966 definitions. They may not, however, be defined within an individual driver or
4967 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4968
4969 .section "Macro substitution" "SECID42"
4970 Once a macro is defined, all subsequent lines in the file (and any included
4971 files) are scanned for the macro name; if there are several macros, the line is
4972 scanned for each in turn, in the order in which the macros are defined. The
4973 replacement text is not re-scanned for the current macro, though it is scanned
4974 for subsequently defined macros. For this reason, a macro name may not contain
4975 the name of a previously defined macro as a substring. You could, for example,
4976 define
4977 .display
4978 &`ABCD_XYZ = `&<&'something'&>
4979 &`ABCD = `&<&'something else'&>
4980 .endd
4981 but putting the definitions in the opposite order would provoke a configuration
4982 error. Macro expansion is applied to individual physical lines from the file,
4983 before checking for line continuation or file inclusion (see above). If a line
4984 consists solely of a macro name, and the expansion of the macro is empty, the
4985 line is ignored. A macro at the start of a line may turn the line into a
4986 comment line or a &`.include`& line.
4987
4988
4989 .section "Redefining macros" "SECID43"
4990 Once defined, the value of a macro can be redefined later in the configuration
4991 (or in an included file). Redefinition is specified by using &'=='& instead of
4992 &'='&. For example:
4993 .code
4994 MAC =  initial value
4995 ...
4996 MAC == updated value
4997 .endd
4998 Redefinition does not alter the order in which the macros are applied to the
4999 subsequent lines of the configuration file. It is still the same order in which
5000 the macros were originally defined. All that changes is the macro's value.
5001 Redefinition makes it possible to accumulate values. For example:
5002 .code
5003 MAC =  initial value
5004 ...
5005 MAC == MAC and something added
5006 .endd
5007 This can be helpful in situations where the configuration file is built
5008 from a number of other files.
5009
5010 .section "Overriding macro values" "SECID44"
5011 The values set for macros in the configuration file can be overridden by the
5012 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5013 used, unless called by root or the Exim user. A definition on the command line
5014 using the &%-D%& option causes all definitions and redefinitions within the
5015 file to be ignored.
5016
5017
5018
5019 .section "Example of macro usage" "SECID45"
5020 As an example of macro usage, consider a configuration where aliases are looked
5021 up in a MySQL database. It helps to keep the file less cluttered if long
5022 strings such as SQL statements are defined separately as macros, for example:
5023 .code
5024 ALIAS_QUERY = select mailbox from user where \
5025               login='${quote_mysql:$local_part}';
5026 .endd
5027 This can then be used in a &(redirect)& router setting like this:
5028 .code
5029 data = ${lookup mysql{ALIAS_QUERY}}
5030 .endd
5031 In earlier versions of Exim macros were sometimes used for domain, host, or
5032 address lists. In Exim 4 these are handled better by named lists &-- see
5033 section &<<SECTnamedlists>>&.
5034
5035
5036 .section "Conditional skips in the configuration file" "SECID46"
5037 .cindex "configuration file" "conditional skips"
5038 .cindex "&`.ifdef`&"
5039 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5040 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5041 portions of the configuration file. The processing happens whenever the file is
5042 read (that is, when an Exim binary starts to run).
5043
5044 The implementation is very simple. Instances of the first four directives must
5045 be followed by text that includes the names of one or macros. The condition
5046 that is tested is whether or not any macro substitution has taken place in the
5047 line. Thus:
5048 .code
5049 .ifdef AAA
5050 message_size_limit = 50M
5051 .else
5052 message_size_limit = 100M
5053 .endif
5054 .endd
5055 sets a message size limit of 50M if the macro &`AAA`& is defined
5056 (or &`A`& or &`AA`&), and 100M
5057 otherwise. If there is more than one macro named on the line, the condition
5058 is true if any of them are defined. That is, it is an &"or"& condition. To
5059 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5060
5061 Although you can use a macro expansion to generate one of these directives,
5062 it is not very useful, because the condition &"there was a macro substitution
5063 in this line"& will always be true.
5064
5065 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5066 to clarify complicated nestings.
5067
5068
5069
5070 .section "Common option syntax" "SECTcos"
5071 .cindex "common option syntax"
5072 .cindex "syntax of common options"
5073 .cindex "configuration file" "common option syntax"
5074 For the main set of options, driver options, and &[local_scan()]& options,
5075 each setting is on a line by itself, and starts with a name consisting of
5076 lower-case letters and underscores. Many options require a data value, and in
5077 these cases the name must be followed by an equals sign (with optional white
5078 space) and then the value. For example:
5079 .code
5080 qualify_domain = mydomain.example.com
5081 .endd
5082 .cindex "hiding configuration option values"
5083 .cindex "configuration options" "hiding value of"
5084 .cindex "options" "hiding value of"
5085 Some option settings may contain sensitive data, for example, passwords for
5086 accessing databases. To stop non-admin users from using the &%-bP%& command
5087 line option to read these values, you can precede the option settings with the
5088 word &"hide"&. For example:
5089 .code
5090 hide mysql_servers = localhost/users/admin/secret-password
5091 .endd
5092 For non-admin users, such options are displayed like this:
5093 .code
5094 mysql_servers = <value not displayable>
5095 .endd
5096 If &"hide"& is used on a driver option, it hides the value of that option on
5097 all instances of the same driver.
5098
5099 The following sections describe the syntax used for the different data types
5100 that are found in option settings.
5101
5102
5103 .section "Boolean options" "SECID47"
5104 .cindex "format" "boolean"
5105 .cindex "boolean configuration values"
5106 .oindex "&%no_%&&'xxx'&"
5107 .oindex "&%not_%&&'xxx'&"
5108 Options whose type is given as boolean are on/off switches. There are two
5109 different ways of specifying such options: with and without a data value. If
5110 the option name is specified on its own without data, the switch is turned on;
5111 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5112 boolean options may be followed by an equals sign and one of the words
5113 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5114 the following two settings have exactly the same effect:
5115 .code
5116 queue_only
5117 queue_only = true
5118 .endd
5119 The following two lines also have the same (opposite) effect:
5120 .code
5121 no_queue_only
5122 queue_only = false
5123 .endd
5124 You can use whichever syntax you prefer.
5125
5126
5127
5128
5129 .section "Integer values" "SECID48"
5130 .cindex "integer configuration values"
5131 .cindex "format" "integer"
5132 If an option's type is given as &"integer"&, the value can be given in decimal,
5133 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5134 number is assumed. Otherwise, it is treated as an octal number unless it starts
5135 with the characters &"0x"&, in which case the remainder is interpreted as a
5136 hexadecimal number.
5137
5138 If an integer value is followed by the letter K, it is multiplied by 1024; if
5139 it is followed by the letter M, it is multiplied by 1024x1024;
5140 .new
5141 if by the letter G, 1024x1024x1024.
5142 .wen
5143 When the values
5144 of integer option settings are output, values which are an exact multiple of
5145 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5146 and M. The printing style is independent of the actual input format that was
5147 used.
5148
5149
5150 .section "Octal integer values" "SECID49"
5151 .cindex "integer format"
5152 .cindex "format" "octal integer"
5153 If an option's type is given as &"octal integer"&, its value is always
5154 interpreted as an octal number, whether or not it starts with the digit zero.
5155 Such options are always output in octal.
5156
5157
5158 .section "Fixed point numbers" "SECID50"
5159 .cindex "fixed point configuration values"
5160 .cindex "format" "fixed point"
5161 If an option's type is given as &"fixed-point"&, its value must be a decimal
5162 integer, optionally followed by a decimal point and up to three further digits.
5163
5164
5165
5166 .section "Time intervals" "SECTtimeformat"
5167 .cindex "time interval" "specifying in configuration"
5168 .cindex "format" "time interval"
5169 A time interval is specified as a sequence of numbers, each followed by one of
5170 the following letters, with no intervening white space:
5171
5172 .table2 30pt
5173 .irow &%s%& seconds
5174 .irow &%m%& minutes
5175 .irow &%h%& hours
5176 .irow &%d%& days
5177 .irow &%w%& weeks
5178 .endtable
5179
5180 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5181 intervals are output in the same format. Exim does not restrict the values; it
5182 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5183
5184
5185
5186 .section "String values" "SECTstrings"
5187 .cindex "string" "format of configuration values"
5188 .cindex "format" "string"
5189 If an option's type is specified as &"string"&, the value can be specified with
5190 or without double-quotes. If it does not start with a double-quote, the value
5191 consists of the remainder of the line plus any continuation lines, starting at
5192 the first character after any leading white space, with trailing white space
5193 removed, and with no interpretation of the characters in the string. Because
5194 Exim removes comment lines (those beginning with #) at an early stage, they can
5195 appear in the middle of a multi-line string. The following two settings are
5196 therefore equivalent:
5197 .code
5198 trusted_users = uucp:mail
5199 trusted_users = uucp:\
5200                 # This comment line is ignored
5201                 mail
5202 .endd
5203 .cindex "string" "quoted"
5204 .cindex "escape characters in quoted strings"
5205 If a string does start with a double-quote, it must end with a closing
5206 double-quote, and any backslash characters other than those used for line
5207 continuation are interpreted as escape characters, as follows:
5208
5209 .table2 100pt
5210 .irow &`\\`&                     "single backslash"
5211 .irow &`\n`&                     "newline"
5212 .irow &`\r`&                     "carriage return"
5213 .irow &`\t`&                     "tab"
5214 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5215 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5216                                    character"
5217 .endtable
5218
5219 If a backslash is followed by some other character, including a double-quote
5220 character, that character replaces the pair.
5221
5222 Quoting is necessary only if you want to make use of the backslash escapes to
5223 insert special characters, or if you need to specify a value with leading or
5224 trailing spaces. These cases are rare, so quoting is almost never needed in
5225 current versions of Exim. In versions of Exim before 3.14, quoting was required
5226 in order to continue lines, so you may come across older configuration files
5227 and examples that apparently quote unnecessarily.
5228
5229
5230 .section "Expanded strings" "SECID51"
5231 .cindex "expansion" "definition of"
5232 Some strings in the configuration file are subjected to &'string expansion'&,
5233 by which means various parts of the string may be changed according to the
5234 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5235 is as just described; in particular, the handling of backslashes in quoted
5236 strings is done as part of the input process, before expansion takes place.
5237 However, backslash is also an escape character for the expander, so any
5238 backslashes that are required for that reason must be doubled if they are
5239 within a quoted configuration string.
5240
5241
5242 .section "User and group names" "SECID52"
5243 .cindex "user name" "format of"
5244 .cindex "format" "user name"
5245 .cindex "groups" "name format"
5246 .cindex "format" "group name"
5247 User and group names are specified as strings, using the syntax described
5248 above, but the strings are interpreted specially. A user or group name must
5249 either consist entirely of digits, or be a name that can be looked up using the
5250 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5251
5252
5253 .section "List construction" "SECTlistconstruct"
5254 .cindex "list" "syntax of in configuration"
5255 .cindex "format" "list item in configuration"
5256 .cindex "string" "list, definition of"
5257 The data for some configuration options is a list of items, with colon as the
5258 default separator. Many of these options are shown with type &"string list"& in
5259 the descriptions later in this document. Others are listed as &"domain list"&,
5260 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5261 are all the same; however, those other than &"string list"& are subject to
5262 particular kinds of interpretation, as described in chapter
5263 &<<CHAPdomhosaddlists>>&.
5264
5265 In all these cases, the entire list is treated as a single string as far as the
5266 input syntax is concerned. The &%trusted_users%& setting in section
5267 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5268 in a list, it must be entered as two colons. Leading and trailing white space
5269 on each item in a list is ignored. This makes it possible to include items that
5270 start with a colon, and in particular, certain forms of IPv6 address. For
5271 example, the list
5272 .code
5273 local_interfaces = 127.0.0.1 : ::::1
5274 .endd
5275 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5276
5277 &*Note*&: Although leading and trailing white space is ignored in individual
5278 list items, it is not ignored when parsing the list. The space after the first
5279 colon in the example above is necessary. If it were not there, the list would
5280 be interpreted as the two items 127.0.0.1:: and 1.
5281
5282 .section "Changing list separators" "SECTlistsepchange"
5283 .cindex "list separator" "changing"
5284 .cindex "IPv6" "addresses in lists"
5285 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5286 introduced to allow the separator character to be changed. If a list begins
5287 with a left angle bracket, followed by any punctuation character, that
5288 character is used instead of colon as the list separator. For example, the list
5289 above can be rewritten to use a semicolon separator like this:
5290 .code
5291 local_interfaces = <; 127.0.0.1 ; ::1
5292 .endd
5293 This facility applies to all lists, with the exception of the list in
5294 &%log_file_path%&. It is recommended that the use of non-colon separators be
5295 confined to circumstances where they really are needed.
5296
5297 .cindex "list separator" "newline as"
5298 .cindex "newline" "as list separator"
5299 It is also possible to use newline and other control characters (those with
5300 code values less than 32, plus DEL) as separators in lists. Such separators
5301 must be provided literally at the time the list is processed. For options that
5302 are string-expanded, you can write the separator using a normal escape
5303 sequence. This will be processed by the expander before the string is
5304 interpreted as a list. For example, if a newline-separated list of domains is
5305 generated by a lookup, you can process it directly by a line such as this:
5306 .code
5307 domains = <\n ${lookup mysql{.....}}
5308 .endd
5309 This avoids having to change the list separator in such data. You are unlikely
5310 to want to use a control character as a separator in an option that is not
5311 expanded, because the value is literal text. However, it can be done by giving
5312 the value in quotes. For example:
5313 .code
5314 local_interfaces = "<\n 127.0.0.1 \n ::1"
5315 .endd
5316 Unlike printing character separators, which can be included in list items by
5317 doubling, it is not possible to include a control character as data when it is
5318 set as the separator. Two such characters in succession are interpreted as
5319 enclosing an empty list item.
5320
5321
5322
5323 .section "Empty items in lists" "SECTempitelis"
5324 .cindex "list" "empty item in"
5325 An empty item at the end of a list is always ignored. In other words, trailing
5326 separator characters are ignored. Thus, the list in
5327 .code
5328 senders = user@domain :
5329 .endd
5330 contains only a single item. If you want to include an empty string as one item
5331 in a list, it must not be the last item. For example, this list contains three
5332 items, the second of which is empty:
5333 .code
5334 senders = user1@domain : : user2@domain
5335 .endd
5336 &*Note*&: There must be white space between the two colons, as otherwise they
5337 are interpreted as representing a single colon data character (and the list
5338 would then contain just one item). If you want to specify a list that contains
5339 just one, empty item, you can do it as in this example:
5340 .code
5341 senders = :
5342 .endd
5343 In this case, the first item is empty, and the second is discarded because it
5344 is at the end of the list.
5345
5346
5347
5348
5349 .section "Format of driver configurations" "SECTfordricon"
5350 .cindex "drivers" "configuration format"
5351 There are separate parts in the configuration for defining routers, transports,
5352 and authenticators. In each part, you are defining a number of driver
5353 instances, each with its own set of options. Each driver instance is defined by
5354 a sequence of lines like this:
5355 .display
5356 <&'instance name'&>:
5357   <&'option'&>
5358   ...
5359   <&'option'&>
5360 .endd
5361 In the following example, the instance name is &(localuser)&, and it is
5362 followed by three options settings:
5363 .code
5364 localuser:
5365   driver = accept
5366   check_local_user
5367   transport = local_delivery
5368 .endd
5369 For each driver instance, you specify which Exim code module it uses &-- by the
5370 setting of the &%driver%& option &-- and (optionally) some configuration
5371 settings. For example, in the case of transports, if you want a transport to
5372 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5373 a local file you would use the &(appendfile)& driver. Each of the drivers is
5374 described in detail in its own separate chapter later in this manual.
5375
5376 You can have several routers, transports, or authenticators that are based on
5377 the same underlying driver (each must have a different instance name).
5378
5379 The order in which routers are defined is important, because addresses are
5380 passed to individual routers one by one, in order. The order in which
5381 transports are defined does not matter at all. The order in which
5382 authenticators are defined is used only when Exim, as a client, is searching
5383 them to find one that matches an authentication mechanism offered by the
5384 server.
5385
5386 .cindex "generic options"
5387 .cindex "options" "generic &-- definition of"
5388 Within a driver instance definition, there are two kinds of option: &'generic'&
5389 and &'private'&. The generic options are those that apply to all drivers of the
5390 same type (that is, all routers, all transports or all authenticators). The
5391 &%driver%& option is a generic option that must appear in every definition.
5392 .cindex "private options"
5393 The private options are special for each driver, and none need appear, because
5394 they all have default values.
5395
5396 The options may appear in any order, except that the &%driver%& option must
5397 precede any private options, since these depend on the particular driver. For
5398 this reason, it is recommended that &%driver%& always be the first option.
5399
5400 Driver instance names, which are used for reference in log entries and
5401 elsewhere, can be any sequence of letters, digits, and underscores (starting
5402 with a letter) and must be unique among drivers of the same type. A router and
5403 a transport (for example) can each have the same name, but no two router
5404 instances can have the same name. The name of a driver instance should not be
5405 confused with the name of the underlying driver module. For example, the
5406 configuration lines:
5407 .code
5408 remote_smtp:
5409   driver = smtp
5410 .endd
5411 create an instance of the &(smtp)& transport driver whose name is
5412 &(remote_smtp)&. The same driver code can be used more than once, with
5413 different instance names and different option settings each time. A second
5414 instance of the &(smtp)& transport, with different options, might be defined
5415 thus:
5416 .code
5417 special_smtp:
5418   driver = smtp
5419   port = 1234
5420   command_timeout = 10s
5421 .endd
5422 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5423 these transport instances from routers, and these names would appear in log
5424 lines.
5425
5426 Comment lines may be present in the middle of driver specifications. The full
5427 list of option settings for any particular driver instance, including all the
5428 defaulted values, can be extracted by making use of the &%-bP%& command line
5429 option.
5430
5431
5432
5433
5434
5435
5436 . ////////////////////////////////////////////////////////////////////////////
5437 . ////////////////////////////////////////////////////////////////////////////
5438
5439 .chapter "The default configuration file" "CHAPdefconfil"
5440 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5441 .cindex "default" "configuration file &""walk through""&"
5442 The default configuration file supplied with Exim as &_src/configure.default_&
5443 is sufficient for a host with simple mail requirements. As an introduction to
5444 the way Exim is configured, this chapter &"walks through"& the default
5445 configuration, giving brief explanations of the settings. Detailed descriptions
5446 of the options are given in subsequent chapters. The default configuration file
5447 itself contains extensive comments about ways you might want to modify the
5448 initial settings. However, note that there are many options that are not
5449 mentioned at all in the default configuration.
5450
5451
5452
5453 .section "Main configuration settings" "SECTdefconfmain"
5454 The main (global) configuration option settings must always come first in the
5455 file. The first thing you'll see in the file, after some initial comments, is
5456 the line
5457 .code
5458 # primary_hostname =
5459 .endd
5460 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5461 to know the official, fully qualified name of your host, and this is where you
5462 can specify it. However, in most cases you do not need to set this option. When
5463 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5464
5465 The first three non-comment configuration lines are as follows:
5466 .code
5467 domainlist local_domains    = @
5468 domainlist relay_to_domains =
5469 hostlist   relay_from_hosts = 127.0.0.1
5470 .endd
5471 These are not, in fact, option settings. They are definitions of two named
5472 domain lists and one named host list. Exim allows you to give names to lists of
5473 domains, hosts, and email addresses, in order to make it easier to manage the
5474 configuration file (see section &<<SECTnamedlists>>&).
5475
5476 The first line defines a domain list called &'local_domains'&; this is used
5477 later in the configuration to identify domains that are to be delivered
5478 on the local host.
5479
5480 .cindex "@ in a domain list"
5481 There is just one item in this list, the string &"@"&. This is a special form
5482 of entry which means &"the name of the local host"&. Thus, if the local host is
5483 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5484 be delivered locally. Because the local host's name is referenced indirectly,
5485 the same configuration file can be used on different hosts.
5486
5487 The second line defines a domain list called &'relay_to_domains'&, but the
5488 list itself is empty. Later in the configuration we will come to the part that
5489 controls mail relaying through the local host; it allows relaying to any
5490 domains in this list. By default, therefore, no relaying on the basis of a mail
5491 domain is permitted.
5492
5493 The third line defines a host list called &'relay_from_hosts'&. This list is
5494 used later in the configuration to permit relaying from any host or IP address
5495 that matches the list. The default contains just the IP address of the IPv4
5496 loopback interface, which means that processes on the local host are able to
5497 submit mail for relaying by sending it over TCP/IP to that interface. No other
5498 hosts are permitted to submit messages for relaying.
5499
5500 Just to be sure there's no misunderstanding: at this point in the configuration
5501 we aren't actually setting up any controls. We are just defining some domains
5502 and hosts that will be used in the controls that are specified later.
5503
5504 The next two configuration lines are genuine option settings:
5505 .code
5506 acl_smtp_rcpt = acl_check_rcpt
5507 acl_smtp_data = acl_check_data
5508 .endd
5509 These options specify &'Access Control Lists'& (ACLs) that are to be used
5510 during an incoming SMTP session for every recipient of a message (every RCPT
5511 command), and after the contents of the message have been received,
5512 respectively. The names of the lists are &'acl_check_rcpt'& and
5513 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5514 section of the configuration. The RCPT ACL controls which recipients are
5515 accepted for an incoming message &-- if a configuration does not provide an ACL
5516 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5517 contents of a message to be checked.
5518
5519 Two commented-out option settings are next:
5520 .code
5521 # av_scanner = clamd:/tmp/clamd
5522 # spamd_address = 127.0.0.1 783
5523 .endd
5524 These are example settings that can be used when Exim is compiled with the
5525 content-scanning extension. The first specifies the interface to the virus
5526 scanner, and the second specifies the interface to SpamAssassin. Further
5527 details are given in chapter &<<CHAPexiscan>>&.
5528
5529 Three more commented-out option settings follow:
5530 .code
5531 # tls_advertise_hosts = *
5532 # tls_certificate = /etc/ssl/exim.crt
5533 # tls_privatekey = /etc/ssl/exim.pem
5534 .endd
5535 These are example settings that can be used when Exim is compiled with
5536 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5537 first one specifies the list of clients that are allowed to use TLS when
5538 connecting to this server; in this case the wildcard means all clients. The
5539 other options specify where Exim should find its TLS certificate and private
5540 key, which together prove the server's identity to any clients that connect.
5541 More details are given in chapter &<<CHAPTLS>>&.
5542
5543 Another two commented-out option settings follow:
5544 .code
5545 # daemon_smtp_ports = 25 : 465 : 587
5546 # tls_on_connect_ports = 465
5547 .endd
5548 .cindex "port" "465 and 587"
5549 .cindex "port" "for message submission"
5550 .cindex "message" "submission, ports for"
5551 .cindex "ssmtp protocol"
5552 .cindex "smtps protocol"
5553 .cindex "SMTP" "ssmtp protocol"
5554 .cindex "SMTP" "smtps protocol"
5555 These options provide better support for roaming users who wish to use this
5556 server for message submission. They are not much use unless you have turned on
5557 TLS (as described in the previous paragraph) and authentication (about which
5558 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5559 on end-user networks, so RFC 4409 specifies that message submission should use
5560 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5561 configured to use port 587 correctly, so these settings also enable the
5562 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5563 &<<SECTsupobssmt>>&).
5564
5565 Two more commented-out options settings follow:
5566 .code
5567 # qualify_domain =
5568 # qualify_recipient =
5569 .endd
5570 The first of these specifies a domain that Exim uses when it constructs a
5571 complete email address from a local login name. This is often needed when Exim
5572 receives a message from a local process. If you do not set &%qualify_domain%&,
5573 the value of &%primary_hostname%& is used. If you set both of these options,
5574 you can have different qualification domains for sender and recipient
5575 addresses. If you set only the first one, its value is used in both cases.
5576
5577 .cindex "domain literal" "recognizing format"
5578 The following line must be uncommented if you want Exim to recognize
5579 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5580 (an IP address within square brackets) instead of a named domain.
5581 .code
5582 # allow_domain_literals
5583 .endd
5584 The RFCs still require this form, but many people think that in the modern
5585 Internet it makes little sense to permit mail to be sent to specific hosts by
5586 quoting their IP addresses. This ancient format has been used by people who
5587 try to abuse hosts by using them for unwanted relaying. However, some
5588 people believe there are circumstances (for example, messages addressed to
5589 &'postmaster'&) where domain literals are still useful.
5590
5591 The next configuration line is a kind of trigger guard:
5592 .code
5593 never_users = root
5594 .endd
5595 It specifies that no delivery must ever be run as the root user. The normal
5596 convention is to set up &'root'& as an alias for the system administrator. This
5597 setting is a guard against slips in the configuration.
5598 The list of users specified by &%never_users%& is not, however, the complete
5599 list; the build-time configuration in &_Local/Makefile_& has an option called
5600 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5601 contents of &%never_users%& are added to this list. By default
5602 FIXED_NEVER_USERS also specifies root.
5603
5604 When a remote host connects to Exim in order to send mail, the only information
5605 Exim has about the host's identity is its IP address. The next configuration
5606 line,
5607 .code
5608 host_lookup = *
5609 .endd
5610 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5611 in order to get a host name. This improves the quality of the logging
5612 information, but if you feel it is too expensive, you can remove it entirely,
5613 or restrict the lookup to hosts on &"nearby"& networks.
5614 Note that it is not always possible to find a host name from an IP address,
5615 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5616 unreachable.
5617
5618 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5619 1413 (hence their names):
5620 .code
5621 rfc1413_hosts = *
5622 rfc1413_query_timeout = 0s
5623 .endd
5624 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5625 Few hosts offer RFC1413 service these days; calls have to be
5626 terminated by a timeout and this needlessly delays the startup
5627 of an incoming SMTP connection.
5628 If you have hosts for which you trust RFC1413 and need this
5629 information, you can change this.
5630
5631 This line enables an efficiency SMTP option.  It is negotiated by clients
5632 and not expected to cause problems but can be disabled if needed.
5633 .code
5634 prdr_enable = true
5635 .endd
5636
5637 When Exim receives messages over SMTP connections, it expects all addresses to
5638 be fully qualified with a domain, as required by the SMTP definition. However,
5639 if you are running a server to which simple clients submit messages, you may
5640 find that they send unqualified addresses. The two commented-out options:
5641 .code
5642 # sender_unqualified_hosts =
5643 # recipient_unqualified_hosts =
5644 .endd
5645 show how you can specify hosts that are permitted to send unqualified sender
5646 and recipient addresses, respectively.
5647
5648 The &%log_selector%& option is used to increase the detail of logging
5649 over the default:
5650 .code
5651 log_selector = +smtp_protocol_error +smtp_syntax_error \
5652                +tls_certificate_verified
5653 .endd
5654
5655 The &%percent_hack_domains%& option is also commented out:
5656 .code
5657 # percent_hack_domains =
5658 .endd
5659 It provides a list of domains for which the &"percent hack"& is to operate.
5660 This is an almost obsolete form of explicit email routing. If you do not know
5661 anything about it, you can safely ignore this topic.
5662
5663 The next two settings in the main part of the default configuration are
5664 concerned with messages that have been &"frozen"& on Exim's queue. When a
5665 message is frozen, Exim no longer continues to try to deliver it. Freezing
5666 occurs when a bounce message encounters a permanent failure because the sender
5667 address of the original message that caused the bounce is invalid, so the
5668 bounce cannot be delivered. This is probably the most common case, but there
5669 are also other conditions that cause freezing, and frozen messages are not
5670 always bounce messages.
5671 .code
5672 ignore_bounce_errors_after = 2d
5673 timeout_frozen_after = 7d
5674 .endd
5675 The first of these options specifies that failing bounce messages are to be
5676 discarded after 2 days on the queue. The second specifies that any frozen
5677 message (whether a bounce message or not) is to be timed out (and discarded)
5678 after a week. In this configuration, the first setting ensures that no failing
5679 bounce message ever lasts a week.
5680
5681 Exim queues it's messages in a spool directory. If you expect to have
5682 large queues, you may consider using this option. It splits the spool
5683 directory into subdirectories to avoid file system degradation from
5684 many files in a single directory, resulting in better performance.
5685 Manual manipulation of queued messages becomes more complex (though fortunately
5686 not often needed).
5687 .code
5688 # split_spool_directory = true
5689 .endd
5690
5691 In an ideal world everybody follows the standards. For non-ASCII
5692 messages RFC 2047 is a standard, allowing a maximum line length of 76
5693 characters. Exim adheres that standard and won't process messages which
5694 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5695 In particular, the Exim maintainers have had multiple reports of
5696 problems from Russian administrators of issues until they disable this
5697 check, because of some popular, yet buggy, mail composition software.
5698 .code
5699 # check_rfc2047_length = false
5700 .endd
5701
5702 If you need to be strictly RFC compliant you may wish to disable the
5703 8BITMIME advertisement. Use this, if you exchange mails with systems
5704 that are not 8-bit clean.
5705 .code
5706 # accept_8bitmime = false
5707 .endd
5708
5709 Libraries you use may depend on specific environment settings.  This
5710 imposes a security risk (e.g. PATH). There are two lists:
5711 &%keep_environment%& for the variables to import as they are, and
5712 &%add_environment%& for variables we want to set to a fixed value.
5713 Note that TZ is handled separately, by the $%timezone%$ runtime
5714 option and by the TIMEZONE_DEFAULT buildtime option.
5715 .code
5716 # keep_environment = ^LDAP
5717 # add_environment = PATH=/usr/bin::/bin
5718 .endd
5719
5720
5721 .section "ACL configuration" "SECID54"
5722 .cindex "default" "ACLs"
5723 .cindex "&ACL;" "default configuration"
5724 In the default configuration, the ACL section follows the main configuration.
5725 It starts with the line
5726 .code
5727 begin acl
5728 .endd
5729 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5730 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5731 and &%acl_smtp_data%& above.
5732
5733 .cindex "RCPT" "ACL for"
5734 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5735 RCPT command specifies one of the message's recipients. The ACL statements
5736 are considered in order, until the recipient address is either accepted or
5737 rejected. The RCPT command is then accepted or rejected, according to the
5738 result of the ACL processing.
5739 .code
5740 acl_check_rcpt:
5741 .endd
5742 This line, consisting of a name terminated by a colon, marks the start of the
5743 ACL, and names it.
5744 .code
5745 accept  hosts = :
5746 .endd
5747 This ACL statement accepts the recipient if the sending host matches the list.
5748 But what does that strange list mean? It doesn't actually contain any host
5749 names or IP addresses. The presence of the colon puts an empty item in the
5750 list; Exim matches this only if the incoming message did not come from a remote
5751 host, because in that case, the remote hostname is empty. The colon is
5752 important. Without it, the list itself is empty, and can never match anything.
5753
5754 What this statement is doing is to accept unconditionally all recipients in
5755 messages that are submitted by SMTP from local processes using the standard
5756 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5757 manner.
5758 .code
5759 deny    message       = Restricted characters in address
5760         domains       = +local_domains
5761         local_parts   = ^[.] : ^.*[@%!/|]
5762
5763 deny    message       = Restricted characters in address
5764         domains       = !+local_domains
5765         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5766 .endd
5767 These statements are concerned with local parts that contain any of the
5768 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5769 Although these characters are entirely legal in local parts (in the case of
5770 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5771 in Internet mail addresses.
5772
5773 The first three have in the past been associated with explicitly routed
5774 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5775 option). Addresses containing these characters are regularly tried by spammers
5776 in an attempt to bypass relaying restrictions, and also by open relay testing
5777 programs. Unless you really need them it is safest to reject these characters
5778 at this early stage. This configuration is heavy-handed in rejecting these
5779 characters for all messages it accepts from remote hosts. This is a deliberate
5780 policy of being as safe as possible.
5781
5782 The first rule above is stricter, and is applied to messages that are addressed
5783 to one of the local domains handled by this host. This is implemented by the
5784 first condition, which restricts it to domains that are listed in the
5785 &'local_domains'& domain list. The &"+"& character is used to indicate a
5786 reference to a named list. In this configuration, there is just one domain in
5787 &'local_domains'&, but in general there may be many.
5788
5789 The second condition on the first statement uses two regular expressions to
5790 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5791 or &"|"&. If you have local accounts that include these characters, you will
5792 have to modify this rule.
5793
5794 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5795 allows them because they have been encountered in practice. (Consider the
5796 common convention of local parts constructed as
5797 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5798 the author of Exim, who has no second initial.) However, a local part starting
5799 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5800 file name (for example, for a mailing list). This is also true for local parts
5801 that contain slashes. A pipe symbol can also be troublesome if the local part
5802 is incorporated unthinkingly into a shell command line.
5803
5804 The second rule above applies to all other domains, and is less strict. This
5805 allows your own users to send outgoing messages to sites that use slashes
5806 and vertical bars in their local parts. It blocks local parts that begin
5807 with a dot, slash, or vertical bar, but allows these characters within the
5808 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5809 and &"!"& is blocked, as before. The motivation here is to prevent your users
5810 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5811 .code
5812 accept  local_parts   = postmaster
5813         domains       = +local_domains
5814 .endd
5815 This statement, which has two conditions, accepts an incoming address if the
5816 local part is &'postmaster'& and the domain is one of those listed in the
5817 &'local_domains'& domain list. The &"+"& character is used to indicate a
5818 reference to a named list. In this configuration, there is just one domain in
5819 &'local_domains'&, but in general there may be many.
5820
5821 The presence of this statement means that mail to postmaster is never blocked
5822 by any of the subsequent tests. This can be helpful while sorting out problems
5823 in cases where the subsequent tests are incorrectly denying access.
5824 .code
5825 require verify        = sender
5826 .endd
5827 This statement requires the sender address to be verified before any subsequent
5828 ACL statement can be used. If verification fails, the incoming recipient
5829 address is refused. Verification consists of trying to route the address, to
5830 see if a bounce message could be delivered to it. In the case of remote
5831 addresses, basic verification checks only the domain, but &'callouts'& can be
5832 used for more verification if required. Section &<<SECTaddressverification>>&
5833 discusses the details of address verification.
5834 .code
5835 accept  hosts         = +relay_from_hosts
5836         control       = submission
5837 .endd
5838 This statement accepts the address if the message is coming from one of the
5839 hosts that are defined as being allowed to relay through this host. Recipient
5840 verification is omitted here, because in many cases the clients are dumb MUAs
5841 that do not cope well with SMTP error responses. For the same reason, the
5842 second line specifies &"submission mode"& for messages that are accepted. This
5843 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5844 messages that are deficient in some way, for example, because they lack a
5845 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5846 probably add recipient verification here, and disable submission mode.
5847 .code
5848 accept  authenticated = *
5849         control       = submission
5850 .endd
5851 This statement accepts the address if the client host has authenticated itself.
5852 Submission mode is again specified, on the grounds that such messages are most
5853 likely to come from MUAs. The default configuration does not define any
5854 authenticators, though it does include some nearly complete commented-out
5855 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5856 fact authenticate until you complete the authenticator definitions.
5857 .code
5858 require message = relay not permitted
5859         domains = +local_domains : +relay_to_domains
5860 .endd
5861 This statement rejects the address if its domain is neither a local domain nor
5862 one of the domains for which this host is a relay.
5863 .code
5864 require verify = recipient
5865 .endd
5866 This statement requires the recipient address to be verified; if verification
5867 fails, the address is rejected.
5868 .code
5869 # deny    message     = rejected because $sender_host_address \
5870 #                       is in a black list at $dnslist_domain\n\
5871 #                       $dnslist_text
5872 #         dnslists    = black.list.example
5873 #
5874 # warn    dnslists    = black.list.example
5875 #         add_header  = X-Warning: $sender_host_address is in \
5876 #                       a black list at $dnslist_domain
5877 #         log_message = found in $dnslist_domain
5878 .endd
5879 These commented-out lines are examples of how you could configure Exim to check
5880 sending hosts against a DNS black list. The first statement rejects messages
5881 from blacklisted hosts, whereas the second just inserts a warning header
5882 line.
5883 .code
5884 # require verify = csa
5885 .endd
5886 This commented-out line is an example of how you could turn on client SMTP
5887 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5888 records.
5889 .code
5890 accept
5891 .endd
5892 The final statement in the first ACL unconditionally accepts any recipient
5893 address that has successfully passed all the previous tests.
5894 .code
5895 acl_check_data:
5896 .endd
5897 This line marks the start of the second ACL, and names it. Most of the contents
5898 of this ACL are commented out:
5899 .code
5900 # deny    malware   = *
5901 #         message   = This message contains a virus \
5902 #                     ($malware_name).
5903 .endd
5904 These lines are examples of how to arrange for messages to be scanned for
5905 viruses when Exim has been compiled with the content-scanning extension, and a
5906 suitable virus scanner is installed. If the message is found to contain a
5907 virus, it is rejected with the given custom error message.
5908 .code
5909 # warn    spam      = nobody
5910 #         message   = X-Spam_score: $spam_score\n\
5911 #                     X-Spam_score_int: $spam_score_int\n\
5912 #                     X-Spam_bar: $spam_bar\n\
5913 #                     X-Spam_report: $spam_report
5914 .endd
5915 These lines are an example of how to arrange for messages to be scanned by
5916 SpamAssassin when Exim has been compiled with the content-scanning extension,
5917 and SpamAssassin has been installed. The SpamAssassin check is run with
5918 &`nobody`& as its user parameter, and the results are added to the message as a
5919 series of extra header line. In this case, the message is not rejected,
5920 whatever the spam score.
5921 .code
5922 accept
5923 .endd
5924 This final line in the DATA ACL accepts the message unconditionally.
5925
5926
5927 .section "Router configuration" "SECID55"
5928 .cindex "default" "routers"
5929 .cindex "routers" "default"
5930 The router configuration comes next in the default configuration, introduced
5931 by the line
5932 .code
5933 begin routers
5934 .endd
5935 Routers are the modules in Exim that make decisions about where to send
5936 messages. An address is passed to each router in turn, until it is either
5937 accepted, or failed. This means that the order in which you define the routers
5938 matters. Each router is fully described in its own chapter later in this
5939 manual. Here we give only brief overviews.
5940 .code
5941 # domain_literal:
5942 #   driver = ipliteral
5943 #   domains = !+local_domains
5944 #   transport = remote_smtp
5945 .endd
5946 .cindex "domain literal" "default router"
5947 This router is commented out because the majority of sites do not want to
5948 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5949 you uncomment this router, you also need to uncomment the setting of
5950 &%allow_domain_literals%& in the main part of the configuration.
5951 .code
5952 dnslookup:
5953   driver = dnslookup
5954   domains = ! +local_domains
5955   transport = remote_smtp
5956   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5957   no_more
5958 .endd
5959 The first uncommented router handles addresses that do not involve any local
5960 domains. This is specified by the line
5961 .code
5962 domains = ! +local_domains
5963 .endd
5964 The &%domains%& option lists the domains to which this router applies, but the
5965 exclamation mark is a negation sign, so the router is used only for domains
5966 that are not in the domain list called &'local_domains'& (which was defined at
5967 the start of the configuration). The plus sign before &'local_domains'&
5968 indicates that it is referring to a named list. Addresses in other domains are
5969 passed on to the following routers.
5970
5971 The name of the router driver is &(dnslookup)&,
5972 and is specified by the &%driver%& option. Do not be confused by the fact that
5973 the name of this router instance is the same as the name of the driver. The
5974 instance name is arbitrary, but the name set in the &%driver%& option must be
5975 one of the driver modules that is in the Exim binary.
5976
5977 The &(dnslookup)& router routes addresses by looking up their domains in the
5978 DNS in order to obtain a list of hosts to which the address is routed. If the
5979 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5980 specified by the &%transport%& option. If the router does not find the domain
5981 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5982 the address fails and is bounced.
5983
5984 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5985 be entirely ignored. This option is present because a number of cases have been
5986 encountered where MX records in the DNS point to host names
5987 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5988 Completely ignoring these IP addresses causes Exim to fail to route the
5989 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5990 continue to try to deliver the message periodically until the address timed
5991 out.
5992 .code
5993 system_aliases:
5994   driver = redirect
5995   allow_fail
5996   allow_defer
5997   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5998 # user = exim
5999   file_transport = address_file
6000   pipe_transport = address_pipe
6001 .endd
6002 Control reaches this and subsequent routers only for addresses in the local
6003 domains. This router checks to see whether the local part is defined as an
6004 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6005 data that it looks up from that file. If no data is found for the local part,
6006 the value of the &%data%& option is empty, causing the address to be passed to
6007 the next router.
6008
6009 &_/etc/aliases_& is a conventional name for the system aliases file that is
6010 often used. That is why it is referenced by from the default configuration
6011 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6012 &_Local/Makefile_& before building Exim.
6013 .code
6014 userforward:
6015   driver = redirect
6016   check_local_user
6017 # local_part_suffix = +* : -*
6018 # local_part_suffix_optional
6019   file = $home/.forward
6020 # allow_filter
6021   no_verify
6022   no_expn
6023   check_ancestor
6024   file_transport = address_file
6025   pipe_transport = address_pipe
6026   reply_transport = address_reply
6027 .endd
6028 This is the most complicated router in the default configuration. It is another
6029 redirection router, but this time it is looking for forwarding data set up by
6030 individual users. The &%check_local_user%& setting specifies a check that the
6031 local part of the address is the login name of a local user. If it is not, the
6032 router is skipped. The two commented options that follow &%check_local_user%&,
6033 namely:
6034 .code
6035 # local_part_suffix = +* : -*
6036 # local_part_suffix_optional
6037 .endd
6038 .vindex "&$local_part_suffix$&"
6039 show how you can specify the recognition of local part suffixes. If the first
6040 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6041 by any sequence of characters, is removed from the local part and placed in the
6042 variable &$local_part_suffix$&. The second suffix option specifies that the
6043 presence of a suffix in the local part is optional. When a suffix is present,
6044 the check for a local login uses the local part with the suffix removed.
6045
6046 When a local user account is found, the file called &_.forward_& in the user's
6047 home directory is consulted. If it does not exist, or is empty, the router
6048 declines. Otherwise, the contents of &_.forward_& are interpreted as
6049 redirection data (see chapter &<<CHAPredirect>>& for more details).
6050
6051 .cindex "Sieve filter" "enabling in default router"
6052 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6053 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6054 is commented out by default), the contents of the file are interpreted as a set
6055 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6056 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6057 separate document entitled &'Exim's interfaces to mail filtering'&.
6058
6059 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6060 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6061 There are two reasons for doing this:
6062
6063 .olist
6064 Whether or not a local user has a &_.forward_& file is not really relevant when
6065 checking an address for validity; it makes sense not to waste resources doing
6066 unnecessary work.
6067 .next
6068 More importantly, when Exim is verifying addresses or handling an EXPN
6069 command during an SMTP session, it is running as the Exim user, not as root.
6070 The group is the Exim group, and no additional groups are set up.
6071 It may therefore not be possible for Exim to read users' &_.forward_& files at
6072 this time.
6073 .endlist
6074
6075 The setting of &%check_ancestor%& prevents the router from generating a new
6076 address that is the same as any previous address that was redirected. (This
6077 works round a problem concerning a bad interaction between aliasing and
6078 forwarding &-- see section &<<SECTredlocmai>>&).
6079
6080 The final three option settings specify the transports that are to be used when
6081 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6082 auto-reply, respectively. For example, if a &_.forward_& file contains
6083 .code
6084 a.nother@elsewhere.example, /home/spqr/archive
6085 .endd
6086 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6087 transport.
6088 .code
6089 localuser:
6090   driver = accept
6091   check_local_user
6092 # local_part_suffix = +* : -*
6093 # local_part_suffix_optional
6094   transport = local_delivery
6095 .endd
6096 The final router sets up delivery into local mailboxes, provided that the local
6097 part is the name of a local login, by accepting the address and assigning it to
6098 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6099 routers, so the address is bounced. The commented suffix settings fulfil the
6100 same purpose as they do for the &(userforward)& router.
6101
6102
6103 .section "Transport configuration" "SECID56"
6104 .cindex "default" "transports"
6105 .cindex "transports" "default"
6106 Transports define mechanisms for actually delivering messages. They operate
6107 only when referenced from routers, so the order in which they are defined does
6108 not matter. The transports section of the configuration starts with
6109 .code
6110 begin transports
6111 .endd
6112 One remote transport and four local transports are defined.
6113 .code
6114 remote_smtp:
6115   driver = smtp
6116   hosts_try_prdr = *
6117 .endd
6118 This transport is used for delivering messages over SMTP connections.
6119 The list of remote hosts comes from the router.
6120 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6121 It is negotiated between client and server
6122 and not expected to cause problems but can be disabled if needed.
6123 All other options are defaulted.
6124 .code
6125 local_delivery:
6126   driver = appendfile
6127   file = /var/mail/$local_part
6128   delivery_date_add
6129   envelope_to_add
6130   return_path_add
6131 # group = mail
6132 # mode = 0660
6133 .endd
6134 This &(appendfile)& transport is used for local delivery to user mailboxes in
6135 traditional BSD mailbox format. By default it runs under the uid and gid of the
6136 local user, which requires the sticky bit to be set on the &_/var/mail_&
6137 directory. Some systems use the alternative approach of running mail deliveries
6138 under a particular group instead of using the sticky bit. The commented options
6139 show how this can be done.
6140
6141 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6142 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6143 similarly-named options above.
6144 .code
6145 address_pipe:
6146   driver = pipe
6147   return_output
6148 .endd
6149 This transport is used for handling deliveries to pipes that are generated by
6150 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6151 option specifies that any output on stdout or stderr generated by the pipe is to
6152 be returned to the sender.
6153 .code
6154 address_file:
6155   driver = appendfile
6156   delivery_date_add
6157   envelope_to_add
6158   return_path_add
6159 .endd
6160 This transport is used for handling deliveries to files that are generated by
6161 redirection. The name of the file is not specified in this instance of
6162 &(appendfile)&, because it comes from the &(redirect)& router.
6163 .code
6164 address_reply:
6165   driver = autoreply
6166 .endd
6167 This transport is used for handling automatic replies generated by users'
6168 filter files.
6169
6170
6171
6172 .section "Default retry rule" "SECID57"
6173 .cindex "retry" "default rule"
6174 .cindex "default" "retry rule"
6175 The retry section of the configuration file contains rules which affect the way
6176 Exim retries deliveries that cannot be completed at the first attempt. It is
6177 introduced by the line
6178 .code
6179 begin retry
6180 .endd
6181 In the default configuration, there is just one rule, which applies to all
6182 errors:
6183 .code
6184 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6185 .endd
6186 This causes any temporarily failing address to be retried every 15 minutes for
6187 2 hours, then at intervals starting at one hour and increasing by a factor of
6188 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6189 is not delivered after 4 days of temporary failure, it is bounced. The time is
6190 measured from first failure, not from the time the message was received.
6191
6192 If the retry section is removed from the configuration, or is empty (that is,
6193 if no retry rules are defined), Exim will not retry deliveries. This turns
6194 temporary errors into permanent errors.
6195
6196
6197 .section "Rewriting configuration" "SECID58"
6198 The rewriting section of the configuration, introduced by
6199 .code
6200 begin rewrite
6201 .endd
6202 contains rules for rewriting addresses in messages as they arrive. There are no
6203 rewriting rules in the default configuration file.
6204
6205
6206
6207 .section "Authenticators configuration" "SECTdefconfauth"
6208 .cindex "AUTH" "configuration"
6209 The authenticators section of the configuration, introduced by
6210 .code
6211 begin authenticators
6212 .endd
6213 defines mechanisms for the use of the SMTP AUTH command. The default
6214 configuration file contains two commented-out example authenticators
6215 which support plaintext username/password authentication using the
6216 standard PLAIN mechanism and the traditional but non-standard LOGIN
6217 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6218 to support most MUA software.
6219
6220 The example PLAIN authenticator looks like this:
6221 .code
6222 #PLAIN:
6223 #  driver                  = plaintext
6224 #  server_set_id           = $auth2
6225 #  server_prompts          = :
6226 #  server_condition        = Authentication is not yet configured
6227 #  server_advertise_condition = ${if def:tls_in_cipher }
6228 .endd
6229 And the example LOGIN authenticator looks like this:
6230 .code
6231 #LOGIN:
6232 #  driver                  = plaintext
6233 #  server_set_id           = $auth1
6234 #  server_prompts          = <| Username: | Password:
6235 #  server_condition        = Authentication is not yet configured
6236 #  server_advertise_condition = ${if def:tls_in_cipher }
6237 .endd
6238
6239 The &%server_set_id%& option makes Exim remember the authenticated username
6240 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6241 &%server_prompts%& option configures the &(plaintext)& authenticator so
6242 that it implements the details of the specific authentication mechanism,
6243 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6244 when Exim offers authentication to clients; in the examples, this is only
6245 when TLS or SSL has been started, so to enable the authenticators you also
6246 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6247
6248 The &%server_condition%& setting defines how to verify that the username and
6249 password are correct. In the examples it just produces an error message.
6250 To make the authenticators work, you can use a string expansion
6251 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6252
6253 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6254 usercode and password are in different positions.
6255 Chapter &<<CHAPplaintext>>& covers both.
6256
6257 .ecindex IIDconfiwal
6258
6259
6260
6261 . ////////////////////////////////////////////////////////////////////////////
6262 . ////////////////////////////////////////////////////////////////////////////
6263
6264 .chapter "Regular expressions" "CHAPregexp"
6265
6266 .cindex "regular expressions" "library"
6267 .cindex "PCRE"
6268 Exim supports the use of regular expressions in many of its options. It
6269 uses the PCRE regular expression library; this provides regular expression
6270 matching that is compatible with Perl 5. The syntax and semantics of
6271 regular expressions is discussed in
6272 .new
6273 online Perl manpages, in
6274 .wen
6275 many Perl reference books, and also in
6276 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6277 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6278
6279 The documentation for the syntax and semantics of the regular expressions that
6280 are supported by PCRE is included in the PCRE distribution, and no further
6281 description is included here. The PCRE functions are called from Exim using
6282 the default option settings (that is, with no PCRE options set), except that
6283 the PCRE_CASELESS option is set when the matching is required to be
6284 case-insensitive.
6285
6286 In most cases, when a regular expression is required in an Exim configuration,
6287 it has to start with a circumflex, in order to distinguish it from plain text
6288 or an &"ends with"& wildcard. In this example of a configuration setting, the
6289 second item in the colon-separated list is a regular expression.
6290 .code
6291 domains = a.b.c : ^\\d{3} : *.y.z : ...
6292 .endd
6293 The doubling of the backslash is required because of string expansion that
6294 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6295 of this issue, and a way of avoiding the need for doubling backslashes. The
6296 regular expression that is eventually used in this example contains just one
6297 backslash. The circumflex is included in the regular expression, and has the
6298 normal effect of &"anchoring"& it to the start of the string that is being
6299 matched.
6300
6301 There are, however, two cases where a circumflex is not required for the
6302 recognition of a regular expression: these are the &%match%& condition in a
6303 string expansion, and the &%matches%& condition in an Exim filter file. In
6304 these cases, the relevant string is always treated as a regular expression; if
6305 it does not start with a circumflex, the expression is not anchored, and can
6306 match anywhere in the subject string.
6307
6308 In all cases, if you want a regular expression to match at the end of a string,
6309 you must code the $ metacharacter to indicate this. For example:
6310 .code
6311 domains = ^\\d{3}\\.example
6312 .endd
6313 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6314 You need to use:
6315 .code
6316 domains = ^\\d{3}\\.example\$
6317 .endd
6318 if you want &'example'& to be the top-level domain. The backslash before the
6319 $ is needed because string expansion also interprets dollar characters.
6320
6321
6322
6323 . ////////////////////////////////////////////////////////////////////////////
6324 . ////////////////////////////////////////////////////////////////////////////
6325
6326 .chapter "File and database lookups" "CHAPfdlookup"
6327 .scindex IIDfidalo1 "file" "lookups"
6328 .scindex IIDfidalo2 "database" "lookups"
6329 .cindex "lookup" "description of"
6330 Exim can be configured to look up data in files or databases as it processes
6331 messages. Two different kinds of syntax are used:
6332
6333 .olist
6334 A string that is to be expanded may contain explicit lookup requests. These
6335 cause parts of the string to be replaced by data that is obtained from the
6336 lookup. Lookups of this type are conditional expansion items. Different results
6337 can be defined for the cases of lookup success and failure. See chapter
6338 &<<CHAPexpand>>&, where string expansions are described in detail.
6339 The key for the lookup is specified as part of the string expansion.
6340 .next
6341 Lists of domains, hosts, and email addresses can contain lookup requests as a
6342 way of avoiding excessively long linear lists. In this case, the data that is
6343 returned by the lookup is often (but not always) discarded; whether the lookup
6344 succeeds or fails is what really counts. These kinds of list are described in
6345 chapter &<<CHAPdomhosaddlists>>&.
6346 The key for the lookup is given by the context in which the list is expanded.
6347 .endlist
6348
6349 String expansions, lists, and lookups interact with each other in such a way
6350 that there is no order in which to describe any one of them that does not
6351 involve references to the others. Each of these three chapters makes more sense
6352 if you have read the other two first. If you are reading this for the first
6353 time, be aware that some of it will make a lot more sense after you have read
6354 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6355
6356 .section "Examples of different lookup syntax" "SECID60"
6357 It is easy to confuse the two different kinds of lookup, especially as the
6358 lists that may contain the second kind are always expanded before being
6359 processed as lists. Therefore, they may also contain lookups of the first kind.
6360 Be careful to distinguish between the following two examples:
6361 .code
6362 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6363 domains = lsearch;/some/file
6364 .endd
6365 The first uses a string expansion, the result of which must be a domain list.
6366 No strings have been specified for a successful or a failing lookup; the
6367 defaults in this case are the looked-up data and an empty string, respectively.
6368 The expansion takes place before the string is processed as a list, and the
6369 file that is searched could contain lines like this:
6370 .code
6371 192.168.3.4: domain1:domain2:...
6372 192.168.1.9: domain3:domain4:...
6373 .endd
6374 When the lookup succeeds, the result of the expansion is a list of domains (and
6375 possibly other types of item that are allowed in domain lists).
6376
6377 In the second example, the lookup is a single item in a domain list. It causes
6378 Exim to use a lookup to see if the domain that is being processed can be found
6379 in the file. The file could contains lines like this:
6380 .code
6381 domain1:
6382 domain2:
6383 .endd
6384 Any data that follows the keys is not relevant when checking that the domain
6385 matches the list item.
6386
6387 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6388 Consider a file containing lines like this:
6389 .code
6390 192.168.5.6: lsearch;/another/file
6391 .endd
6392 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6393 first &%domains%& setting above generates the second setting, which therefore
6394 causes a second lookup to occur.
6395
6396 The rest of this chapter describes the different lookup types that are
6397 available. Any of them can be used in any part of the configuration where a
6398 lookup is permitted.
6399
6400
6401 .section "Lookup types" "SECID61"
6402 .cindex "lookup" "types of"
6403 .cindex "single-key lookup" "definition of"
6404 Two different types of data lookup are implemented:
6405
6406 .ilist
6407 The &'single-key'& type requires the specification of a file in which to look,
6408 and a single key to search for. The key must be a non-empty string for the
6409 lookup to succeed. The lookup type determines how the file is searched.
6410 .next
6411 .cindex "query-style lookup" "definition of"
6412 The &'query-style'& type accepts a generalized database query. No particular
6413 key value is assumed by Exim for query-style lookups. You can use whichever
6414 Exim variables you need to construct the database query.
6415 .endlist
6416
6417 The code for each lookup type is in a separate source file that is included in
6418 the binary of Exim only if the corresponding compile-time option is set. The
6419 default settings in &_src/EDITME_& are:
6420 .code
6421 LOOKUP_DBM=yes
6422 LOOKUP_LSEARCH=yes
6423 .endd
6424 which means that only linear searching and DBM lookups are included by default.
6425 For some types of lookup (e.g. SQL databases), you need to install appropriate
6426 libraries and header files before building Exim.
6427
6428
6429
6430
6431 .section "Single-key lookup types" "SECTsinglekeylookups"
6432 .cindex "lookup" "single-key types"
6433 .cindex "single-key lookup" "list of types"
6434 The following single-key lookup types are implemented:
6435
6436 .ilist
6437 .cindex "cdb" "description of"
6438 .cindex "lookup" "cdb"
6439 .cindex "binary zero" "in lookup key"
6440 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6441 string without a terminating binary zero. The cdb format is designed for
6442 indexed files that are read frequently and never updated, except by total
6443 re-creation. As such, it is particularly suitable for large files containing
6444 aliases or other indexed data referenced by an MTA. Information about cdb can
6445 be found in several places:
6446 .display
6447 &url(http://www.pobox.com/~djb/cdb.html)
6448 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6449 &url(http://packages.debian.org/stable/utils/freecdb.html)
6450 .endd
6451 A cdb distribution is not needed in order to build Exim with cdb support,
6452 because the code for reading cdb files is included directly in Exim itself.
6453 However, no means of building or testing cdb files is provided with Exim, so
6454 you need to obtain a cdb distribution in order to do this.
6455 .next
6456 .cindex "DBM" "lookup type"
6457 .cindex "lookup" "dbm"
6458 .cindex "binary zero" "in lookup key"
6459 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6460 DBM file by looking up the record with the given key. A terminating binary
6461 zero is included in the key that is passed to the DBM library. See section
6462 &<<SECTdb>>& for a discussion of DBM libraries.
6463
6464 .cindex "Berkeley DB library" "file format"
6465 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6466 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6467 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6468 the DB_UNKNOWN option. This enables it to handle any of the types of database
6469 that the library supports, and can be useful for accessing DBM files created by
6470 other applications. (For earlier DB versions, DB_HASH is always used.)
6471 .next
6472 .cindex "lookup" "dbmjz"
6473 .cindex "lookup" "dbm &-- embedded NULs"
6474 .cindex "sasldb2"
6475 .cindex "dbmjz lookup type"
6476 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6477 interpreted as an Exim list; the elements of the list are joined together with
6478 ASCII NUL characters to form the lookup key.  An example usage would be to
6479 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6480 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6481 &(cram_md5)& authenticator.
6482 .next
6483 .cindex "lookup" "dbmnz"
6484 .cindex "lookup" "dbm &-- terminating zero"
6485 .cindex "binary zero" "in lookup key"
6486 .cindex "Courier"
6487 .cindex "&_/etc/userdbshadow.dat_&"
6488 .cindex "dbmnz lookup type"
6489 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6490 is not included in the key that is passed to the DBM library. You may need this
6491 if you want to look up data in files that are created by or shared with some
6492 other application that does not use terminating zeros. For example, you need to
6493 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6494 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6495 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6496 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6497 .next
6498 .cindex "lookup" "dsearch"
6499 .cindex "dsearch lookup type"
6500 &(dsearch)&: The given file must be a directory; this is searched for an entry
6501 whose name is the key by calling the &[lstat()]& function. The key may not
6502 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6503 the lookup is the name of the entry, which may be a file, directory,
6504 symbolic link, or any other kind of directory entry. An example of how this
6505 lookup can be used to support virtual domains is given in section
6506 &<<SECTvirtualdomains>>&.
6507 .next
6508 .cindex "lookup" "iplsearch"
6509 .cindex "iplsearch lookup type"
6510 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6511 terminated by a colon or white space or the end of the line. The keys in the
6512 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6513 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6514 being interpreted as a key terminator. For example:
6515 .code
6516 1.2.3.4:           data for 1.2.3.4
6517 192.168.0.0/16:    data for 192.168.0.0/16
6518 "abcd::cdab":      data for abcd::cdab
6519 "abcd:abcd::/32"   data for abcd:abcd::/32
6520 .endd
6521 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6522 file is searched linearly, using the CIDR masks where present, until a matching
6523 key is found. The first key that matches is used; there is no attempt to find a
6524 &"best"& match. Apart from the way the keys are matched, the processing for
6525 &(iplsearch)& is the same as for &(lsearch)&.
6526
6527 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6528 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6529 lookup types support only literal keys.
6530
6531 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6532 the implicit key is the host's IP address rather than its name (see section
6533 &<<SECThoslispatsikey>>&).
6534 .next
6535 .cindex "linear search"
6536 .cindex "lookup" "lsearch"
6537 .cindex "lsearch lookup type"
6538 .cindex "case sensitivity" "in lsearch lookup"
6539 &(lsearch)&: The given file is a text file that is searched linearly for a
6540 line beginning with the search key, terminated by a colon or white space or the
6541 end of the line. The search is case-insensitive; that is, upper and lower case
6542 letters are treated as the same. The first occurrence of the key that is found
6543 in the file is used.
6544
6545 White space between the key and the colon is permitted. The remainder of the
6546 line, with leading and trailing white space removed, is the data. This can be
6547 continued onto subsequent lines by starting them with any amount of white
6548 space, but only a single space character is included in the data at such a
6549 junction. If the data begins with a colon, the key must be terminated by a
6550 colon, for example:
6551 .code
6552 baduser:  :fail:
6553 .endd
6554 Empty lines and lines beginning with # are ignored, even if they occur in the
6555 middle of an item. This is the traditional textual format of alias files. Note
6556 that the keys in an &(lsearch)& file are literal strings. There is no
6557 wildcarding of any kind.
6558
6559 .cindex "lookup" "lsearch &-- colons in keys"
6560 .cindex "white space" "in lsearch key"
6561 In most &(lsearch)& files, keys are not required to contain colons or #
6562 characters, or white space. However, if you need this feature, it is available.
6563 If a key begins with a doublequote character, it is terminated only by a
6564 matching quote (or end of line), and the normal escaping rules apply to its
6565 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6566 quoted keys (exactly as for unquoted keys). There is no special handling of
6567 quotes for the data part of an &(lsearch)& line.
6568
6569 .next
6570 .cindex "NIS lookup type"
6571 .cindex "lookup" "NIS"
6572 .cindex "binary zero" "in lookup key"
6573 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6574 the given key, without a terminating binary zero. There is a variant called
6575 &(nis0)& which does include the terminating binary zero in the key. This is
6576 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6577 aliases; the full map names must be used.
6578
6579 .next
6580 .cindex "wildlsearch lookup type"
6581 .cindex "lookup" "wildlsearch"
6582 .cindex "nwildlsearch lookup type"
6583 .cindex "lookup" "nwildlsearch"
6584 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6585 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6586 the file may be wildcarded. The difference between these two lookup types is
6587 that for &(wildlsearch)&, each key in the file is string-expanded before being
6588 used, whereas for &(nwildlsearch)&, no expansion takes place.
6589
6590 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6591 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6592 file that are regular expressions can be made case-sensitive by the use of
6593 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6594
6595 . ==== As this is a nested list, any displays it contains must be indented
6596 . ==== as otherwise they are too far to the left.
6597
6598 .olist
6599 The string may begin with an asterisk to mean &"ends with"&. For example:
6600 .code
6601     *.a.b.c       data for anything.a.b.c
6602     *fish         data for anythingfish
6603 .endd
6604 .next
6605 The string may begin with a circumflex to indicate a regular expression. For
6606 example, for &(wildlsearch)&:
6607 .code
6608     ^\N\d+\.a\.b\N    data for <digits>.a.b
6609 .endd
6610 Note the use of &`\N`& to disable expansion of the contents of the regular
6611 expression. If you are using &(nwildlsearch)&, where the keys are not
6612 string-expanded, the equivalent entry is:
6613 .code
6614     ^\d+\.a\.b        data for <digits>.a.b
6615 .endd
6616 The case-insensitive flag is set at the start of compiling the regular
6617 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6618 For example, to make the entire pattern case-sensitive:
6619 .code
6620     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6621 .endd
6622
6623 If the regular expression contains white space or colon characters, you must
6624 either quote it (see &(lsearch)& above), or represent these characters in other
6625 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6626 colon. This may be easier than quoting, because if you quote, you have to
6627 escape all the backslashes inside the quotes.
6628
6629 &*Note*&: It is not possible to capture substrings in a regular expression
6630 match for later use, because the results of all lookups are cached. If a lookup
6631 is repeated, the result is taken from the cache, and no actual pattern matching
6632 takes place. The values of all the numeric variables are unset after a
6633 &((n)wildlsearch)& match.
6634
6635 .next
6636 Although I cannot see it being of much use, the general matching function that
6637 is used to implement &((n)wildlsearch)& means that the string may begin with a
6638 lookup name terminated by a semicolon, and followed by lookup data. For
6639 example:
6640 .code
6641     cdb;/some/file  data for keys that match the file
6642 .endd
6643 The data that is obtained from the nested lookup is discarded.
6644 .endlist olist
6645
6646 Keys that do not match any of these patterns are interpreted literally. The
6647 continuation rules for the data are the same as for &(lsearch)&, and keys may
6648 be followed by optional colons.
6649
6650 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6651 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6652 lookup types support only literal keys.
6653 .endlist ilist
6654
6655
6656 .section "Query-style lookup types" "SECTquerystylelookups"
6657 .cindex "lookup" "query-style types"
6658 .cindex "query-style lookup" "list of types"
6659 The supported query-style lookup types are listed below. Further details about
6660 many of them are given in later sections.
6661
6662 .ilist
6663 .cindex "DNS" "as a lookup type"
6664 .cindex "lookup" "DNS"
6665 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6666 are given in the supplied query. The resulting data is the contents of the
6667 records. See section &<<SECTdnsdb>>&.
6668 .next
6669 .cindex "InterBase lookup type"
6670 .cindex "lookup" "InterBase"
6671 &(ibase)&: This does a lookup in an InterBase database.
6672 .next
6673 .cindex "LDAP" "lookup type"
6674 .cindex "lookup" "LDAP"
6675 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6676 returns attributes from a single entry. There is a variant called &(ldapm)&
6677 that permits values from multiple entries to be returned. A third variant
6678 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6679 any attribute values. See section &<<SECTldap>>&.
6680 .next
6681 .cindex "MySQL" "lookup type"
6682 .cindex "lookup" "MySQL"
6683 &(mysql)&: The format of the query is an SQL statement that is passed to a
6684 MySQL database. See section &<<SECTsql>>&.
6685 .next
6686 .cindex "NIS+ lookup type"
6687 .cindex "lookup" "NIS+"
6688 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6689 the field to be returned. See section &<<SECTnisplus>>&.
6690 .next
6691 .cindex "Oracle" "lookup type"
6692 .cindex "lookup" "Oracle"
6693 &(oracle)&: The format of the query is an SQL statement that is passed to an
6694 Oracle database. See section &<<SECTsql>>&.
6695 .next
6696 .cindex "lookup" "passwd"
6697 .cindex "passwd lookup type"
6698 .cindex "&_/etc/passwd_&"
6699 &(passwd)& is a query-style lookup with queries that are just user names. The
6700 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6701 success, the result string is the same as you would get from an &(lsearch)&
6702 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6703 password value. For example:
6704 .code
6705 *:42:42:King Rat:/home/kr:/bin/bash
6706 .endd
6707 .next
6708 .cindex "PostgreSQL lookup type"
6709 .cindex "lookup" "PostgreSQL"
6710 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6711 PostgreSQL database. See section &<<SECTsql>>&.
6712
6713 .next
6714 .cindex "Redis lookup type"
6715 .cindex lookup Redis
6716 &(redis)&: The format of the query is an SQL statement that is passed to a
6717 Redis database. See section &<<SECTsql>>&.
6718
6719 .next
6720 .cindex "sqlite lookup type"
6721 .cindex "lookup" "sqlite"
6722 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6723 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6724
6725 .next
6726 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6727 not likely to be useful in normal operation.
6728 .next
6729 .cindex "whoson lookup type"
6730 .cindex "lookup" "whoson"
6731 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6732 allows a server to check whether a particular (dynamically allocated) IP
6733 address is currently allocated to a known (trusted) user and, optionally, to
6734 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6735 at one time for &"POP before SMTP"& authentication, but that approach has been
6736 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6737 &"POP before SMTP"& checking using ACL statements such as
6738 .code
6739 require condition = \
6740   ${lookup whoson {$sender_host_address}{yes}{no}}
6741 .endd
6742 The query consists of a single IP address. The value returned is the name of
6743 the authenticated user, which is stored in the variable &$value$&. However, in
6744 this example, the data in &$value$& is not used; the result of the lookup is
6745 one of the fixed strings &"yes"& or &"no"&.
6746 .endlist
6747
6748
6749
6750 .section "Temporary errors in lookups" "SECID63"
6751 .cindex "lookup" "temporary error in"
6752 Lookup functions can return temporary error codes if the lookup cannot be
6753 completed. For example, an SQL or LDAP database might be unavailable. For this
6754 reason, it is not advisable to use a lookup that might do this for critical
6755 options such as a list of local domains.
6756
6757 When a lookup cannot be completed in a router or transport, delivery
6758 of the message (to the relevant address) is deferred, as for any other
6759 temporary error. In other circumstances Exim may assume the lookup has failed,
6760 or may give up altogether.
6761
6762
6763
6764 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6765 .cindex "wildcard lookups"
6766 .cindex "lookup" "default values"
6767 .cindex "lookup" "wildcard"
6768 .cindex "lookup" "* added to type"
6769 .cindex "default" "in single-key lookups"
6770 In this context, a &"default value"& is a value specified by the administrator
6771 that is to be used if a lookup fails.
6772
6773 &*Note:*& This section applies only to single-key lookups. For query-style
6774 lookups, the facilities of the query language must be used. An attempt to
6775 specify a default for a query-style lookup provokes an error.
6776
6777 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6778 and the initial lookup fails, the key &"*"& is looked up in the file to
6779 provide a default value. See also the section on partial matching below.
6780
6781 .cindex "*@ with single-key lookup"
6782 .cindex "lookup" "*@ added to type"
6783 .cindex "alias file" "per-domain default"
6784 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6785 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6786 character, a second lookup is done with everything before the last @ replaced
6787 by *. This makes it possible to provide per-domain defaults in alias files
6788 that include the domains in the keys. If the second lookup fails (or doesn't
6789 take place because there is no @ in the key), &"*"& is looked up.
6790 For example, a &(redirect)& router might contain:
6791 .code
6792 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6793 .endd
6794 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6795 looks up these keys, in this order:
6796 .code
6797 jane@eyre.example
6798 *@eyre.example
6799 *
6800 .endd
6801 The data is taken from whichever key it finds first. &*Note*&: In an
6802 &(lsearch)& file, this does not mean the first of these keys in the file. A
6803 complete scan is done for each key, and only if it is not found at all does
6804 Exim move on to try the next key.
6805
6806
6807
6808 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6809 .cindex "partial matching"
6810 .cindex "wildcard lookups"
6811 .cindex "lookup" "partial matching"
6812 .cindex "lookup" "wildcard"
6813 .cindex "asterisk" "in search type"
6814 The normal operation of a single-key lookup is to search the file for an exact
6815 match with the given key. However, in a number of situations where domains are
6816 being looked up, it is useful to be able to do partial matching. In this case,
6817 information in the file that has a key starting with &"*."& is matched by any
6818 domain that ends with the components that follow the full stop. For example, if
6819 a key in a DBM file is
6820 .code
6821 *.dates.fict.example
6822 .endd
6823 then when partial matching is enabled this is matched by (amongst others)
6824 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6825 by &'dates.fict.example'&, if that does not appear as a separate key in the
6826 file.
6827
6828 &*Note*&: Partial matching is not available for query-style lookups. It is
6829 also not available for any lookup items in address lists (see section
6830 &<<SECTaddresslist>>&).
6831
6832 Partial matching is implemented by doing a series of separate lookups using
6833 keys constructed by modifying the original subject key. This means that it can
6834 be used with any of the single-key lookup types, provided that
6835 partial matching keys
6836 beginning with a special prefix (default &"*."&) are included in the data file.
6837 Keys in the file that do not begin with the prefix are matched only by
6838 unmodified subject keys when partial matching is in use.
6839
6840 Partial matching is requested by adding the string &"partial-"& to the front of
6841 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6842 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6843 is added at the start of the subject key, and it is looked up again. If that
6844 fails, further lookups are tried with dot-separated components removed from the
6845 start of the subject key, one-by-one, and &"*."& added on the front of what
6846 remains.
6847
6848 A minimum number of two non-* components are required. This can be adjusted
6849 by including a number before the hyphen in the search type. For example,
6850 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6851 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6852 subject key is &'2250.dates.fict.example'& then the following keys are looked
6853 up when the minimum number of non-* components is two:
6854 .code
6855 2250.dates.fict.example
6856 *.2250.dates.fict.example
6857 *.dates.fict.example
6858 *.fict.example
6859 .endd
6860 As soon as one key in the sequence is successfully looked up, the lookup
6861 finishes.
6862
6863 .cindex "lookup" "partial matching &-- changing prefix"
6864 .cindex "prefix" "for partial matching"
6865 The use of &"*."& as the partial matching prefix is a default that can be
6866 changed. The motivation for this feature is to allow Exim to operate with file
6867 formats that are used by other MTAs. A different prefix can be supplied in
6868 parentheses instead of the hyphen after &"partial"&. For example:
6869 .code
6870 domains = partial(.)lsearch;/some/file
6871 .endd
6872 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6873 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6874 components is unchanged). The prefix may consist of any punctuation characters
6875 other than a closing parenthesis. It may be empty, for example:
6876 .code
6877 domains = partial1()cdb;/some/file
6878 .endd
6879 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6880 &`a.b.c`&, &`b.c`&, and &`c`&.
6881
6882 If &"partial0"& is specified, what happens at the end (when the lookup with
6883 just one non-wild component has failed, and the original key is shortened right
6884 down to the null string) depends on the prefix:
6885
6886 .ilist
6887 If the prefix has zero length, the whole lookup fails.
6888 .next
6889 If the prefix has length 1, a lookup for just the prefix is done. For
6890 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6891 .next
6892 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6893 remainder is looked up. With the default prefix, therefore, the final lookup is
6894 for &"*"& on its own.
6895 .next
6896 Otherwise, the whole prefix is looked up.
6897 .endlist
6898
6899
6900 If the search type ends in &"*"& or &"*@"& (see section
6901 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6902 this implies happens after all partial lookups have failed. If &"partial0"& is
6903 specified, adding &"*"& to the search type has no effect with the default
6904 prefix, because the &"*"& key is already included in the sequence of partial
6905 lookups. However, there might be a use for lookup types such as
6906 &"partial0(.)lsearch*"&.
6907
6908 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6909 in domain lists and the like. Partial matching works only in terms of
6910 dot-separated components; a key such as &`*fict.example`&
6911 in a database file is useless, because the asterisk in a partial matching
6912 subject key is always followed by a dot.
6913
6914
6915
6916
6917 .section "Lookup caching" "SECID64"
6918 .cindex "lookup" "caching"
6919 .cindex "caching" "lookup data"
6920 Exim caches all lookup results in order to avoid needless repetition of
6921 lookups. However, because (apart from the daemon) Exim operates as a collection
6922 of independent, short-lived processes, this caching applies only within a
6923 single Exim process. There is no inter-process lookup caching facility.
6924
6925 For single-key lookups, Exim keeps the relevant files open in case there is
6926 another lookup that needs them. In some types of configuration this can lead to
6927 many files being kept open for messages with many recipients. To avoid hitting
6928 the operating system limit on the number of simultaneously open files, Exim
6929 closes the least recently used file when it needs to open more files than its
6930 own internal limit, which can be changed via the &%lookup_open_max%& option.
6931
6932 The single-key lookup files are closed and the lookup caches are flushed at
6933 strategic points during delivery &-- for example, after all routing is
6934 complete.
6935
6936
6937
6938
6939 .section "Quoting lookup data" "SECID65"
6940 .cindex "lookup" "quoting"
6941 .cindex "quoting" "in lookups"
6942 When data from an incoming message is included in a query-style lookup, there
6943 is the possibility of special characters in the data messing up the syntax of
6944 the query. For example, a NIS+ query that contains
6945 .code
6946 [name=$local_part]
6947 .endd
6948 will be broken if the local part happens to contain a closing square bracket.
6949 For NIS+, data can be enclosed in double quotes like this:
6950 .code
6951 [name="$local_part"]
6952 .endd
6953 but this still leaves the problem of a double quote in the data. The rule for
6954 NIS+ is that double quotes must be doubled. Other lookup types have different
6955 rules, and to cope with the differing requirements, an expansion operator
6956 of the following form is provided:
6957 .code
6958 ${quote_<lookup-type>:<string>}
6959 .endd
6960 For example, the safest way to write the NIS+ query is
6961 .code
6962 [name="${quote_nisplus:$local_part}"]
6963 .endd
6964 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6965 operator can be used for all lookup types, but has no effect for single-key
6966 lookups, since no quoting is ever needed in their key strings.
6967
6968
6969
6970
6971 .section "More about dnsdb" "SECTdnsdb"
6972 .cindex "dnsdb lookup"
6973 .cindex "lookup" "dnsdb"
6974 .cindex "DNS" "as a lookup type"
6975 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6976 of a record type and a domain name, separated by an equals sign. For example,
6977 an expansion string could contain:
6978 .code
6979 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6980 .endd
6981 If the lookup succeeds, the result is placed in &$value$&, which in this case
6982 is used on its own as the result. If the lookup does not succeed, the
6983 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6984 &<<SECTforexpfai>>& for an explanation of what this means.
6985
6986 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6987 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6988 If no type is given, TXT is assumed.
6989
6990 For any record type, if multiple records are found, the data is returned as a
6991 concatenation, with newline as the default separator. The order, of course,
6992 depends on the DNS resolver. You can specify a different separator character
6993 between multiple records by putting a right angle-bracket followed immediately
6994 by the new separator at the start of the query. For example:
6995 .code
6996 ${lookup dnsdb{>: a=host1.example}}
6997 .endd
6998 It is permitted to specify a space as the separator character. Further
6999 white space is ignored.
7000 For lookup types that return multiple fields per record,
7001 an alternate field separator can be specified using a comma after the main
7002 separator character, followed immediately by the field separator.
7003
7004 .cindex "PTR record" "in &(dnsdb)& lookup"
7005 When the type is PTR,
7006 the data can be an IP address, written as normal; inversion and the addition of
7007 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7008 .code
7009 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7010 .endd
7011 If the data for a PTR record is not a syntactically valid IP address, it is not
7012 altered and nothing is added.
7013
7014 .cindex "MX record" "in &(dnsdb)& lookup"
7015 .cindex "SRV record" "in &(dnsdb)& lookup"
7016 For an MX lookup, both the preference value and the host name are returned for
7017 each record, separated by a space. For an SRV lookup, the priority, weight,
7018 port, and host name are returned for each record, separated by spaces.
7019 The field separator can be modified as above.
7020
7021 .cindex "TXT record" "in &(dnsdb)& lookup"
7022 .cindex "SPF record" "in &(dnsdb)& lookup"
7023 For TXT records with multiple items of data, only the first item is returned,
7024 unless a field separator is specified.
7025 To concatenate items without a separator, use a semicolon instead.
7026 For SPF records the
7027 default behaviour is to concatenate multiple items without using a separator.
7028 .code
7029 ${lookup dnsdb{>\n,: txt=a.b.example}}
7030 ${lookup dnsdb{>\n; txt=a.b.example}}
7031 ${lookup dnsdb{spf=example.org}}
7032 .endd
7033 It is permitted to specify a space as the separator character. Further
7034 white space is ignored.
7035
7036 .cindex "SOA record" "in &(dnsdb)& lookup"
7037 For an SOA lookup, while no result is obtained the lookup is redone with
7038 successively more leading components dropped from the given domain.
7039 Only the primary-nameserver field is returned unless a field separator is
7040 specified.
7041 .code
7042 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7043 .endd
7044
7045 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7046 .cindex "dnsdb modifiers"
7047 .cindex "modifiers" "dnsdb"
7048 .cindex "options" "dnsdb"
7049 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7050 each followed by a comma,
7051 that may appear before the record type.
7052
7053 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7054 temporary DNS error for any of them, the behaviour is controlled by
7055 a defer-option modifier.
7056 The possible keywords are
7057 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7058 With &"strict"& behaviour, any temporary DNS error causes the
7059 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7060 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7061 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7062 error causes the whole lookup to defer only if none of the other lookups
7063 succeed. The default is &"lax"&, so the following lookups are equivalent:
7064 .code
7065 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7066 ${lookup dnsdb{a=one.host.com:two.host.com}}
7067 .endd
7068 Thus, in the default case, as long as at least one of the DNS lookups
7069 yields some data, the lookup succeeds.
7070
7071 .cindex "DNSSEC" "dns lookup"
7072 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7073 The possible keywords are
7074 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7075 With &"strict"& or &"lax"& DNSSEC information is requested
7076 with the lookup.
7077 With &"strict"& a response from the DNS resolver that
7078 is not labelled as authenticated data
7079 is treated as equivalent to a temporary DNS error.
7080 The default is &"never"&.
7081
7082 See also the &$lookup_dnssec_authenticated$& variable.
7083
7084 .cindex timeout "dns lookup"
7085 .cindex "DNS" timeout
7086 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7087 The form is &"retrans_VAL"& where VAL is an Exim time specification
7088 (e.g. &"5s"&).
7089 The default value is set by the main configuration option &%dns_retrans%&.
7090
7091 Retries for the dnsdb lookup can be controlled by a retry modifier.
7092 The form if &"retry_VAL"& where VAL is an integer.
7093 The default count is set by the main configuration option &%dns_retry%&.
7094
7095 .cindex cacheing "of dns lookup"
7096 .cindex TTL "of dns lookup"
7097 .cindex DNS TTL
7098 Dnsdb lookup results are cached within a single process (and its children).
7099 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7100 value of the set of returned DNS records.
7101
7102
7103 .section "Pseudo dnsdb record types" "SECID66"
7104 .cindex "MX record" "in &(dnsdb)& lookup"
7105 By default, both the preference value and the host name are returned for
7106 each MX record, separated by a space. If you want only host names, you can use
7107 the pseudo-type MXH:
7108 .code
7109 ${lookup dnsdb{mxh=a.b.example}}
7110 .endd
7111 In this case, the preference values are omitted, and just the host names are
7112 returned.
7113
7114 .cindex "name server for enclosing domain"
7115 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7116 records on the given domain, but if none are found, it removes the first
7117 component of the domain name, and tries again. This process continues until NS
7118 records are found or there are no more components left (or there is a DNS
7119 error). In other words, it may return the name servers for a top-level domain,
7120 but it never returns the root name servers. If there are no NS records for the
7121 top-level domain, the lookup fails. Consider these examples:
7122 .code
7123 ${lookup dnsdb{zns=xxx.quercite.com}}
7124 ${lookup dnsdb{zns=xxx.edu}}
7125 .endd
7126 Assuming that in each case there are no NS records for the full domain name,
7127 the first returns the name servers for &%quercite.com%&, and the second returns
7128 the name servers for &%edu%&.
7129
7130 You should be careful about how you use this lookup because, unless the
7131 top-level domain does not exist, the lookup always returns some host names. The
7132 sort of use to which this might be put is for seeing if the name servers for a
7133 given domain are on a blacklist. You can probably assume that the name servers
7134 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7135 such a list.
7136
7137 .cindex "CSA" "in &(dnsdb)& lookup"
7138 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7139 records according to the CSA rules, which are described in section
7140 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7141 not sufficient because of the extra parent domain search behaviour of CSA. The
7142 result of a successful lookup such as:
7143 .code
7144 ${lookup dnsdb {csa=$sender_helo_name}}
7145 .endd
7146 has two space-separated fields: an authorization code and a target host name.
7147 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7148 authorization required but absent, or &"?"& for unknown.
7149
7150 .cindex "A+" "in &(dnsdb)& lookup"
7151 The pseudo-type A+ performs an AAAA
7152 and then an A lookup.  All results are returned; defer processing
7153 (see below) is handled separately for each lookup.  Example:
7154 .code
7155 ${lookup dnsdb {>; a+=$sender_helo_name}}
7156 .endd
7157
7158
7159 .section "Multiple dnsdb lookups" "SECID67"
7160 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7161 However, you can specify a list of domains or IP addresses in a single
7162 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7163 the default separator, but with the ability to change this. For example:
7164 .code
7165 ${lookup dnsdb{one.domain.com:two.domain.com}}
7166 ${lookup dnsdb{a=one.host.com:two.host.com}}
7167 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7168 .endd
7169 In order to retain backwards compatibility, there is one special case: if
7170 the lookup type is PTR and no change of separator is specified, Exim looks
7171 to see if the rest of the string is precisely one IPv6 address. In this
7172 case, it does not treat it as a list.
7173
7174 The data from each lookup is concatenated, with newline separators by default,
7175 in the same way that multiple DNS records for a single item are handled. A
7176 different separator can be specified, as described above.
7177
7178
7179
7180
7181 .section "More about LDAP" "SECTldap"
7182 .cindex "LDAP" "lookup, more about"
7183 .cindex "lookup" "LDAP"
7184 .cindex "Solaris" "LDAP"
7185 The original LDAP implementation came from the University of Michigan; this has
7186 become &"Open LDAP"&, and there are now two different releases. Another
7187 implementation comes from Netscape, and Solaris 7 and subsequent releases
7188 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7189 the lookup function level, their error handling is different. For this reason
7190 it is necessary to set a compile-time variable when building Exim with LDAP, to
7191 indicate which LDAP library is in use. One of the following should appear in
7192 your &_Local/Makefile_&:
7193 .code
7194 LDAP_LIB_TYPE=UMICHIGAN
7195 LDAP_LIB_TYPE=OPENLDAP1
7196 LDAP_LIB_TYPE=OPENLDAP2
7197 LDAP_LIB_TYPE=NETSCAPE
7198 LDAP_LIB_TYPE=SOLARIS
7199 .endd
7200 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7201 same interface as the University of Michigan version.
7202
7203 There are three LDAP lookup types in Exim. These behave slightly differently in
7204 the way they handle the results of a query:
7205
7206 .ilist
7207 &(ldap)& requires the result to contain just one entry; if there are more, it
7208 gives an error.
7209 .next
7210 &(ldapdn)& also requires the result to contain just one entry, but it is the
7211 Distinguished Name that is returned rather than any attribute values.
7212 .next
7213 &(ldapm)& permits the result to contain more than one entry; the attributes
7214 from all of them are returned.
7215 .endlist
7216
7217
7218 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7219 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7220 the data returned by a successful lookup is described in the next section.
7221 First we explain how LDAP queries are coded.
7222
7223
7224 .section "Format of LDAP queries" "SECTforldaque"
7225 .cindex "LDAP" "query format"
7226 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7227 the configuration of a &(redirect)& router one might have this setting:
7228 .code
7229 data = ${lookup ldap \
7230   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7231   c=UK?mailbox?base?}}
7232 .endd
7233 .cindex "LDAP" "with TLS"
7234 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7235 secure (encrypted) LDAP connections. The second of these ensures that an
7236 encrypted TLS connection is used.
7237
7238 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7239 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7240 See the &%ldap_start_tls%& option.
7241
7242 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7243 controlled. Every part of the TLS configuration can be configured by settings in
7244 &_exim.conf_&. Depending on the version of the client libraries installed on
7245 your system, some of the initialization may have required setting options in
7246 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7247 certificates. This revealed a nuance where the current UID that exim was
7248 running as could affect which config files it read. With Exim 4.83, these
7249 methods become optional, only taking effect if not specifically set in
7250 &_exim.conf_&.
7251
7252
7253 .section "LDAP quoting" "SECID68"
7254 .cindex "LDAP" "quoting"
7255 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7256 and the second because the LDAP query is represented as a URL. Furthermore,
7257 within an LDAP query, two different kinds of quoting are required. For this
7258 reason, there are two different LDAP-specific quoting operators.
7259
7260 The &%quote_ldap%& operator is designed for use on strings that are part of
7261 filter specifications. Conceptually, it first does the following conversions on
7262 the string:
7263 .code
7264 *   =>   \2A
7265 (   =>   \28
7266 )   =>   \29
7267 \   =>   \5C
7268 .endd
7269 in accordance with RFC 2254. The resulting string is then quoted according
7270 to the rules for URLs, that is, all non-alphanumeric characters except
7271 .code
7272 ! $ ' - . _ ( ) * +
7273 .endd
7274 are converted to their hex values, preceded by a percent sign. For example:
7275 .code
7276 ${quote_ldap: a(bc)*, a<yz>; }
7277 .endd
7278 yields
7279 .code
7280 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7281 .endd
7282 Removing the URL quoting, this is (with a leading and a trailing space):
7283 .code
7284 a\28bc\29\2A, a<yz>;
7285 .endd
7286 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7287 base DN specifications in queries. Conceptually, it first converts the string
7288 by inserting a backslash in front of any of the following characters:
7289 .code
7290 , + " \ < > ;
7291 .endd
7292 It also inserts a backslash before any leading spaces or # characters, and
7293 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7294 is then quoted according to the rules for URLs. For example:
7295 .code
7296 ${quote_ldap_dn: a(bc)*, a<yz>; }
7297 .endd
7298 yields
7299 .code
7300 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7301 .endd
7302 Removing the URL quoting, this is (with a trailing space):
7303 .code
7304 \ a(bc)*\, a\<yz\>\;\
7305 .endd
7306 There are some further comments about quoting in the section on LDAP
7307 authentication below.
7308
7309
7310 .section "LDAP connections" "SECID69"
7311 .cindex "LDAP" "connections"
7312 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7313 is in use, via a Unix domain socket. The example given above does not specify
7314 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7315 by starting it with
7316 .code
7317 ldap://<hostname>:<port>/...
7318 .endd
7319 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7320 used. When no server is specified in a query, a list of default servers is
7321 taken from the &%ldap_default_servers%& configuration option. This supplies a
7322 colon-separated list of servers which are tried in turn until one successfully
7323 handles a query, or there is a serious error. Successful handling either
7324 returns the requested data, or indicates that it does not exist. Serious errors
7325 are syntactical, or multiple values when only a single value is expected.
7326 Errors which cause the next server to be tried are connection failures, bind
7327 failures, and timeouts.
7328
7329 For each server name in the list, a port number can be given. The standard way
7330 of specifying a host and port is to use a colon separator (RFC 1738). Because
7331 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7332 doubled. For example
7333 .code
7334 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7335 .endd
7336 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7337 to the LDAP library with no server name, and the library's default (normally
7338 the local host) is used.
7339
7340 If you are using the OpenLDAP library, you can connect to an LDAP server using
7341 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7342 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7343 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7344 not available.
7345
7346 For this type of connection, instead of a host name for the server, a pathname
7347 for the socket is required, and the port number is not relevant. The pathname
7348 can be specified either as an item in &%ldap_default_servers%&, or inline in
7349 the query. In the former case, you can have settings such as
7350 .code
7351 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7352 .endd
7353 When the pathname is given in the query, you have to escape the slashes as
7354 &`%2F`& to fit in with the LDAP URL syntax. For example:
7355 .code
7356 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7357 .endd
7358 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7359 a pathname, it uses the Unix domain socket code, even if the query actually
7360 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7361 socket connection. This behaviour means that you can use a setting of
7362 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7363 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7364 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7365 backup host.
7366
7367 If an explicit &`ldapi`& type is given in a query when a host name is
7368 specified, an error is diagnosed. However, if there are more items in
7369 &%ldap_default_servers%&, they are tried. In other words:
7370
7371 .ilist
7372 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7373 interface.
7374 .next
7375 Using &`ldapi`& with a host name causes an error.
7376 .endlist
7377
7378
7379 Using &`ldapi`& with no host or path in the query, and no setting of
7380 &%ldap_default_servers%&, does whatever the library does by default.
7381
7382
7383
7384 .section "LDAP authentication and control information" "SECID70"
7385 .cindex "LDAP" "authentication"
7386 The LDAP URL syntax provides no way of passing authentication and other control
7387 information to the server. To make this possible, the URL in an LDAP query may
7388 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7389 spaces. If a value contains spaces it must be enclosed in double quotes, and
7390 when double quotes are used, backslash is interpreted in the usual way inside
7391 them. The following names are recognized:
7392 .display
7393 &`DEREFERENCE`&  set the dereferencing parameter
7394 &`NETTIME    `&  set a timeout for a network operation
7395 &`USER       `&  set the DN, for authenticating the LDAP bind
7396 &`PASS       `&  set the password, likewise
7397 &`REFERRALS  `&  set the referrals parameter
7398 &`SERVERS    `&  set alternate server list for this query only
7399 &`SIZE       `&  set the limit for the number of entries returned
7400 &`TIME       `&  set the maximum waiting time for a query
7401 .endd
7402 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7403 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7404 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7405 library from trying to follow referrals issued by the LDAP server.
7406
7407 .cindex LDAP timeout
7408 .cindex timeout "LDAP lookup"
7409 The name CONNECT is an obsolete name for NETTIME, retained for
7410 backwards compatibility. This timeout (specified as a number of seconds) is
7411 enforced from the client end for operations that can be carried out over a
7412 network. Specifically, it applies to network connections and calls to the
7413 &'ldap_result()'& function. If the value is greater than zero, it is used if
7414 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7415 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7416 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7417 Netscape SDK; for OpenLDAP no action is taken.
7418
7419 The TIME parameter (also a number of seconds) is passed to the server to
7420 set a server-side limit on the time taken to complete a search.
7421
7422 The SERVERS parameter allows you to specify an alternate list of ldap servers
7423 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7424 default list of ldap servers, and a single lookup can specify a single ldap
7425 server to use.  But when you need to do a lookup with a list of servers that is
7426 different than the default list (maybe different order, maybe a completely
7427 different set of servers), the SERVERS parameter allows you to specify this
7428 alternate list (colon-separated).
7429
7430 Here is an example of an LDAP query in an Exim lookup that uses some of these
7431 values. This is a single line, folded to fit on the page:
7432 .code
7433 ${lookup ldap
7434   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7435   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7436   {$value}fail}
7437 .endd
7438 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7439 any of the auxiliary data. Exim configuration settings that include lookups
7440 which contain password information should be preceded by &"hide"& to prevent
7441 non-admin users from using the &%-bP%& option to see their values.
7442
7443 The auxiliary data items may be given in any order. The default is no
7444 connection timeout (the system timeout is used), no user or password, no limit
7445 on the number of entries returned, and no time limit on queries.
7446
7447 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7448 removes any URL quoting that it may contain before passing it LDAP. Apparently
7449 some libraries do this for themselves, but some do not. Removing the URL
7450 quoting has two advantages:
7451
7452 .ilist
7453 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7454 DNs as with DNs inside actual queries.
7455 .next
7456 It permits spaces inside USER= DNs.
7457 .endlist
7458
7459 For example, a setting such as
7460 .code
7461 USER=cn=${quote_ldap_dn:$1}
7462 .endd
7463 should work even if &$1$& contains spaces.
7464
7465 Expanded data for the PASS= value should be quoted using the &%quote%&
7466 expansion operator, rather than the LDAP quote operators. The only reason this
7467 field needs quoting is to ensure that it conforms to the Exim syntax, which
7468 does not allow unquoted spaces. For example:
7469 .code
7470 PASS=${quote:$3}
7471 .endd
7472 The LDAP authentication mechanism can be used to check passwords as part of
7473 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7474 &<<CHAPexpand>>&.
7475
7476
7477
7478 .section "Format of data returned by LDAP" "SECID71"
7479 .cindex "LDAP" "returned data formats"
7480 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7481 as a sequence of values, for example
7482 .code
7483 cn=manager,o=University of Cambridge,c=UK
7484 .endd
7485 The &(ldap)& lookup type generates an error if more than one entry matches the
7486 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7487 the result between the data from different entries. It is possible for multiple
7488 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7489 you know that whatever values are returned all came from a single entry in the
7490 directory.
7491
7492 In the common case where you specify a single attribute in your LDAP query, the
7493 result is not quoted, and does not contain the attribute name. If the attribute
7494 has multiple values, they are separated by commas. Any comma that is
7495 part of an attribute's value is doubled.
7496
7497 If you specify multiple attributes, the result contains space-separated, quoted
7498 strings, each preceded by the attribute name and an equals sign. Within the
7499 quotes, the quote character, backslash, and newline are escaped with
7500 backslashes, and commas are used to separate multiple values for the attribute.
7501 Any commas in attribute values are doubled
7502 (permitting treatment of the values as a comma-separated list).
7503 Apart from the escaping, the string within quotes takes the same form as the
7504 output when a single attribute is requested. Specifying no attributes is the
7505 same as specifying all of an entry's attributes.
7506
7507 Here are some examples of the output format. The first line of each pair is an
7508 LDAP query, and the second is the data that is returned. The attribute called
7509 &%attr1%& has two values, one of them with an embedded comma, whereas
7510 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7511 (they have SUP &%attr%& in their schema definitions).
7512
7513 .code
7514 ldap:///o=base?attr1?sub?(uid=fred)
7515 value1.1,value1,,2
7516
7517 ldap:///o=base?attr2?sub?(uid=fred)
7518 value two
7519
7520 ldap:///o=base?attr?sub?(uid=fred)
7521 value1.1,value1,,2,value two
7522
7523 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7524 attr1="value1.1,value1,,2" attr2="value two"
7525
7526 ldap:///o=base??sub?(uid=fred)
7527 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7528 .endd
7529 You can
7530 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7531 results of LDAP lookups.
7532 The &%extract%& operator in string expansions can be used to pick out
7533 individual fields from data that consists of &'key'&=&'value'& pairs.
7534 The &%listextract%& operator should be used to pick out individual values
7535 of attributes, even when only a single value is expected.
7536 The doubling of embedded commas allows you to use the returned data as a
7537 comma separated list (using the "<," syntax for changing the input list separator).
7538
7539
7540
7541
7542 .section "More about NIS+" "SECTnisplus"
7543 .cindex "NIS+ lookup type"
7544 .cindex "lookup" "NIS+"
7545 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7546 and field name. If this is given, the result of a successful query is the
7547 contents of the named field; otherwise the result consists of a concatenation
7548 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7549 values containing spaces are quoted. For example, the query
7550 .code
7551 [name=mg1456],passwd.org_dir
7552 .endd
7553 might return the string
7554 .code
7555 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7556 home=/home/mg1456 shell=/bin/bash shadow=""
7557 .endd
7558 (split over two lines here to fit on the page), whereas
7559 .code
7560 [name=mg1456],passwd.org_dir:gcos
7561 .endd
7562 would just return
7563 .code
7564 Martin Guerre
7565 .endd
7566 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7567 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7568 operator is to double any quote characters within the text.
7569
7570
7571
7572 .section "SQL lookups" "SECTsql"
7573 .cindex "SQL lookup types"
7574 .cindex "MySQL" "lookup type"
7575 .cindex "PostgreSQL lookup type"
7576 .cindex "lookup" "MySQL"
7577 .cindex "lookup" "PostgreSQL"
7578 .cindex "Oracle" "lookup type"
7579 .cindex "lookup" "Oracle"
7580 .cindex "InterBase lookup type"
7581 .cindex "lookup" "InterBase"
7582 .cindex "Redis lookup type"
7583 .cindex lookup Redis
7584 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7585 and SQLite
7586 databases. Queries for these databases contain SQL statements, so an example
7587 might be
7588 .code
7589 ${lookup mysql{select mailbox from users where id='userx'}\
7590   {$value}fail}
7591 .endd
7592 If the result of the query contains more than one field, the data for each
7593 field in the row is returned, preceded by its name, so the result of
7594 .code
7595 ${lookup pgsql{select home,name from users where id='userx'}\
7596   {$value}}
7597 .endd
7598 might be
7599 .code
7600 home=/home/userx name="Mister X"
7601 .endd
7602 Empty values and values containing spaces are double quoted, with embedded
7603 quotes escaped by a backslash. If the result of the query contains just one
7604 field, the value is passed back verbatim, without a field name, for example:
7605 .code
7606 Mister X
7607 .endd
7608 If the result of the query yields more than one row, it is all concatenated,
7609 with a newline between the data for each row.
7610
7611
7612 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7613 .cindex "MySQL" "lookup type"
7614 .cindex "PostgreSQL lookup type"
7615 .cindex "lookup" "MySQL"
7616 .cindex "lookup" "PostgreSQL"
7617 .cindex "Oracle" "lookup type"
7618 .cindex "lookup" "Oracle"
7619 .cindex "InterBase lookup type"
7620 .cindex "lookup" "InterBase"
7621 .cindex "Redis lookup type"
7622 .cindex lookup Redis
7623 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7624 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7625 or &%redis_servers%&
7626 option (as appropriate) must be set to a colon-separated list of server
7627 information.
7628 (For MySQL and PostgreSQL, the global option need not be set if all
7629 queries contain their own server information &-- see section
7630 &<<SECTspeserque>>&.)
7631 For all but Redis
7632 each item in the list is a slash-separated list of four
7633 items: host name, database name, user name, and password. In the case of
7634 Oracle, the host name field is used for the &"service name"&, and the database
7635 name field is not used and should be empty. For example:
7636 .code
7637 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7638 .endd
7639 Because password data is sensitive, you should always precede the setting with
7640 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7641 option. Here is an example where two MySQL servers are listed:
7642 .code
7643 hide mysql_servers = localhost/users/root/secret:\
7644                      otherhost/users/root/othersecret
7645 .endd
7646 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7647 because this is a colon-separated list, the colon has to be doubled. For each
7648 query, these parameter groups are tried in order until a connection is made and
7649 a query is successfully processed. The result of a query may be that no data is
7650 found, but that is still a successful query. In other words, the list of
7651 servers provides a backup facility, not a list of different places to look.
7652
7653 For Redis the global option need not be specified if all queries contain their
7654 own server information &-- see section &<<SECTspeserque>>&.
7655 If specified, the option must be set to a colon-separated list of server
7656 information.
7657 Each item in the list is a slash-separated list of three items:
7658 host, database number, and password.
7659 .olist
7660 The host is required and may be either an IPv4 address and optional
7661 port number (separated by a colon, which needs doubling due to the
7662 higher-level list), or a Unix socket pathname enclosed in parentheses
7663 .next
7664 The database number is optional; if present that number is selected in the backend
7665 .next
7666 The password is optional; if present it is used to authenticate to the backend
7667 .endlist
7668
7669 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7670 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7671 respectively, and the characters single-quote, double-quote, and backslash
7672 itself are escaped with backslashes.
7673
7674 The &%quote_redis%& expansion operator
7675 escapes whitespace and backslash characters with a backslash.
7676
7677 .section "Specifying the server in the query" "SECTspeserque"
7678 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7679 it is possible to specify a list of servers with an individual query. This is
7680 done by starting the query with
7681 .display
7682 &`servers=`&&'server1:server2:server3:...'&&`;`&
7683 .endd
7684 Each item in the list may take one of two forms:
7685 .olist
7686 If it contains no slashes it is assumed to be just a host name. The appropriate
7687 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7688 of the same name, and the remaining parameters (database, user, password) are
7689 taken from there.
7690 .next
7691 If it contains any slashes, it is taken as a complete parameter set.
7692 .endlist
7693 The list of servers is used in exactly the same way as the global list.
7694 Once a connection to a server has happened and a query has been
7695 successfully executed, processing of the lookup ceases.
7696
7697 This feature is intended for use in master/slave situations where updates
7698 are occurring and you want to update the master rather than a slave. If the
7699 master is in the list as a backup for reading, you might have a global setting
7700 like this:
7701 .code
7702 mysql_servers = slave1/db/name/pw:\
7703                 slave2/db/name/pw:\
7704                 master/db/name/pw
7705 .endd
7706 In an updating lookup, you could then write:
7707 .code
7708 ${lookup mysql{servers=master; UPDATE ...} }
7709 .endd
7710 That query would then be sent only to the master server. If, on the other hand,
7711 the master is not to be used for reading, and so is not present in the global
7712 option, you can still update it by a query of this form:
7713 .code
7714 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7715 .endd
7716
7717
7718 .section "Special MySQL features" "SECID73"
7719 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7720 causes a connection to the server on the local host by means of a Unix domain
7721 socket. An alternate socket can be specified in parentheses.
7722 An option group name for MySQL option files can be specified in square brackets;
7723 the default value is &"exim"&.
7724 The full syntax of each item in &%mysql_servers%& is:
7725 .display
7726 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7727   <&'database'&>/<&'user'&>/<&'password'&>
7728 .endd
7729 Any of the four sub-parts of the first field can be omitted. For normal use on
7730 the local host it can be left blank or set to just &"localhost"&.
7731
7732 No database need be supplied &-- but if it is absent here, it must be given in
7733 the queries.
7734
7735 If a MySQL query is issued that does not request any data (an insert, update,
7736 or delete command), the result of the lookup is the number of rows affected.
7737
7738 &*Warning*&: This can be misleading. If an update does not actually change
7739 anything (for example, setting a field to the value it already has), the result
7740 is zero because no rows are affected.
7741
7742
7743 .section "Special PostgreSQL features" "SECID74"
7744 PostgreSQL lookups can also use Unix domain socket connections to the database.
7745 This is usually faster and costs less CPU time than a TCP/IP connection.
7746 However it can be used only if the mail server runs on the same machine as the
7747 database server. A configuration line for PostgreSQL via Unix domain sockets
7748 looks like this:
7749 .code
7750 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7751 .endd
7752 In other words, instead of supplying a host name, a path to the socket is
7753 given. The path name is enclosed in parentheses so that its slashes aren't
7754 visually confused with the delimiters for the other server parameters.
7755
7756 If a PostgreSQL query is issued that does not request any data (an insert,
7757 update, or delete command), the result of the lookup is the number of rows
7758 affected.
7759
7760 .section "More about SQLite" "SECTsqlite"
7761 .cindex "lookup" "SQLite"
7762 .cindex "sqlite lookup type"
7763 SQLite is different to the other SQL lookups because a file name is required in
7764 addition to the SQL query. An SQLite database is a single file, and there is no
7765 daemon as in the other SQL databases. The interface to Exim requires the name
7766 of the file, as an absolute path, to be given at the start of the query. It is
7767 separated from the query by white space. This means that the path name cannot
7768 contain white space. Here is a lookup expansion example:
7769 .code
7770 ${lookup sqlite {/some/thing/sqlitedb \
7771   select name from aliases where id='userx';}}
7772 .endd
7773 In a list, the syntax is similar. For example:
7774 .code
7775 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7776    select * from relays where ip='$sender_host_address';
7777 .endd
7778 The only character affected by the &%quote_sqlite%& operator is a single
7779 quote, which it doubles.
7780
7781 .cindex timeout SQLite
7782 .cindex sqlite "lookup timeout"
7783 The SQLite library handles multiple simultaneous accesses to the database
7784 internally. Multiple readers are permitted, but only one process can
7785 update at once. Attempts to access the database while it is being updated
7786 are rejected after a timeout period, during which the SQLite library
7787 waits for the lock to be released. In Exim, the default timeout is set
7788 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7789 option.
7790 .ecindex IIDfidalo1
7791 .ecindex IIDfidalo2
7792
7793
7794 . ////////////////////////////////////////////////////////////////////////////
7795 . ////////////////////////////////////////////////////////////////////////////
7796
7797 .chapter "Domain, host, address, and local part lists" &&&
7798          "CHAPdomhosaddlists" &&&
7799          "Domain, host, and address lists"
7800 .scindex IIDdohoadli "lists of domains; hosts; etc."
7801 A number of Exim configuration options contain lists of domains, hosts,
7802 email addresses, or local parts. For example, the &%hold_domains%& option
7803 contains a list of domains whose delivery is currently suspended. These lists
7804 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7805 arguments to expansion conditions such as &%match_domain%&.
7806
7807 Each item in one of these lists is a pattern to be matched against a domain,
7808 host, email address, or local part, respectively. In the sections below, the
7809 different types of pattern for each case are described, but first we cover some
7810 general facilities that apply to all four kinds of list.
7811
7812 Note that other parts of Exim use a &'string list'& which does not
7813 support all the complexity available in
7814 domain, host, address and local part lists.
7815
7816
7817
7818 .section "Expansion of lists" "SECTlistexpand"
7819 .cindex "expansion" "of lists"
7820 Each list is expanded as a single string before it is used.
7821
7822 .new
7823 &'Exception: the router headers_remove option, where list-item
7824 splitting is done before string-expansion.'&
7825 .wen
7826
7827 The result of
7828 expansion must be a list, possibly containing empty items, which is split up
7829 into separate items for matching. By default, colon is the separator character,
7830 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7831 &<<SECTempitelis>>& for details of the list syntax; the second of these
7832 discusses the way to specify empty list items.
7833
7834
7835 If the string expansion is forced to fail, Exim behaves as if the item it is
7836 testing (domain, host, address, or local part) is not in the list. Other
7837 expansion failures cause temporary errors.
7838
7839 If an item in a list is a regular expression, backslashes, dollars and possibly
7840 other special characters in the expression must be protected against
7841 misinterpretation by the string expander. The easiest way to do this is to use
7842 the &`\N`& expansion feature to indicate that the contents of the regular
7843 expression should not be expanded. For example, in an ACL you might have:
7844 .code
7845 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7846                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7847 .endd
7848 The first item is a regular expression that is protected from expansion by
7849 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7850 senders based on the receiving domain.
7851
7852
7853
7854
7855 .section "Negated items in lists" "SECID76"
7856 .cindex "list" "negation"
7857 .cindex "negation" "in lists"
7858 Items in a list may be positive or negative. Negative items are indicated by a
7859 leading exclamation mark, which may be followed by optional white space. A list
7860 defines a set of items (domains, etc). When Exim processes one of these lists,
7861 it is trying to find out whether a domain, host, address, or local part
7862 (respectively) is in the set that is defined by the list. It works like this:
7863
7864 The list is scanned from left to right. If a positive item is matched, the
7865 subject that is being checked is in the set; if a negative item is matched, the
7866 subject is not in the set. If the end of the list is reached without the
7867 subject having matched any of the patterns, it is in the set if the last item
7868 was a negative one, but not if it was a positive one. For example, the list in
7869 .code
7870 domainlist relay_to_domains = !a.b.c : *.b.c
7871 .endd
7872 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7873 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7874 list is positive. However, if the setting were
7875 .code
7876 domainlist relay_to_domains = !a.b.c
7877 .endd
7878 then all domains other than &'a.b.c'& would match because the last item in the
7879 list is negative. In other words, a list that ends with a negative item behaves
7880 as if it had an extra item &`:*`& on the end.
7881
7882 Another way of thinking about positive and negative items in lists is to read
7883 the connector as &"or"& after a positive item and as &"and"& after a negative
7884 item.
7885
7886
7887
7888 .section "File names in lists" "SECTfilnamlis"
7889 .cindex "list" "file name in"
7890 If an item in a domain, host, address, or local part list is an absolute file
7891 name (beginning with a slash character), each line of the file is read and
7892 processed as if it were an independent item in the list, except that further
7893 file names are not allowed,
7894 and no expansion of the data from the file takes place.
7895 Empty lines in the file are ignored, and the file may also contain comment
7896 lines:
7897
7898 .ilist
7899 For domain and host lists, if a # character appears anywhere in a line of the
7900 file, it and all following characters are ignored.
7901 .next
7902 Because local parts may legitimately contain # characters, a comment in an
7903 address list or local part list file is recognized only if # is preceded by
7904 white space or the start of the line. For example:
7905 .code
7906 not#comment@x.y.z   # but this is a comment
7907 .endd
7908 .endlist
7909
7910 Putting a file name in a list has the same effect as inserting each line of the
7911 file as an item in the list (blank lines and comments excepted). However, there
7912 is one important difference: the file is read each time the list is processed,
7913 so if its contents vary over time, Exim's behaviour changes.
7914
7915 If a file name is preceded by an exclamation mark, the sense of any match
7916 within the file is inverted. For example, if
7917 .code
7918 hold_domains = !/etc/nohold-domains
7919 .endd
7920 and the file contains the lines
7921 .code
7922 !a.b.c
7923 *.b.c
7924 .endd
7925 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7926 any domain matching &`*.b.c`& is not.
7927
7928
7929
7930 .section "An lsearch file is not an out-of-line list" "SECID77"
7931 As will be described in the sections that follow, lookups can be used in lists
7932 to provide indexed methods of checking list membership. There has been some
7933 confusion about the way &(lsearch)& lookups work in lists. Because
7934 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7935 sometimes thought that it is allowed to contain wild cards and other kinds of
7936 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7937 always fixed strings, just as for any other single-key lookup type.
7938
7939 If you want to use a file to contain wild-card patterns that form part of a
7940 list, just give the file name on its own, without a search type, as described
7941 in the previous section. You could also use the &(wildlsearch)& or
7942 &(nwildlsearch)&, but there is no advantage in doing this.
7943
7944
7945
7946
7947 .section "Named lists" "SECTnamedlists"
7948 .cindex "named lists"
7949 .cindex "list" "named"
7950 A list of domains, hosts, email addresses, or local parts can be given a name
7951 which is then used to refer to the list elsewhere in the configuration. This is
7952 particularly convenient if the same list is required in several different
7953 places. It also allows lists to be given meaningful names, which can improve
7954 the readability of the configuration. For example, it is conventional to define
7955 a domain list called &'local_domains'& for all the domains that are handled
7956 locally on a host, using a configuration line such as
7957 .code
7958 domainlist local_domains = localhost:my.dom.example
7959 .endd
7960 Named lists are referenced by giving their name preceded by a plus sign, so,
7961 for example, a router that is intended to handle local domains would be
7962 configured with the line
7963 .code
7964 domains = +local_domains
7965 .endd
7966 The first router in a configuration is often one that handles all domains
7967 except the local ones, using a configuration with a negated item like this:
7968 .code
7969 dnslookup:
7970   driver = dnslookup
7971   domains = ! +local_domains
7972   transport = remote_smtp
7973   no_more
7974 .endd
7975 The four kinds of named list are created by configuration lines starting with
7976 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7977 respectively. Then there follows the name that you are defining, followed by an
7978 equals sign and the list itself. For example:
7979 .code
7980 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7981 addresslist bad_senders = cdb;/etc/badsenders
7982 .endd
7983 A named list may refer to other named lists:
7984 .code
7985 domainlist  dom1 = first.example : second.example
7986 domainlist  dom2 = +dom1 : third.example
7987 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7988 .endd
7989 &*Warning*&: If the last item in a referenced list is a negative one, the
7990 effect may not be what you intended, because the negation does not propagate
7991 out to the higher level. For example, consider:
7992 .code
7993 domainlist  dom1 = !a.b
7994 domainlist  dom2 = +dom1 : *.b
7995 .endd
7996 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7997 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7998 means it matches the second list as well. The effect is not the same as
7999 .code
8000 domainlist  dom2 = !a.b : *.b
8001 .endd
8002 where &'x.y'& does not match. It's best to avoid negation altogether in
8003 referenced lists if you can.
8004
8005 Named lists may have a performance advantage. When Exim is routing an
8006 address or checking an incoming message, it caches the result of tests on named
8007 lists. So, if you have a setting such as
8008 .code
8009 domains = +local_domains
8010 .endd
8011 on several of your routers
8012 or in several ACL statements,
8013 the actual test is done only for the first one. However, the caching works only
8014 if there are no expansions within the list itself or any sublists that it
8015 references. In other words, caching happens only for lists that are known to be
8016 the same each time they are referenced.
8017
8018 By default, there may be up to 16 named lists of each type. This limit can be
8019 extended by changing a compile-time variable. The use of domain and host lists
8020 is recommended for concepts such as local domains, relay domains, and relay
8021 hosts. The default configuration is set up like this.
8022
8023
8024
8025 .section "Named lists compared with macros" "SECID78"
8026 .cindex "list" "named compared with macro"
8027 .cindex "macro" "compared with named list"
8028 At first sight, named lists might seem to be no different from macros in the
8029 configuration file. However, macros are just textual substitutions. If you
8030 write
8031 .code
8032 ALIST = host1 : host2
8033 auth_advertise_hosts = !ALIST
8034 .endd
8035 it probably won't do what you want, because that is exactly the same as
8036 .code
8037 auth_advertise_hosts = !host1 : host2
8038 .endd
8039 Notice that the second host name is not negated. However, if you use a host
8040 list, and write
8041 .code
8042 hostlist alist = host1 : host2
8043 auth_advertise_hosts = ! +alist
8044 .endd
8045 the negation applies to the whole list, and so that is equivalent to
8046 .code
8047 auth_advertise_hosts = !host1 : !host2
8048 .endd
8049
8050
8051 .section "Named list caching" "SECID79"
8052 .cindex "list" "caching of named"
8053 .cindex "caching" "named lists"
8054 While processing a message, Exim caches the result of checking a named list if
8055 it is sure that the list is the same each time. In practice, this means that
8056 the cache operates only if the list contains no $ characters, which guarantees
8057 that it will not change when it is expanded. Sometimes, however, you may have
8058 an expanded list that you know will be the same each time within a given
8059 message. For example:
8060 .code
8061 domainlist special_domains = \
8062            ${lookup{$sender_host_address}cdb{/some/file}}
8063 .endd
8064 This provides a list of domains that depends only on the sending host's IP
8065 address. If this domain list is referenced a number of times (for example,
8066 in several ACL lines, or in several routers) the result of the check is not
8067 cached by default, because Exim does not know that it is going to be the
8068 same list each time.
8069
8070 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8071 cache the result anyway. For example:
8072 .code
8073 domainlist_cache special_domains = ${lookup{...
8074 .endd
8075 If you do this, you should be absolutely sure that caching is going to do
8076 the right thing in all cases. When in doubt, leave it out.
8077
8078
8079
8080 .section "Domain lists" "SECTdomainlist"
8081 .cindex "domain list" "patterns for"
8082 .cindex "list" "domain list"
8083 Domain lists contain patterns that are to be matched against a mail domain.
8084 The following types of item may appear in domain lists:
8085
8086 .ilist
8087 .cindex "primary host name"
8088 .cindex "host name" "matched in domain list"
8089 .oindex "&%primary_hostname%&"
8090 .cindex "domain list" "matching primary host name"
8091 .cindex "@ in a domain list"
8092 If a pattern consists of a single @ character, it matches the local host name,
8093 as set by the &%primary_hostname%& option (or defaulted). This makes it
8094 possible to use the same configuration file on several different hosts that
8095 differ only in their names.
8096 .next
8097 .cindex "@[] in a domain list"
8098 .cindex "domain list" "matching local IP interfaces"
8099 .cindex "domain literal"
8100 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8101 in square brackets (as in an email address that contains a domain literal), but
8102 only if that IP address is recognized as local for email routing purposes. The
8103 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8104 control which of a host's several IP addresses are treated as local.
8105 In today's Internet, the use of domain literals is controversial.
8106 .next
8107 .cindex "@mx_any"
8108 .cindex "@mx_primary"
8109 .cindex "@mx_secondary"
8110 .cindex "domain list" "matching MX pointers to local host"
8111 If a pattern consists of the string &`@mx_any`& it matches any domain that
8112 has an MX record pointing to the local host or to any host that is listed in
8113 .oindex "&%hosts_treat_as_local%&"
8114 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8115 are similar, except that the first matches only when a primary MX target is the
8116 local host, and the second only when no primary MX target is the local host,
8117 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8118 preference value &-- there may of course be more than one of them.
8119
8120 The MX lookup that takes place when matching a pattern of this type is
8121 performed with the resolver options for widening names turned off. Thus, for
8122 example, a single-component domain will &'not'& be expanded by adding the
8123 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8124 options of the &(dnslookup)& router for a discussion of domain widening.
8125
8126 Sometimes you may want to ignore certain IP addresses when using one of these
8127 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8128 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8129 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8130 on a router). For example:
8131 .code
8132 domains = @mx_any/ignore=127.0.0.1
8133 .endd
8134 This example matches any domain that has an MX record pointing to one of
8135 the local host's IP addresses other than 127.0.0.1.
8136
8137 The list of IP addresses is in fact processed by the same code that processes
8138 host lists, so it may contain CIDR-coded network specifications and it may also
8139 contain negative items.
8140
8141 Because the list of IP addresses is a sublist within a domain list, you have to
8142 be careful about delimiters if there is more than one address. Like any other
8143 list, the default delimiter can be changed. Thus, you might have:
8144 .code
8145 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8146           an.other.domain : ...
8147 .endd
8148 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8149 involved, it is easiest to change the delimiter for the main list as well:
8150 .code
8151 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8152           an.other.domain ? ...
8153 .endd
8154 .next
8155 .cindex "asterisk" "in domain list"
8156 .cindex "domain list" "asterisk in"
8157 .cindex "domain list" "matching &""ends with""&"
8158 If a pattern starts with an asterisk, the remaining characters of the pattern
8159 are compared with the terminating characters of the domain. The use of &"*"& in
8160 domain lists differs from its use in partial matching lookups. In a domain
8161 list, the character following the asterisk need not be a dot, whereas partial
8162 matching works only in terms of dot-separated components. For example, a domain
8163 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8164 &'cipher.key.ex'&.
8165
8166 .next
8167 .cindex "regular expressions" "in domain list"
8168 .cindex "domain list" "matching regular expression"
8169 If a pattern starts with a circumflex character, it is treated as a regular
8170 expression, and matched against the domain using a regular expression matching
8171 function. The circumflex is treated as part of the regular expression.
8172 Email domains are case-independent, so this regular expression match is by
8173 default case-independent, but you can make it case-dependent by starting it
8174 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8175 are given in chapter &<<CHAPregexp>>&.
8176
8177 &*Warning*&: Because domain lists are expanded before being processed, you
8178 must escape any backslash and dollar characters in the regular expression, or
8179 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8180 it is not to be expanded (unless you really do want to build a regular
8181 expression by expansion, of course).
8182 .next
8183 .cindex "lookup" "in domain list"
8184 .cindex "domain list" "matching by lookup"
8185 If a pattern starts with the name of a single-key lookup type followed by a
8186 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8187 must be a file name in a suitable format for the lookup type. For example, for
8188 &"cdb;"& it must be an absolute path:
8189 .code
8190 domains = cdb;/etc/mail/local_domains.cdb
8191 .endd
8192 The appropriate type of lookup is done on the file using the domain name as the
8193 key. In most cases, the data that is looked up is not used; Exim is interested
8194 only in whether or not the key is present in the file. However, when a lookup
8195 is used for the &%domains%& option on a router
8196 or a &%domains%& condition in an ACL statement, the data is preserved in the
8197 &$domain_data$& variable and can be referred to in other router options or
8198 other statements in the same ACL.
8199
8200 .next
8201 Any of the single-key lookup type names may be preceded by
8202 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8203 .code
8204 domains = partial-dbm;/partial/domains
8205 .endd
8206 This causes partial matching logic to be invoked; a description of how this
8207 works is given in section &<<SECTpartiallookup>>&.
8208
8209 .next
8210 .cindex "asterisk" "in lookup type"
8211 Any of the single-key lookup types may be followed by an asterisk. This causes
8212 a default lookup for a key consisting of a single asterisk to be done if the
8213 original lookup fails. This is not a useful feature when using a domain list to
8214 select particular domains (because any domain would match), but it might have
8215 value if the result of the lookup is being used via the &$domain_data$&
8216 expansion variable.
8217 .next
8218 If the pattern starts with the name of a query-style lookup type followed by a
8219 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8220 pattern must be an appropriate query for the lookup type, as described in
8221 chapter &<<CHAPfdlookup>>&. For example:
8222 .code
8223 hold_domains = mysql;select domain from holdlist \
8224   where domain = '${quote_mysql:$domain}';
8225 .endd
8226 In most cases, the data that is looked up is not used (so for an SQL query, for
8227 example, it doesn't matter what field you select). Exim is interested only in
8228 whether or not the query succeeds. However, when a lookup is used for the
8229 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8230 variable and can be referred to in other options.
8231 .next
8232 .cindex "domain list" "matching literal domain name"
8233 If none of the above cases apply, a caseless textual comparison is made
8234 between the pattern and the domain.
8235 .endlist
8236
8237 Here is an example that uses several different kinds of pattern:
8238 .code
8239 domainlist funny_domains = \
8240   @ : \
8241   lib.unseen.edu : \
8242   *.foundation.fict.example : \
8243   \N^[1-2]\d{3}\.fict\.example$\N : \
8244   partial-dbm;/opt/data/penguin/book : \
8245   nis;domains.byname : \
8246   nisplus;[name=$domain,status=local],domains.org_dir
8247 .endd
8248 There are obvious processing trade-offs among the various matching modes. Using
8249 an asterisk is faster than a regular expression, and listing a few names
8250 explicitly probably is too. The use of a file or database lookup is expensive,
8251 but may be the only option if hundreds of names are required. Because the
8252 patterns are tested in order, it makes sense to put the most commonly matched
8253 patterns earlier.
8254
8255
8256
8257 .section "Host lists" "SECThostlist"
8258 .cindex "host list" "patterns in"
8259 .cindex "list" "host list"
8260 Host lists are used to control what remote hosts are allowed to do. For
8261 example, some hosts may be allowed to use the local host as a relay, and some
8262 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8263 two different ways, by name or by IP address. In a host list, some types of
8264 pattern are matched to a host name, and some are matched to an IP address.
8265 You need to be particularly careful with this when single-key lookups are
8266 involved, to ensure that the right value is being used as the key.
8267
8268
8269 .section "Special host list patterns" "SECID80"
8270 .cindex "empty item in hosts list"
8271 .cindex "host list" "empty string in"
8272 If a host list item is the empty string, it matches only when no remote host is
8273 involved. This is the case when a message is being received from a local
8274 process using SMTP on the standard input, that is, when a TCP/IP connection is
8275 not used.
8276
8277 .cindex "asterisk" "in host list"
8278 The special pattern &"*"& in a host list matches any host or no host. Neither
8279 the IP address nor the name is actually inspected.
8280
8281
8282
8283 .section "Host list patterns that match by IP address" "SECThoslispatip"
8284 .cindex "host list" "matching IP addresses"
8285 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8286 the incoming address actually appears in the IPv6 host as
8287 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8288 list, it is converted into a traditional IPv4 address first. (Not all operating
8289 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8290 concerns.)
8291
8292 The following types of pattern in a host list check the remote host by
8293 inspecting its IP address:
8294
8295 .ilist
8296 If the pattern is a plain domain name (not a regular expression, not starting
8297 with *, not a lookup of any kind), Exim calls the operating system function
8298 to find the associated IP address(es). Exim uses the newer
8299 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8300 This typically causes a forward DNS lookup of the name. The result is compared
8301 with the IP address of the subject host.
8302
8303 If there is a temporary problem (such as a DNS timeout) with the host name
8304 lookup, a temporary error occurs. For example, if the list is being used in an
8305 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8306 temporary SMTP error code. If no IP address can be found for the host name,
8307 what happens is described in section &<<SECTbehipnot>>& below.
8308
8309 .next
8310 .cindex "@ in a host list"
8311 If the pattern is &"@"&, the primary host name is substituted and used as a
8312 domain name, as just described.
8313
8314 .next
8315 If the pattern is an IP address, it is matched against the IP address of the
8316 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8317 IPv6 addresses can be given in colon-separated format, but the colons have to
8318 be doubled so as not to be taken as item separators when the default list
8319 separator is used. IPv6 addresses are recognized even when Exim is compiled
8320 without IPv6 support. This means that if they appear in a host list on an
8321 IPv4-only host, Exim will not treat them as host names. They are just addresses
8322 that can never match a client host.
8323
8324 .next
8325 .cindex "@[] in a host list"
8326 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8327 the local host. For example, if the local host is an IPv4 host with one
8328 interface address 10.45.23.56, these two ACL statements have the same effect:
8329 .code
8330 accept hosts = 127.0.0.1 : 10.45.23.56
8331 accept hosts = @[]
8332 .endd
8333 .next
8334 .cindex "CIDR notation"
8335 If the pattern is an IP address followed by a slash and a mask length (for
8336 example 10.11.42.0/24), it is matched against the IP address of the subject
8337 host under the given mask. This allows, an entire network of hosts to be
8338 included (or excluded) by a single item. The mask uses CIDR notation; it
8339 specifies the number of address bits that must match, starting from the most
8340 significant end of the address.
8341
8342 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8343 of a range of addresses. It is the number of bits in the network portion of the
8344 address. The above example specifies a 24-bit netmask, so it matches all 256
8345 addresses in the 10.11.42.0 network. An item such as
8346 .code
8347 192.168.23.236/31
8348 .endd
8349 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8350 32 for an IPv4 address is the same as no mask at all; just a single address
8351 matches.
8352
8353 Here is another example which shows an IPv4 and an IPv6 network:
8354 .code
8355 recipient_unqualified_hosts = 192.168.0.0/16: \
8356                               3ffe::ffff::836f::::/48
8357 .endd
8358 The doubling of list separator characters applies only when these items
8359 appear inline in a host list. It is not required when indirecting via a file.
8360 For example:
8361 .code
8362 recipient_unqualified_hosts = /opt/exim/unqualnets
8363 .endd
8364 could make use of a file containing
8365 .code
8366 172.16.0.0/12
8367 3ffe:ffff:836f::/48
8368 .endd
8369 to have exactly the same effect as the previous example. When listing IPv6
8370 addresses inline, it is usually more convenient to use the facility for
8371 changing separator characters. This list contains the same two networks:
8372 .code
8373 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8374                                  3ffe:ffff:836f::/48
8375 .endd
8376 The separator is changed to semicolon by the leading &"<;"& at the start of the
8377 list.
8378 .endlist
8379
8380
8381
8382 .section "Host list patterns for single-key lookups by host address" &&&
8383          "SECThoslispatsikey"
8384 .cindex "host list" "lookup of IP address"
8385 When a host is to be identified by a single-key lookup of its complete IP
8386 address, the pattern takes this form:
8387 .display
8388 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8389 .endd
8390 For example:
8391 .code
8392 hosts_lookup = net-cdb;/hosts-by-ip.db
8393 .endd
8394 The text form of the IP address of the subject host is used as the lookup key.
8395 IPv6 addresses are converted to an unabbreviated form, using lower case
8396 letters, with dots as separators because colon is the key terminator in
8397 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8398 quoting the keys, but this is a facility that was added later.] The data
8399 returned by the lookup is not used.
8400
8401 .cindex "IP address" "masking"
8402 .cindex "host list" "masked IP address"
8403 Single-key lookups can also be performed using masked IP addresses, using
8404 patterns of this form:
8405 .display
8406 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8407 .endd
8408 For example:
8409 .code
8410 net24-dbm;/networks.db
8411 .endd
8412 The IP address of the subject host is masked using <&'number'&> as the mask
8413 length. A textual string is constructed from the masked value, followed by the
8414 mask, and this is used as the lookup key. For example, if the host's IP address
8415 is 192.168.34.6, the key that is looked up for the above example is
8416 &"192.168.34.0/24"&.
8417
8418 When an IPv6 address is converted to a string, dots are normally used instead
8419 of colons, so that keys in &(lsearch)& files need not contain colons (which
8420 terminate &(lsearch)& keys). This was implemented some time before the ability
8421 to quote keys was made available in &(lsearch)& files. However, the more
8422 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8423 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8424 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8425 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8426 addresses are always used.
8427
8428 Ideally, it would be nice to tidy up this anomalous situation by changing to
8429 colons in all cases, given that quoting is now available for &(lsearch)&.
8430 However, this would be an incompatible change that might break some existing
8431 configurations.
8432
8433 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8434 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8435 the former case the key strings include the mask value, whereas in the latter
8436 case the IP address is used on its own.
8437
8438
8439
8440 .section "Host list patterns that match by host name" "SECThoslispatnam"
8441 .cindex "host" "lookup failures"
8442 .cindex "unknown host name"
8443 .cindex "host list" "matching host name"
8444 There are several types of pattern that require Exim to know the name of the
8445 remote host. These are either wildcard patterns or lookups by name. (If a
8446 complete hostname is given without any wildcarding, it is used to find an IP
8447 address to match against, as described in section &<<SECThoslispatip>>&
8448 above.)
8449
8450 If the remote host name is not already known when Exim encounters one of these
8451 patterns, it has to be found from the IP address.
8452 Although many sites on the Internet are conscientious about maintaining reverse
8453 DNS data for their hosts, there are also many that do not do this.
8454 Consequently, a name cannot always be found, and this may lead to unwanted
8455 effects. Take care when configuring host lists with wildcarded name patterns.
8456 Consider what will happen if a name cannot be found.
8457
8458 Because of the problems of determining host names from IP addresses, matching
8459 against host names is not as common as matching against IP addresses.
8460
8461 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8462 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8463 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8464 are done can be changed by setting the &%host_lookup_order%& option. For
8465 security, once Exim has found one or more names, it looks up the IP addresses
8466 for these names and compares them with the IP address that it started with.
8467 Only those names whose IP addresses match are accepted. Any other names are
8468 discarded. If no names are left, Exim behaves as if the host name cannot be
8469 found. In the most common case there is only one name and one IP address.
8470
8471 There are some options that control what happens if a host name cannot be
8472 found. These are described in section &<<SECTbehipnot>>& below.
8473
8474 .cindex "host" "alias for"
8475 .cindex "alias for host"
8476 As a result of aliasing, hosts may have more than one name. When processing any
8477 of the following types of pattern, all the host's names are checked:
8478
8479 .ilist
8480 .cindex "asterisk" "in host list"
8481 If a pattern starts with &"*"& the remainder of the item must match the end of
8482 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8483 &'.b.c'&. This special simple form is provided because this is a very common
8484 requirement. Other kinds of wildcarding require the use of a regular
8485 expression.
8486 .next
8487 .cindex "regular expressions" "in host list"
8488 .cindex "host list" "regular expression in"
8489 If the item starts with &"^"& it is taken to be a regular expression which is
8490 matched against the host name. Host names are case-independent, so this regular
8491 expression match is by default case-independent, but you can make it
8492 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8493 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8494 example,
8495 .code
8496 ^(a|b)\.c\.d$
8497 .endd
8498 is a regular expression that matches either of the two hosts &'a.c.d'& or
8499 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8500 that backslash and dollar characters are not misinterpreted as part of the
8501 string expansion. The simplest way to do this is to use &`\N`& to mark that
8502 part of the string as non-expandable. For example:
8503 .code
8504 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8505 .endd
8506 &*Warning*&: If you want to match a complete host name, you must include the
8507 &`$`& terminating metacharacter in the regular expression, as in the above
8508 example. Without it, a match at the start of the host name is all that is
8509 required.
8510 .endlist
8511
8512
8513
8514
8515 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8516 .cindex "host" "lookup failures, permanent"
8517 While processing a host list, Exim may need to look up an IP address from a
8518 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8519 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8520 behaviour when it fails to find the information it is seeking is the same.
8521
8522 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8523 apply to temporary DNS errors, whose handling is described in the next section.
8524
8525 .cindex "&`+include_unknown`&"
8526 .cindex "&`+ignore_unknown`&"
8527 Exim parses a host list from left to right. If it encounters a permanent
8528 lookup failure in any item in the host list before it has found a match,
8529 Exim treats it as a failure and the default behavior is as if the host
8530 does not match the list. This may not always be what you want to happen.
8531 To change Exim's behaviour, the special items &`+include_unknown`& or
8532 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8533 not recognized in an indirected file).
8534
8535 .ilist
8536 If any item that follows &`+include_unknown`& requires information that
8537 cannot found, Exim behaves as if the host does match the list. For example,
8538 .code
8539 host_reject_connection = +include_unknown:*.enemy.ex
8540 .endd
8541 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8542 any hosts whose name it cannot find.
8543
8544 .next
8545 If any item that follows &`+ignore_unknown`& requires information that cannot
8546 be found, Exim ignores that item and proceeds to the rest of the list. For
8547 example:
8548 .code
8549 accept hosts = +ignore_unknown : friend.example : \
8550                192.168.4.5
8551 .endd
8552 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8553 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8554 name can be found for 192.168.4.5, it is rejected.
8555 .endlist
8556
8557 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8558 list. The effect of each one lasts until the next, or until the end of the
8559 list.
8560
8561 .section "Mixing wildcarded host names and addresses in host lists" &&&
8562          "SECTmixwilhos"
8563 .cindex "host list" "mixing names and addresses in"
8564
8565 This section explains the host/ip processing logic with the same concepts
8566 as the previous section, but specifically addresses what happens when a
8567 wildcarded hostname is one of the items in the hostlist.
8568
8569 .ilist
8570 If you have name lookups or wildcarded host names and
8571 IP addresses in the same host list, you should normally put the IP
8572 addresses first. For example, in an ACL you could have:
8573 .code
8574 accept hosts = 10.9.8.7 : *.friend.example
8575 .endd
8576 The reason you normally would order it this way lies in the
8577 left-to-right way that Exim processes lists.  It can test IP addresses
8578 without doing any DNS lookups, but when it reaches an item that requires
8579 a host name, it fails if it cannot find a host name to compare with the
8580 pattern. If the above list is given in the opposite order, the
8581 &%accept%& statement fails for a host whose name cannot be found, even
8582 if its IP address is 10.9.8.7.
8583
8584 .next
8585 If you really do want to do the name check first, and still recognize the IP
8586 address, you can rewrite the ACL like this:
8587 .code
8588 accept hosts = *.friend.example
8589 accept hosts = 10.9.8.7
8590 .endd
8591 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8592 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8593 &`+ignore_unknown`&, which was discussed in depth in the first example in
8594 this section.
8595 .endlist
8596
8597
8598 .section "Temporary DNS errors when looking up host information" &&&
8599          "SECTtemdnserr"
8600 .cindex "host" "lookup failures, temporary"
8601 .cindex "&`+include_defer`&"
8602 .cindex "&`+ignore_defer`&"
8603 A temporary DNS lookup failure normally causes a defer action (except when
8604 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8605 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8606 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8607 section. These options should be used with care, probably only in non-critical
8608 host lists such as whitelists.
8609
8610
8611
8612 .section "Host list patterns for single-key lookups by host name" &&&
8613          "SECThoslispatnamsk"
8614 .cindex "unknown host name"
8615 .cindex "host list" "matching host name"
8616 If a pattern is of the form
8617 .display
8618 <&'single-key-search-type'&>;<&'search-data'&>
8619 .endd
8620 for example
8621 .code
8622 dbm;/host/accept/list
8623 .endd
8624 a single-key lookup is performed, using the host name as its key. If the
8625 lookup succeeds, the host matches the item. The actual data that is looked up
8626 is not used.
8627
8628 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8629 keys in the file, not IP addresses. If you want to do lookups based on IP
8630 addresses, you must precede the search type with &"net-"& (see section
8631 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8632 two items in the same list, one doing an address lookup and one doing a name
8633 lookup, both using the same file.
8634
8635
8636
8637 .section "Host list patterns for query-style lookups" "SECID81"
8638 If a pattern is of the form
8639 .display
8640 <&'query-style-search-type'&>;<&'query'&>
8641 .endd
8642 the query is obeyed, and if it succeeds, the host matches the item. The actual
8643 data that is looked up is not used. The variables &$sender_host_address$& and
8644 &$sender_host_name$& can be used in the query. For example:
8645 .code
8646 hosts_lookup = pgsql;\
8647   select ip from hostlist where ip='$sender_host_address'
8648 .endd
8649 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8650 can use the &%sg%& expansion item to change this if you need to. If you want to
8651 use masked IP addresses in database queries, you can use the &%mask%& expansion
8652 operator.
8653
8654 If the query contains a reference to &$sender_host_name$&, Exim automatically
8655 looks up the host name if it has not already done so. (See section
8656 &<<SECThoslispatnam>>& for comments on finding host names.)
8657
8658 Historical note: prior to release 4.30, Exim would always attempt to find a
8659 host name before running the query, unless the search type was preceded by
8660 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8661 still recognized for query-style lookups, but its presence or absence has no
8662 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8663 See section &<<SECThoslispatsikey>>&.)
8664
8665
8666
8667
8668
8669 .section "Address lists" "SECTaddresslist"
8670 .cindex "list" "address list"
8671 .cindex "address list" "empty item"
8672 .cindex "address list" "patterns"
8673 Address lists contain patterns that are matched against mail addresses. There
8674 is one special case to be considered: the sender address of a bounce message is
8675 always empty. You can test for this by providing an empty item in an address
8676 list. For example, you can set up a router to process bounce messages by
8677 using this option setting:
8678 .code
8679 senders = :
8680 .endd
8681 The presence of the colon creates an empty item. If you do not provide any
8682 data, the list is empty and matches nothing. The empty sender can also be
8683 detected by a regular expression that matches an empty string,
8684 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8685
8686 Non-empty items in an address list can be straightforward email addresses. For
8687 example:
8688 .code
8689 senders = jbc@askone.example : hs@anacreon.example
8690 .endd
8691 A certain amount of wildcarding is permitted. If a pattern contains an @
8692 character, but is not a regular expression and does not begin with a
8693 semicolon-terminated lookup type (described below), the local part of the
8694 subject address is compared with the local part of the pattern, which may start
8695 with an asterisk. If the local parts match, the domain is checked in exactly
8696 the same way as for a pattern in a domain list. For example, the domain can be
8697 wildcarded, refer to a named list, or be a lookup:
8698 .code
8699 deny senders = *@*.spamming.site:\
8700                *@+hostile_domains:\
8701                bozo@partial-lsearch;/list/of/dodgy/sites:\
8702                *@dbm;/bad/domains.db
8703 .endd
8704 .cindex "local part" "starting with !"
8705 .cindex "address list" "local part starting with !"
8706 If a local part that begins with an exclamation mark is required, it has to be
8707 specified using a regular expression, because otherwise the exclamation mark is
8708 treated as a sign of negation, as is standard in lists.
8709
8710 If a non-empty pattern that is not a regular expression or a lookup does not
8711 contain an @ character, it is matched against the domain part of the subject
8712 address. The only two formats that are recognized this way are a literal
8713 domain, or a domain pattern that starts with *. In both these cases, the effect
8714 is the same as if &`*@`& preceded the pattern. For example:
8715 .code
8716 deny senders = enemy.domain : *.enemy.domain
8717 .endd
8718
8719 The following kinds of more complicated address list pattern can match any
8720 address, including the empty address that is characteristic of bounce message
8721 senders:
8722
8723 .ilist
8724 .cindex "regular expressions" "in address list"
8725 .cindex "address list" "regular expression in"
8726 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8727 done against the complete address, with the pattern as the regular expression.
8728 You must take care that backslash and dollar characters are not misinterpreted
8729 as part of the string expansion. The simplest way to do this is to use &`\N`&
8730 to mark that part of the string as non-expandable. For example:
8731 .code
8732 deny senders = \N^.*this.*@example\.com$\N : \
8733                \N^\d{8}.+@spamhaus.example$\N : ...
8734 .endd
8735 The &`\N`& sequences are removed by the expansion, so these items do indeed
8736 start with &"^"& by the time they are being interpreted as address patterns.
8737
8738 .next
8739 .cindex "address list" "lookup for complete address"
8740 Complete addresses can be looked up by using a pattern that starts with a
8741 lookup type terminated by a semicolon, followed by the data for the lookup. For
8742 example:
8743 .code
8744 deny senders = cdb;/etc/blocked.senders : \
8745   mysql;select address from blocked where \
8746   address='${quote_mysql:$sender_address}'
8747 .endd
8748 Both query-style and single-key lookup types can be used. For a single-key
8749 lookup type, Exim uses the complete address as the key. However, empty keys are
8750 not supported for single-key lookups, so a match against the empty address
8751 always fails. This restriction does not apply to query-style lookups.
8752
8753 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8754 cannot be used, and is ignored if specified, with an entry being written to the
8755 panic log.
8756 .cindex "*@ with single-key lookup"
8757 However, you can configure lookup defaults, as described in section
8758 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8759 default. For example, with this lookup:
8760 .code
8761 accept senders = lsearch*@;/some/file
8762 .endd
8763 the file could contains lines like this:
8764 .code
8765 user1@domain1.example
8766 *@domain2.example
8767 .endd
8768 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8769 that are tried is:
8770 .code
8771 nimrod@jaeger.example
8772 *@jaeger.example
8773 *
8774 .endd
8775 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8776 would mean that every address matches, thus rendering the test useless.
8777
8778 &*Warning 2*&: Do not confuse these two kinds of item:
8779 .code
8780 deny recipients = dbm*@;/some/file
8781 deny recipients = *@dbm;/some/file
8782 .endd
8783 The first does a whole address lookup, with defaulting, as just described,
8784 because it starts with a lookup type. The second matches the local part and
8785 domain independently, as described in a bullet point below.
8786 .endlist
8787
8788
8789 The following kinds of address list pattern can match only non-empty addresses.
8790 If the subject address is empty, a match against any of these pattern types
8791 always fails.
8792
8793
8794 .ilist
8795 .cindex "@@ with single-key lookup"
8796 .cindex "address list" "@@ lookup type"
8797 .cindex "address list" "split local part and domain"
8798 If a pattern starts with &"@@"& followed by a single-key lookup item
8799 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8800 split into a local part and a domain. The domain is looked up in the file. If
8801 it is not found, there is no match. If it is found, the data that is looked up
8802 from the file is treated as a colon-separated list of local part patterns, each
8803 of which is matched against the subject local part in turn.
8804
8805 .cindex "asterisk" "in address list"
8806 The lookup may be a partial one, and/or one involving a search for a default
8807 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8808 patterns that are looked up can be regular expressions or begin with &"*"&, or
8809 even be further lookups. They may also be independently negated. For example,
8810 with
8811 .code
8812 deny senders = @@dbm;/etc/reject-by-domain
8813 .endd
8814 the data from which the DBM file is built could contain lines like
8815 .code
8816 baddomain.com:  !postmaster : *
8817 .endd
8818 to reject all senders except &%postmaster%& from that domain.
8819
8820 .cindex "local part" "starting with !"
8821 If a local part that actually begins with an exclamation mark is required, it
8822 has to be specified using a regular expression. In &(lsearch)& files, an entry
8823 may be split over several lines by indenting the second and subsequent lines,
8824 but the separating colon must still be included at line breaks. White space
8825 surrounding the colons is ignored. For example:
8826 .code
8827 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8828   spammer3 : spammer4
8829 .endd
8830 As in all colon-separated lists in Exim, a colon can be included in an item by
8831 doubling.
8832
8833 If the last item in the list starts with a right angle-bracket, the remainder
8834 of the item is taken as a new key to look up in order to obtain a continuation
8835 list of local parts. The new key can be any sequence of characters. Thus one
8836 might have entries like
8837 .code
8838 aol.com: spammer1 : spammer 2 : >*
8839 xyz.com: spammer3 : >*
8840 *:       ^\d{8}$
8841 .endd
8842 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8843 local parts for all domains, in addition to the specific local parts listed for
8844 each domain. Of course, using this feature costs another lookup each time a
8845 chain is followed, but the effort needed to maintain the data is reduced.
8846
8847 .cindex "loop" "in lookups"
8848 It is possible to construct loops using this facility, and in order to catch
8849 them, the chains may be no more than fifty items long.
8850
8851 .next
8852 The @@<&'lookup'&> style of item can also be used with a query-style
8853 lookup, but in this case, the chaining facility is not available. The lookup
8854 can only return a single list of local parts.
8855 .endlist
8856
8857 &*Warning*&: There is an important difference between the address list items
8858 in these two examples:
8859 .code
8860 senders = +my_list
8861 senders = *@+my_list
8862 .endd
8863 In the first one, &`my_list`& is a named address list, whereas in the second
8864 example it is a named domain list.
8865
8866
8867
8868
8869 .section "Case of letters in address lists" "SECTcasletadd"
8870 .cindex "case of local parts"
8871 .cindex "address list" "case forcing"
8872 .cindex "case forcing in address lists"
8873 Domains in email addresses are always handled caselessly, but for local parts
8874 case may be significant on some systems (see &%caseful_local_part%& for how
8875 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8876 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8877 blocking lists should be done in a case-independent manner. Since most address
8878 lists in Exim are used for this kind of control, Exim attempts to do this by
8879 default.
8880
8881 The domain portion of an address is always lowercased before matching it to an
8882 address list. The local part is lowercased by default, and any string
8883 comparisons that take place are done caselessly. This means that the data in
8884 the address list itself, in files included as plain file names, and in any file
8885 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8886 keys in files that are looked up by a search type other than &(lsearch)& (which
8887 works caselessly) must be in lower case, because these lookups are not
8888 case-independent.
8889
8890 .cindex "&`+caseful`&"
8891 To allow for the possibility of caseful address list matching, if an item in
8892 an address list is the string &"+caseful"&, the original case of the local
8893 part is restored for any comparisons that follow, and string comparisons are no
8894 longer case-independent. This does not affect the domain, which remains in
8895 lower case. However, although independent matches on the domain alone are still
8896 performed caselessly, regular expressions that match against an entire address
8897 become case-sensitive after &"+caseful"& has been seen.
8898
8899
8900
8901 .section "Local part lists" "SECTlocparlis"
8902 .cindex "list" "local part list"
8903 .cindex "local part" "list"
8904 Case-sensitivity in local part lists is handled in the same way as for address
8905 lists, as just described. The &"+caseful"& item can be used if required. In a
8906 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8907 set false, the subject is lowercased and the matching is initially
8908 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8909 matching in the local part list, but not elsewhere in the router. If
8910 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8911 option is case-sensitive from the start.
8912
8913 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8914 comments are handled in the same way as address lists &-- they are recognized
8915 only if the # is preceded by white space or the start of the line.
8916 Otherwise, local part lists are matched in the same way as domain lists, except
8917 that the special items that refer to the local host (&`@`&, &`@[]`&,
8918 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8919 Refer to section &<<SECTdomainlist>>& for details of the other available item
8920 types.
8921 .ecindex IIDdohoadli
8922
8923
8924
8925
8926 . ////////////////////////////////////////////////////////////////////////////
8927 . ////////////////////////////////////////////////////////////////////////////
8928
8929 .chapter "String expansions" "CHAPexpand"
8930 .scindex IIDstrexp "expansion" "of strings"
8931 Many strings in Exim's run time configuration are expanded before use. Some of
8932 them are expanded every time they are used; others are expanded only once.
8933
8934 When a string is being expanded it is copied verbatim from left to right except
8935 when a dollar or backslash character is encountered. A dollar specifies the
8936 start of a portion of the string that is interpreted and replaced as described
8937 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8938 escape character, as described in the following section.
8939
8940 Whether a string is expanded depends upon the context.  Usually this is solely
8941 dependent upon the option for which a value is sought; in this documentation,
8942 options for which string expansion is performed are marked with &dagger; after
8943 the data type.  ACL rules always expand strings.  A couple of expansion
8944 conditions do not expand some of the brace-delimited branches, for security
8945 reasons.
8946
8947
8948
8949 .section "Literal text in expanded strings" "SECTlittext"
8950 .cindex "expansion" "including literal text"
8951 An uninterpreted dollar can be included in an expanded string by putting a
8952 backslash in front of it. A backslash can be used to prevent any special
8953 character being treated specially in an expansion, including backslash itself.
8954 If the string appears in quotes in the configuration file, two backslashes are
8955 required because the quotes themselves cause interpretation of backslashes when
8956 the string is read in (see section &<<SECTstrings>>&).
8957
8958 .cindex "expansion" "non-expandable substrings"
8959 A portion of the string can specified as non-expandable by placing it between
8960 two occurrences of &`\N`&. This is particularly useful for protecting regular
8961 expressions, which often contain backslashes and dollar signs. For example:
8962 .code
8963 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8964 .endd
8965 On encountering the first &`\N`&, the expander copies subsequent characters
8966 without interpretation until it reaches the next &`\N`& or the end of the
8967 string.
8968
8969
8970
8971 .section "Character escape sequences in expanded strings" "SECID82"
8972 .cindex "expansion" "escape sequences"
8973 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8974 expanded string is recognized as an escape sequence for the character newline,
8975 carriage return, or tab, respectively. A backslash followed by up to three
8976 octal digits is recognized as an octal encoding for a single character, and a
8977 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8978 encoding.
8979
8980 These escape sequences are also recognized in quoted strings when they are read
8981 in. Their interpretation in expansions as well is useful for unquoted strings,
8982 and for other cases such as looked-up strings that are then expanded.
8983
8984
8985 .section "Testing string expansions" "SECID83"
8986 .cindex "expansion" "testing"
8987 .cindex "testing" "string expansion"
8988 .oindex "&%-be%&"
8989 Many expansions can be tested by calling Exim with the &%-be%& option. This
8990 takes the command arguments, or lines from the standard input if there are no
8991 arguments, runs them through the string expansion code, and writes the results
8992 to the standard output. Variables based on configuration values are set up, but
8993 since no message is being processed, variables such as &$local_part$& have no
8994 value. Nevertheless the &%-be%& option can be useful for checking out file and
8995 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8996 and &%nhash%&.
8997
8998 Exim gives up its root privilege when it is called with the &%-be%& option, and
8999 instead runs under the uid and gid it was called with, to prevent users from
9000 using &%-be%& for reading files to which they do not have access.
9001
9002 .oindex "&%-bem%&"
9003 If you want to test expansions that include variables whose values are taken
9004 from a message, there are two other options that can be used. The &%-bem%&
9005 option is like &%-be%& except that it is followed by a file name. The file is
9006 read as a message before doing the test expansions. For example:
9007 .code
9008 exim -bem /tmp/test.message '$h_subject:'
9009 .endd
9010 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9011 Exim message identifier. For example:
9012 .code
9013 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9014 .endd
9015 This loads the message from Exim's spool before doing the test expansions, and
9016 is therefore restricted to admin users.
9017
9018
9019 .section "Forced expansion failure" "SECTforexpfai"
9020 .cindex "expansion" "forced failure"
9021 A number of expansions that are described in the following section have
9022 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9023 (which are sometimes called &"curly brackets"&). Which of the two strings is
9024 used depends on some condition that is evaluated as part of the expansion. If,
9025 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9026 the entire string expansion fails in a way that can be detected by the code
9027 that requested the expansion. This is called &"forced expansion failure"&, and
9028 its consequences depend on the circumstances. In some cases it is no different
9029 from any other expansion failure, but in others a different action may be
9030 taken. Such variations are mentioned in the documentation of the option that is
9031 being expanded.
9032
9033
9034
9035
9036 .section "Expansion items" "SECTexpansionitems"
9037 The following items are recognized in expanded strings. White space may be used
9038 between sub-items that are keywords or substrings enclosed in braces inside an
9039 outer set of braces, to improve readability. &*Warning*&: Within braces,
9040 white space is significant.
9041
9042 .vlist
9043 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9044 .cindex "expansion" "variables"
9045 Substitute the contents of the named variable, for example:
9046 .code
9047 $local_part
9048 ${domain}
9049 .endd
9050 The second form can be used to separate the name from subsequent alphanumeric
9051 characters. This form (using braces) is available only for variables; it does
9052 &'not'& apply to message headers. The names of the variables are given in
9053 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9054 given, the expansion fails.
9055
9056 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9057 .cindex "expansion" "operators"
9058 The string is first itself expanded, and then the operation specified by
9059 <&'op'&> is applied to it. For example:
9060 .code
9061 ${lc:$local_part}
9062 .endd
9063 The string starts with the first character after the colon, which may be
9064 leading white space. A list of operators is given in section &<<SECTexpop>>&
9065 below. The operator notation is used for simple expansion items that have just
9066 one argument, because it reduces the number of braces and therefore makes the
9067 string easier to understand.
9068
9069 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9070 This item inserts &"basic"& header lines. It is described with the &%header%&
9071 expansion item below.
9072
9073
9074 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9075 .cindex "expansion" "calling an acl"
9076 .cindex "&%acl%&" "call from expansion"
9077 The name and zero to nine argument strings are first expanded separately.  The expanded
9078 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9079 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9080 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9081 and may use the variables; if another acl expansion is used the values
9082 are restored after it returns.  If the ACL sets
9083 a value using a "message =" modifier and returns accept or deny, the value becomes
9084 the result of the expansion.
9085 If no message is set and the ACL returns accept or deny
9086 the expansion result is an empty string.
9087 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9088
9089
9090 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9091        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9092 .cindex "expansion" "extracting cerificate fields"
9093 .cindex "&%certextract%&" "certificate fields"
9094 .cindex "certificate" "extracting fields"
9095 The <&'certificate'&> must be a variable of type certificate.
9096 The field name is expanded and used to retrieve the relevant field from
9097 the certificate.  Supported fields are:
9098 .display
9099 &`version        `&
9100 &`serial_number  `&
9101 &`subject        `& RFC4514 DN
9102 &`issuer         `& RFC4514 DN
9103 &`notbefore      `& time
9104 &`notafter       `& time
9105 &`sig_algorithm  `&
9106 &`signature      `&
9107 &`subj_altname   `& tagged list
9108 &`ocsp_uri       `& list
9109 &`crl_uri        `& list
9110 .endd
9111 If the field is found,
9112 <&'string2'&> is expanded, and replaces the whole item;
9113 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9114 variable &$value$& contains the value that has been extracted. Afterwards, it
9115 is restored to any previous value it might have had.
9116
9117 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9118 key is not found. If {<&'string2'&>} is also omitted, the value that was
9119 extracted is used.
9120
9121 Some field names take optional modifiers, appended and separated by commas.
9122
9123 The field selectors marked as "RFC4514" above
9124 output a Distinguished Name string which is
9125 not quite
9126 parseable by Exim as a comma-separated tagged list
9127 (the exceptions being elements containing commas).
9128 RDN elements of a single type may be selected by
9129 a modifier of the type label; if so the expansion
9130 result is a list (newline-separated by default).
9131 The separator may be changed by another modifier of
9132 a right angle-bracket followed immediately by the new separator.
9133 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9134
9135 The field selectors marked as "time" above
9136 take an optional modifier of "int"
9137 for which the result is the number of seconds since epoch.
9138 Otherwise the result is a human-readable string
9139 in the timezone selected by the main "timezone" option.
9140
9141 The field selectors marked as "list" above return a list,
9142 newline-separated by default,
9143 (embedded separator characters in elements are doubled).
9144 The separator may be changed by a modifier of
9145 a right angle-bracket followed immediately by the new separator.
9146
9147 The field selectors marked as "tagged" above
9148 prefix each list element with a type string and an equals sign.
9149 Elements of only one type may be selected by a modifier
9150 which is one of "dns", "uri" or "mail";
9151 if so the element tags are omitted.
9152
9153 If not otherwise noted field values are presented in human-readable form.
9154
9155 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9156        {*&<&'arg'&>&*}...}*&"
9157 .cindex &%dlfunc%&
9158 This expansion dynamically loads and then calls a locally-written C function.
9159 This functionality is available only if Exim is compiled with
9160 .code
9161 EXPAND_DLFUNC=yes
9162 .endd
9163 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9164 object so that it doesn't reload the same object file in the same Exim process
9165 (but of course Exim does start new processes frequently).
9166
9167 There may be from zero to eight arguments to the function. When compiling
9168 a local function that is to be called in this way, &_local_scan.h_& should be
9169 included. The Exim variables and functions that are defined by that API
9170 are also available for dynamically loaded functions. The function itself
9171 must have the following type:
9172 .code
9173 int dlfunction(uschar **yield, int argc, uschar *argv[])
9174 .endd
9175 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9176 function should return one of the following values:
9177
9178 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9179 into the expanded string that is being built.
9180
9181 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9182 from &'yield'&, if it is set.
9183
9184 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9185 taken from &'yield'& if it is set.
9186
9187 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9188
9189 When compiling a function that is to be used in this way with gcc,
9190 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9191 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9192
9193
9194 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9195 .cindex "expansion" "extracting value from environment"
9196 .cindex "environment" "values from"
9197 The key is first expanded separately, and leading and trailing white space
9198 removed.
9199 This is then searched for as a name in the environment.
9200 If a variable is found then its value is placed in &$value$&
9201 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9202
9203 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9204 appear, for example:
9205 .code
9206 ${env{USER}{$value} fail }
9207 .endd
9208 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9209 {<&'string1'&>} must be present for &"fail"& to be recognized.
9210
9211 If {<&'string2'&>} is omitted an empty string is substituted on
9212 search failure.
9213 If {<&'string1'&>} is omitted the search result is substituted on
9214 search success.
9215
9216 The environment is adjusted by the &%keep_environment%& and
9217 &%add_environment%& main section options.
9218
9219
9220 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9221        {*&<&'string3'&>&*}}*&"
9222 .cindex "expansion" "extracting substrings by key"
9223 .cindex "&%extract%&" "substrings by key"
9224 The key and <&'string1'&> are first expanded separately. Leading and trailing
9225 white space is removed from the key (but not from any of the strings). The key
9226 must not be empty and must not consist entirely of digits.
9227 The expanded <&'string1'&> must be of the form:
9228 .display
9229 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9230 .endd
9231 .vindex "&$value$&"
9232 where the equals signs and spaces (but not both) are optional. If any of the
9233 values contain white space, they must be enclosed in double quotes, and any
9234 values that are enclosed in double quotes are subject to escape processing as
9235 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9236 for the value that corresponds to the key. The search is case-insensitive. If
9237 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9238 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9239 variable &$value$& contains the value that has been extracted. Afterwards, it
9240 is restored to any previous value it might have had.
9241
9242 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9243 key is not found. If {<&'string2'&>} is also omitted, the value that was
9244 extracted is used. Thus, for example, these two expansions are identical, and
9245 yield &"2001"&:
9246 .code
9247 ${extract{gid}{uid=1984 gid=2001}}
9248 ${extract{gid}{uid=1984 gid=2001}{$value}}
9249 .endd
9250 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9251 appear, for example:
9252 .code
9253 ${extract{Z}{A=... B=...}{$value} fail }
9254 .endd
9255 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9256 {<&'string2'&>} must be present for &"fail"& to be recognized.
9257
9258
9259 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9260         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9261 .cindex "expansion" "extracting substrings by number"
9262 .cindex "&%extract%&" "substrings by number"
9263 The <&'number'&> argument must consist entirely of decimal digits,
9264 apart from leading and trailing white space, which is ignored.
9265 This is what distinguishes this form of &%extract%& from the previous kind. It
9266 behaves in the same way, except that, instead of extracting a named field, it
9267 extracts from <&'string1'&> the field whose number is given as the first
9268 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9269 <&'string3'&> as before.
9270
9271 The fields in the string are separated by any one of the characters in the
9272 separator string. These may include space or tab characters.
9273 The first field is numbered one. If the number is negative, the fields are
9274 counted from the end of the string, with the rightmost one numbered -1. If the
9275 number given is zero, the entire string is returned. If the modulus of the
9276 number is greater than the number of fields in the string, the result is the
9277 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9278 provided. For example:
9279 .code
9280 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9281 .endd
9282 yields &"42"&, and
9283 .code
9284 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9285 .endd
9286 yields &"99"&. Two successive separators mean that the field between them is
9287 empty (for example, the fifth field above).
9288
9289
9290 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9291 .cindex "list" "selecting by condition"
9292 .cindex "expansion" "selecting from list by condition"
9293 .vindex "&$item$&"
9294 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9295 default, but the separator can be changed in the usual way. For each item
9296 in this list, its value is place in &$item$&, and then the condition is
9297 evaluated. If the condition is true, &$item$& is added to the output as an
9298 item in a new list; if the condition is false, the item is discarded. The
9299 separator used for the output list is the same as the one used for the
9300 input, but a separator setting is not included in the output. For example:
9301 .code
9302 ${filter{a:b:c}{!eq{$item}{b}}
9303 .endd
9304 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9305 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9306
9307
9308 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9309 .cindex "hash function" "textual"
9310 .cindex "expansion" "textual hash"
9311 This is a textual hashing function, and was the first to be implemented in
9312 early versions of Exim. In current releases, there are other hashing functions
9313 (numeric, MD5, and SHA-1), which are described below.
9314
9315 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9316 <&'n'&>. If you are using fixed values for these numbers, that is, if
9317 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9318 use the simpler operator notation that avoids some of the braces:
9319 .code
9320 ${hash_<n>_<m>:<string>}
9321 .endd
9322 The second number is optional (in both notations). If <&'n'&> is greater than
9323 or equal to the length of the string, the expansion item returns the string.
9324 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9325 function to the string. The new string consists of characters taken from the
9326 first <&'m'&> characters of the string
9327 .code
9328 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9329 .endd
9330 If <&'m'&> is not present the value 26 is used, so that only lower case
9331 letters appear. For example:
9332 .display
9333 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9334 &`$hash{5}{monty}}           `&   yields  &`monty`&
9335 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9336 .endd
9337
9338 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9339         &*$h_*&<&'header&~name'&>&*:*&" &&&
9340        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9341         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9342        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9343         &*$rh_*&<&'header&~name'&>&*:*&"
9344 .cindex "expansion" "header insertion"
9345 .vindex "&$header_$&"
9346 .vindex "&$bheader_$&"
9347 .vindex "&$rheader_$&"
9348 .cindex "header lines" "in expansion strings"
9349 .cindex "header lines" "character sets"
9350 .cindex "header lines" "decoding"
9351 Substitute the contents of the named message header line, for example
9352 .code
9353 $header_reply-to:
9354 .endd
9355 The newline that terminates a header line is not included in the expansion, but
9356 internal newlines (caused by splitting the header line over several physical
9357 lines) may be present.
9358
9359 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9360 the data in the header line is interpreted.
9361
9362 .ilist
9363 .cindex "white space" "in header lines"
9364 &%rheader%& gives the original &"raw"& content of the header line, with no
9365 processing at all, and without the removal of leading and trailing white space.
9366
9367 .next
9368 .cindex "base64 encoding" "in header lines"
9369 &%bheader%& removes leading and trailing white space, and then decodes base64
9370 or quoted-printable MIME &"words"& within the header text, but does no
9371 character set translation. If decoding of what looks superficially like a MIME
9372 &"word"& fails, the raw string is returned. If decoding
9373 .cindex "binary zero" "in header line"
9374 produces a binary zero character, it is replaced by a question mark &-- this is
9375 what Exim does for binary zeros that are actually received in header lines.
9376
9377 .next
9378 &%header%& tries to translate the string as decoded by &%bheader%& to a
9379 standard character set. This is an attempt to produce the same string as would
9380 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9381 returned. Translation is attempted only on operating systems that support the
9382 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9383 a system Makefile or in &_Local/Makefile_&.
9384 .endlist ilist
9385
9386 In a filter file, the target character set for &%header%& can be specified by a
9387 command of the following form:
9388 .code
9389 headers charset "UTF-8"
9390 .endd
9391 This command affects all references to &$h_$& (or &$header_$&) expansions in
9392 subsequently obeyed filter commands. In the absence of this command, the target
9393 character set in a filter is taken from the setting of the &%headers_charset%&
9394 option in the runtime configuration. The value of this option defaults to the
9395 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9396 ISO-8859-1.
9397
9398 Header names follow the syntax of RFC 2822, which states that they may contain
9399 any printing characters except space and colon. Consequently, curly brackets
9400 &'do not'& terminate header names, and should not be used to enclose them as
9401 if they were variables. Attempting to do so causes a syntax error.
9402
9403 Only header lines that are common to all copies of a message are visible to
9404 this mechanism. These are the original header lines that are received with the
9405 message, and any that are added by an ACL statement or by a system
9406 filter. Header lines that are added to a particular copy of a message by a
9407 router or transport are not accessible.
9408
9409 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9410 before the DATA ACL, because the header structure is not set up until the
9411 message is received. Header lines that are added in a RCPT ACL (for example)
9412 are saved until the message's incoming header lines are available, at which
9413 point they are added. When a DATA ACL is running, however, header lines added
9414 by earlier ACLs are visible.
9415
9416 Upper case and lower case letters are synonymous in header names. If the
9417 following character is white space, the terminating colon may be omitted, but
9418 this is not recommended, because you may then forget it when it is needed. When
9419 white space terminates the header name, this white space is included in the
9420 expanded string.  If the message does not contain the given header, the
9421 expansion item is replaced by an empty string. (See the &%def%& condition in
9422 section &<<SECTexpcond>>& for a means of testing for the existence of a
9423 header.)
9424
9425 If there is more than one header with the same name, they are all concatenated
9426 to form the substitution string, up to a maximum length of 64K. Unless
9427 &%rheader%& is being used, leading and trailing white space is removed from
9428 each header before concatenation, and a completely empty header is ignored. A
9429 newline character is then inserted between non-empty headers, but there is no
9430 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9431 those headers that contain lists of addresses, a comma is also inserted at the
9432 junctions between headers. This does not happen for the &%rheader%& expansion.
9433
9434
9435 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9436 .cindex "expansion" "hmac hashing"
9437 .cindex &%hmac%&
9438 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9439 shared secret and some text into a message authentication code, as specified in
9440 RFC 2104. This differs from &`${md5:secret_text...}`& or
9441 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9442 cryptographic hash, allowing for authentication that is not possible with MD5
9443 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9444 present. For example:
9445 .code
9446 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9447 .endd
9448 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9449 produces:
9450 .code
9451 dd97e3ba5d1a61b5006108f8c8252953
9452 .endd
9453 As an example of how this might be used, you might put in the main part of
9454 an Exim configuration:
9455 .code
9456 SPAMSCAN_SECRET=cohgheeLei2thahw
9457 .endd
9458 In a router or a transport you could then have:
9459 .code
9460 headers_add = \
9461   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9462   ${hmac{md5}{SPAMSCAN_SECRET}\
9463   {${primary_hostname},${message_exim_id},$h_message-id:}}
9464 .endd
9465 Then given a message, you can check where it was scanned by looking at the
9466 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9467 this header line is authentic by recomputing the authentication code from the
9468 host name, message ID and the &'Message-id:'& header line. This can be done
9469 using Exim's &%-be%& option, or by other means, for example by using the
9470 &'hmac_md5_hex()'& function in Perl.
9471
9472
9473 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9474 .cindex "expansion" "conditional"
9475 .cindex "&%if%&, expansion item"
9476 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9477 item; otherwise <&'string2'&> is used. The available conditions are described
9478 in section &<<SECTexpcond>>& below. For example:
9479 .code
9480 ${if eq {$local_part}{postmaster} {yes}{no} }
9481 .endd
9482 The second string need not be present; if it is not and the condition is not
9483 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9484 be present instead of the second string (without any curly brackets). In this
9485 case, the expansion is forced to fail if the condition is not true (see section
9486 &<<SECTforexpfai>>&).
9487
9488 If both strings are omitted, the result is the string &`true`& if the condition
9489 is true, and the empty string if the condition is false. This makes it less
9490 cumbersome to write custom ACL and router conditions. For example, instead of
9491 .code
9492 condition = ${if >{$acl_m4}{3}{true}{false}}
9493 .endd
9494 you can use
9495 .code
9496 condition = ${if >{$acl_m4}{3}}
9497 .endd
9498
9499
9500
9501 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9502 .cindex expansion "imap folder"
9503 .cindex "&%imapfolder%& expansion item"
9504 This item converts a (possibly multilevel, or with non-ASCII characters)
9505 folder specification to a Maildir name for filesystem use.
9506 For information on internationalisation support see &<<SECTi18nMDA>>&.
9507
9508
9509
9510 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9511 .cindex "expansion" "string truncation"
9512 .cindex "&%length%& expansion item"
9513 The &%length%& item is used to extract the initial portion of a string. Both
9514 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9515 you are using a fixed value for the number, that is, if <&'string1'&> does not
9516 change when expanded, you can use the simpler operator notation that avoids
9517 some of the braces:
9518 .code
9519 ${length_<n>:<string>}
9520 .endd
9521 The result of this item is either the first <&'n'&> characters or the whole
9522 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9523 &%strlen%&, which gives the length of a string.
9524
9525
9526 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9527         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9528 .cindex "expansion" "extracting list elements by number"
9529 .cindex "&%listextract%&" "extract list elements by number"
9530 .cindex "list" "extracting elements by number"
9531 The <&'number'&> argument must consist entirely of decimal digits,
9532 apart from an optional leading minus,
9533 and leading and trailing white space (which is ignored).
9534
9535 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9536 default, but the separator can be changed in the usual way.
9537
9538 The first field of the list is numbered one.
9539 If the number is negative, the fields are
9540 counted from the end of the list, with the rightmost one numbered -1.
9541 The numbered element of the list is extracted and placed in &$value$&,
9542 then <&'string2'&> is expanded as the result.
9543
9544 If the modulus of the
9545 number is zero or greater than the number of fields in the string,
9546 the result is the expansion of <&'string3'&>.
9547
9548 For example:
9549 .code
9550 ${listextract{2}{x:42:99}}
9551 .endd
9552 yields &"42"&, and
9553 .code
9554 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9555 .endd
9556 yields &"result: 42"&.
9557
9558 If {<&'string3'&>} is omitted, an empty string is used for string3.
9559 If {<&'string2'&>} is also omitted, the value that was
9560 extracted is used.
9561 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9562
9563
9564 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9565         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9566 This is the first of one of two different types of lookup item, which are both
9567 described in the next item.
9568
9569 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9570         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9571 .cindex "expansion" "lookup in"
9572 .cindex "file" "lookups"
9573 .cindex "lookup" "in expanded string"
9574 The two forms of lookup item specify data lookups in files and databases, as
9575 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9576 lookups, and the second is used for query-style lookups. The <&'key'&>,
9577 <&'file'&>, and <&'query'&> strings are expanded before use.
9578
9579 If there is any white space in a lookup item which is part of a filter command,
9580 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9581 other place where white space is significant, the lookup item must be enclosed
9582 in double quotes. The use of data lookups in users' filter files may be locked
9583 out by the system administrator.
9584
9585 .vindex "&$value$&"
9586 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9587 During its expansion, the variable &$value$& contains the data returned by the
9588 lookup. Afterwards it reverts to the value it had previously (at the outer
9589 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9590 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9591 string on failure. If <&'string2'&> is provided, it can itself be a nested
9592 lookup, thus providing a mechanism for looking up a default value when the
9593 original lookup fails.
9594
9595 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9596 data for the outer lookup while the parameters of the second lookup are
9597 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9598 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9599 appear, and in this case, if the lookup fails, the entire expansion is forced
9600 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9601 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9602 successful lookup, and nothing in the case of failure.
9603
9604 For single-key lookups, the string &"partial"& is permitted to precede the
9605 search type in order to do partial matching, and * or *@ may follow a search
9606 type to request default lookups if the key does not match (see sections
9607 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9608
9609 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9610 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9611 and non-wild parts of the key during the expansion of the replacement text.
9612 They return to their previous values at the end of the lookup item.
9613
9614 This example looks up the postmaster alias in the conventional alias file:
9615 .code
9616 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9617 .endd
9618 This example uses NIS+ to look up the full name of the user corresponding to
9619 the local part of an address, forcing the expansion to fail if it is not found:
9620 .code
9621 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9622   {$value}fail}
9623 .endd
9624
9625
9626 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9627 .cindex "expansion" "list creation"
9628 .vindex "&$item$&"
9629 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9630 default, but the separator can be changed in the usual way. For each item
9631 in this list, its value is place in &$item$&, and then <&'string2'&> is
9632 expanded and added to the output as an item in a new list. The separator used
9633 for the output list is the same as the one used for the input, but a separator
9634 setting is not included in the output. For example:
9635 .code
9636 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9637 .endd
9638 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9639 value of &$item$& is restored to what it was before. See also the &*filter*&
9640 and &*reduce*& expansion items.
9641
9642 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9643 .cindex "expansion" "numeric hash"
9644 .cindex "hash function" "numeric"
9645 The three strings are expanded; the first two must yield numbers. Call them
9646 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9647 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9648 can use the simpler operator notation that avoids some of the braces:
9649 .code
9650 ${nhash_<n>_<m>:<string>}
9651 .endd
9652 The second number is optional (in both notations). If there is only one number,
9653 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9654 processed by a div/mod hash function that returns two numbers, separated by a
9655 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9656 example,
9657 .code
9658 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9659 .endd
9660 returns the string &"6/33"&.
9661
9662
9663
9664 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9665 .cindex "Perl" "use in expanded string"
9666 .cindex "expansion" "calling Perl from"
9667 This item is available only if Exim has been built to include an embedded Perl
9668 interpreter. The subroutine name and the arguments are first separately
9669 expanded, and then the Perl subroutine is called with those arguments. No
9670 additional arguments need be given; the maximum number permitted, including the
9671 name of the subroutine, is nine.
9672
9673 The return value of the subroutine is inserted into the expanded string, unless
9674 the return value is &%undef%&. In that case, the expansion fails in the same
9675 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9676 Whatever you return is evaluated in a scalar context. For example, if you
9677 return the name of a Perl vector, the return value is the size of the vector,
9678 not its contents.
9679
9680 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9681 with the error message that was passed to &%die%&. More details of the embedded
9682 Perl facility are given in chapter &<<CHAPperl>>&.
9683
9684 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9685 out the use of this expansion item in filter files.
9686
9687
9688 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9689 .cindex "&%prvs%& expansion item"
9690 The first argument is a complete email address and the second is secret
9691 keystring. The third argument, specifying a key number, is optional. If absent,
9692 it defaults to 0. The result of the expansion is a prvs-signed email address,
9693 to be typically used with the &%return_path%& option on an &(smtp)& transport
9694 as part of a bounce address tag validation (BATV) scheme. For more discussion
9695 and an example, see section &<<SECTverifyPRVS>>&.
9696
9697 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9698         {*&<&'string'&>&*}}*&"
9699 .cindex "&%prvscheck%& expansion item"
9700 This expansion item is the complement of the &%prvs%& item. It is used for
9701 checking prvs-signed addresses. If the expansion of the first argument does not
9702 yield a syntactically valid prvs-signed address, the whole item expands to the
9703 empty string. When the first argument does expand to a syntactically valid
9704 prvs-signed address, the second argument is expanded, with the prvs-decoded
9705 version of the address and the key number extracted from the address in the
9706 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9707
9708 These two variables can be used in the expansion of the second argument to
9709 retrieve the secret. The validity of the prvs-signed address is then checked
9710 against the secret. The result is stored in the variable &$prvscheck_result$&,
9711 which is empty for failure or &"1"& for success.
9712
9713 The third argument is optional; if it is missing, it defaults to an empty
9714 string. This argument is now expanded. If the result is an empty string, the
9715 result of the expansion is the decoded version of the address. This is the case
9716 whether or not the signature was valid. Otherwise, the result of the expansion
9717 is the expansion of the third argument.
9718
9719 All three variables can be used in the expansion of the third argument.
9720 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9721 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9722
9723 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9724 .cindex "expansion" "inserting an entire file"
9725 .cindex "file" "inserting into expansion"
9726 .cindex "&%readfile%& expansion item"
9727 The file name and end-of-line string are first expanded separately. The file is
9728 then read, and its contents replace the entire item. All newline characters in
9729 the file are replaced by the end-of-line string if it is present. Otherwise,
9730 newlines are left in the string.
9731 String expansion is not applied to the contents of the file. If you want this,
9732 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9733 the string expansion fails.
9734
9735 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9736 locks out the use of this expansion item in filter files.
9737
9738
9739
9740 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9741         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9742 .cindex "expansion" "inserting from a socket"
9743 .cindex "socket, use of in expansion"
9744 .cindex "&%readsocket%& expansion item"
9745 This item inserts data from a Unix domain or TCP socket into the expanded
9746 string. The minimal way of using it uses just two arguments, as in these
9747 examples:
9748 .code
9749 ${readsocket{/socket/name}{request string}}
9750 ${readsocket{inet:some.host:1234}{request string}}
9751 .endd
9752 For a Unix domain socket, the first substring must be the path to the socket.
9753 For an Internet socket, the first substring must contain &`inet:`& followed by
9754 a host name or IP address, followed by a colon and a port, which can be a
9755 number or the name of a TCP port in &_/etc/services_&. An IP address may
9756 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9757 example:
9758 .code
9759 ${readsocket{inet:[::1]:1234}{request string}}
9760 .endd
9761 Only a single host name may be given, but if looking it up yields more than
9762 one IP address, they are each tried in turn until a connection is made. For
9763 both kinds of socket, Exim makes a connection, writes the request string
9764 unless it is an empty string; and no terminating NUL is ever sent)
9765 and reads from the socket until an end-of-file
9766 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9767 extend what can be done. Firstly, you can vary the timeout. For example:
9768 .code
9769 ${readsocket{/socket/name}{request string}{3s}}
9770 .endd
9771 A fourth argument allows you to change any newlines that are in the data
9772 that is read, in the same way as for &%readfile%& (see above). This example
9773 turns them into spaces:
9774 .code
9775 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9776 .endd
9777 As with all expansions, the substrings are expanded before the processing
9778 happens. Errors in these sub-expansions cause the expansion to fail. In
9779 addition, the following errors can occur:
9780
9781 .ilist
9782 Failure to create a socket file descriptor;
9783 .next
9784 Failure to connect the socket;
9785 .next
9786 Failure to write the request string;
9787 .next
9788 Timeout on reading from the socket.
9789 .endlist
9790
9791 By default, any of these errors causes the expansion to fail. However, if
9792 you supply a fifth substring, it is expanded and used when any of the above
9793 errors occurs. For example:
9794 .code
9795 ${readsocket{/socket/name}{request string}{3s}{\n}\
9796   {socket failure}}
9797 .endd
9798 You can test for the existence of a Unix domain socket by wrapping this
9799 expansion in &`${if exists`&, but there is a race condition between that test
9800 and the actual opening of the socket, so it is safer to use the fifth argument
9801 if you want to be absolutely sure of avoiding an expansion error for a
9802 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9803
9804 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9805 locks out the use of this expansion item in filter files.
9806
9807
9808 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9809 .cindex "expansion" "reducing a list to a scalar"
9810 .cindex "list" "reducing to a scalar"
9811 .vindex "&$value$&"
9812 .vindex "&$item$&"
9813 This operation reduces a list to a single, scalar string. After expansion,
9814 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9815 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9816 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9817 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9818 them. The result of that expansion is assigned to &$value$& before the next
9819 iteration. When the end of the list is reached, the final value of &$value$& is
9820 added to the expansion output. The &*reduce*& expansion item can be used in a
9821 number of ways. For example, to add up a list of numbers:
9822 .code
9823 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9824 .endd
9825 The result of that expansion would be &`6`&. The maximum of a list of numbers
9826 can be found:
9827 .code
9828 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9829 .endd
9830 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9831 restored to what they were before. See also the &*filter*& and &*map*&
9832 expansion items.
9833
9834 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9835 This item inserts &"raw"& header lines. It is described with the &%header%&
9836 expansion item above.
9837
9838 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9839         {*&<&'string2'&>&*}}*&"
9840 .cindex "expansion" "running a command"
9841 .cindex "&%run%& expansion item"
9842 The command and its arguments are first expanded as one string. The string is
9843 split apart into individual arguments by spaces, and then the command is run
9844 in a separate process, but under the same uid and gid.  As in other command
9845 executions from Exim, a shell is not used by default. If the command requires
9846 a shell, you must explicitly code it.
9847
9848 Since the arguments are split by spaces, when there is a variable expansion
9849 which has an empty result, it will cause the situation that the argument will
9850 simply be omitted when the program is actually executed by Exim. If the
9851 script/program requires a specific number of arguments and the expanded
9852 variable could possibly result in this empty expansion, the variable must be
9853 quoted. This is more difficult if the expanded variable itself could result
9854 in a string containing quotes, because it would interfere with the quotes
9855 around the command arguments. A possible guard against this is to wrap the
9856 variable in the &%sg%& operator to change any quote marks to some other
9857 character.
9858
9859 The standard input for the command exists, but is empty. The standard output
9860 and standard error are set to the same file descriptor.
9861 .cindex "return code" "from &%run%& expansion"
9862 .vindex "&$value$&"
9863 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9864 and replaces the entire item; during this expansion, the standard output/error
9865 from the command is in the variable &$value$&. If the command fails,
9866 <&'string2'&>, if present, is expanded and used. Once again, during the
9867 expansion, the standard output/error from the command is in the variable
9868 &$value$&.
9869
9870 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9871 can be the word &"fail"& (not in braces) to force expansion failure if the
9872 command does not succeed. If both strings are omitted, the result is contents
9873 of the standard output/error on success, and nothing on failure.
9874
9875 .vindex "&$run_in_acl$&"
9876 The standard output/error of the command is put in the variable &$value$&.
9877 In this ACL example, the output of a command is logged for the admin to
9878 troubleshoot:
9879 .code
9880 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9881       log_message  = Output of id: $value
9882 .endd
9883 If the command requires shell idioms, such as the > redirect operator, the
9884 shell must be invoked directly, such as with:
9885 .code
9886 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9887 .endd
9888
9889 .vindex "&$runrc$&"
9890 The return code from the command is put in the variable &$runrc$&, and this
9891 remains set afterwards, so in a filter file you can do things like this:
9892 .code
9893 if "${run{x y z}{}}$runrc" is 1 then ...
9894   elif $runrc is 2 then ...
9895   ...
9896 endif
9897 .endd
9898 If execution of the command fails (for example, the command does not exist),
9899 the return code is 127 &-- the same code that shells use for non-existent
9900 commands.
9901
9902 &*Warning*&: In a router or transport, you cannot assume the order in which
9903 option values are expanded, except for those preconditions whose order of
9904 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9905 by the expansion of one option, and use it in another.
9906
9907 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9908 out the use of this expansion item in filter files.
9909
9910
9911 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9912 .cindex "expansion" "string substitution"
9913 .cindex "&%sg%& expansion item"
9914 This item works like Perl's substitution operator (s) with the global (/g)
9915 option; hence its name. However, unlike the Perl equivalent, Exim does not
9916 modify the subject string; instead it returns the modified string for insertion
9917 into the overall expansion. The item takes three arguments: the subject string,
9918 a regular expression, and a substitution string. For example:
9919 .code
9920 ${sg{abcdefabcdef}{abc}{xyz}}
9921 .endd
9922 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9923 if any $ or \ characters are required in the regular expression or in the
9924 substitution string, they have to be escaped. For example:
9925 .code
9926 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9927 .endd
9928 yields &"defabc"&, and
9929 .code
9930 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9931 .endd
9932 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9933 the regular expression from string expansion.
9934
9935
9936
9937 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9938 .cindex sorting "a list"
9939 .cindex list sorting
9940 .cindex expansion "list sorting"
9941 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9942 default, but the separator can be changed in the usual way.
9943 The <&'comparator'&> argument is interpreted as the operator
9944 of a two-argument expansion condition.
9945 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9946 The comparison should return true when applied to two values
9947 if the first value should sort before the second value.
9948 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9949 the element being placed in &$item$&,
9950 to give values for comparison.
9951
9952 The item result is a sorted list,
9953 with the original list separator,
9954 of the list elements (in full) of the original.
9955
9956 Examples:
9957 .code
9958 ${sort{3:2:1:4}{<}{$item}}
9959 .endd
9960 sorts a list of numbers, and
9961 .code
9962 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9963 .endd
9964 will sort an MX lookup into priority order.
9965
9966
9967 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9968 .cindex "&%substr%& expansion item"
9969 .cindex "substring extraction"
9970 .cindex "expansion" "substring extraction"
9971 The three strings are expanded; the first two must yield numbers. Call them
9972 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9973 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9974 can use the simpler operator notation that avoids some of the braces:
9975 .code
9976 ${substr_<n>_<m>:<string>}
9977 .endd
9978 The second number is optional (in both notations).
9979 If it is absent in the simpler format, the preceding underscore must also be
9980 omitted.
9981
9982 The &%substr%& item can be used to extract more general substrings than
9983 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9984 length required. For example
9985 .code
9986 ${substr{3}{2}{$local_part}}
9987 .endd
9988 If the starting offset is greater than the string length the result is the
9989 null string; if the length plus starting offset is greater than the string
9990 length, the result is the right-hand part of the string, starting from the
9991 given offset. The first character in the string has offset zero.
9992
9993 The &%substr%& expansion item can take negative offset values to count
9994 from the right-hand end of its operand. The last character is offset -1, the
9995 second-last is offset -2, and so on. Thus, for example,
9996 .code
9997 ${substr{-5}{2}{1234567}}
9998 .endd
9999 yields &"34"&. If the absolute value of a negative offset is greater than the
10000 length of the string, the substring starts at the beginning of the string, and
10001 the length is reduced by the amount of overshoot. Thus, for example,
10002 .code
10003 ${substr{-5}{2}{12}}
10004 .endd
10005 yields an empty string, but
10006 .code
10007 ${substr{-3}{2}{12}}
10008 .endd
10009 yields &"1"&.
10010
10011 When the second number is omitted from &%substr%&, the remainder of the string
10012 is taken if the offset is positive. If it is negative, all characters in the
10013 string preceding the offset point are taken. For example, an offset of -1 and
10014 no length, as in these semantically identical examples:
10015 .code
10016 ${substr_-1:abcde}
10017 ${substr{-1}{abcde}}
10018 .endd
10019 yields all but the last character of the string, that is, &"abcd"&.
10020
10021
10022
10023 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10024         {*&<&'replacements'&>&*}}*&"
10025 .cindex "expansion" "character translation"
10026 .cindex "&%tr%& expansion item"
10027 This item does single-character translation on its subject string. The second
10028 argument is a list of characters to be translated in the subject string. Each
10029 matching character is replaced by the corresponding character from the
10030 replacement list. For example
10031 .code
10032 ${tr{abcdea}{ac}{13}}
10033 .endd
10034 yields &`1b3de1`&. If there are duplicates in the second character string, the
10035 last occurrence is used. If the third string is shorter than the second, its
10036 last character is replicated. However, if it is empty, no translation takes
10037 place.
10038 .endlist
10039
10040
10041
10042 .section "Expansion operators" "SECTexpop"
10043 .cindex "expansion" "operators"
10044 For expansion items that perform transformations on a single argument string,
10045 the &"operator"& notation is used because it is simpler and uses fewer braces.
10046 The substring is first expanded before the operation is applied to it. The
10047 following operations can be performed:
10048
10049 .vlist
10050 .vitem &*${address:*&<&'string'&>&*}*&
10051 .cindex "expansion" "RFC 2822 address handling"
10052 .cindex "&%address%& expansion item"
10053 The string is interpreted as an RFC 2822 address, as it might appear in a
10054 header line, and the effective address is extracted from it. If the string does
10055 not parse successfully, the result is empty.
10056
10057
10058 .vitem &*${addresses:*&<&'string'&>&*}*&
10059 .cindex "expansion" "RFC 2822 address handling"
10060 .cindex "&%addresses%& expansion item"
10061 The string (after expansion) is interpreted as a list of addresses in RFC
10062 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10063 operative address (&'local-part@domain'&) is extracted from each item, and the
10064 result of the expansion is a colon-separated list, with appropriate
10065 doubling of colons should any happen to be present in the email addresses.
10066 Syntactically invalid RFC2822 address items are omitted from the output.
10067
10068 It is possible to specify a character other than colon for the output
10069 separator by starting the string with > followed by the new separator
10070 character. For example:
10071 .code
10072 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10073 .endd
10074 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10075 expansion item, which extracts the working address from a single RFC2822
10076 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10077 processing lists.
10078
10079 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10080 a strict interpretation of header line formatting.  Exim parses the bare,
10081 unquoted portion of an email address and if it finds a comma, treats it as an
10082 email address separator. For the example header line:
10083 .code
10084 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10085 .endd
10086 The first example below demonstrates that Q-encoded email addresses are parsed
10087 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10088 It does not see the comma because it's still encoded as "=2C".  The second
10089 example below is passed the contents of &`$header_from:`&, meaning it gets
10090 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10091 The third example shows that the presence of a comma is skipped when it is
10092 quoted.
10093 .code
10094 # exim -be '${addresses:From: \
10095 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10096 user@example.com
10097 # exim -be '${addresses:From: Last, First <user@example.com>}'
10098 Last:user@example.com
10099 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10100 user@example.com
10101 .endd
10102
10103 .new
10104 .vitem &*${base32:*&<&'digits'&>&*}*&
10105 .cindex "&%base32%& expansion item"
10106 .cindex "expansion" "conversion to base 32"
10107 The string must consist entirely of decimal digits. The number is converted to
10108 base 32 and output as a (empty, for zero) string of characters.
10109 Only lowercase letters are used.
10110
10111 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10112 .cindex "&%base32d%& expansion item"
10113 .cindex "expansion" "conversion to base 32"
10114 The string must consist entirely of base-32 digits.
10115 The number is converted to decimal and output as a string.
10116 .wen
10117
10118 .vitem &*${base62:*&<&'digits'&>&*}*&
10119 .cindex "&%base62%& expansion item"
10120 .cindex "expansion" "conversion to base 62"
10121 The string must consist entirely of decimal digits. The number is converted to
10122 base 62 and output as a string of six characters, including leading zeros. In
10123 the few operating environments where Exim uses base 36 instead of base 62 for
10124 its message identifiers (because those systems do not have case-sensitive file
10125 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10126 be absolutely clear: this is &'not'& base64 encoding.
10127
10128 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10129 .cindex "&%base62d%& expansion item"
10130 .cindex "expansion" "conversion to base 62"
10131 The string must consist entirely of base-62 digits, or, in operating
10132 environments where Exim uses base 36 instead of base 62 for its message
10133 identifiers, base-36 digits. The number is converted to decimal and output as a
10134 string.
10135
10136 .vitem &*${base64:*&<&'string'&>&*}*&
10137 .cindex "expansion" "base64 encoding"
10138 .cindex "base64 encoding" "in string expansion"
10139 .cindex "&%base64%& expansion item"
10140 .cindex certificate "base64 of DER"
10141 This operator converts a string into one that is base64 encoded.
10142
10143 If the string is a single variable of type certificate,
10144 returns the base64 encoding of the DER form of the certificate.
10145
10146
10147 .vitem &*${base64d:*&<&'string'&>&*}*&
10148 .cindex "expansion" "base64 decoding"
10149 .cindex "base64 decoding" "in string expansion"
10150 .cindex "&%base64d%& expansion item"
10151 This operator converts a base64-encoded string into the un-coded form.
10152
10153
10154 .vitem &*${domain:*&<&'string'&>&*}*&
10155 .cindex "domain" "extraction"
10156 .cindex "expansion" "domain extraction"
10157 The string is interpreted as an RFC 2822 address and the domain is extracted
10158 from it. If the string does not parse successfully, the result is empty.
10159
10160
10161 .vitem &*${escape:*&<&'string'&>&*}*&
10162 .cindex "expansion" "escaping non-printing characters"
10163 .cindex "&%escape%& expansion item"
10164 If the string contains any non-printing characters, they are converted to
10165 escape sequences starting with a backslash. Whether characters with the most
10166 significant bit set (so-called &"8-bit characters"&) count as printing or not
10167 is controlled by the &%print_topbitchars%& option.
10168
10169 .new
10170 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10171 .cindex "expansion" "escaping 8-bit characters"
10172 .cindex "&%escape8bit%& expansion item"
10173 If the string contains and characters with the most significant bit set,
10174 they are converted to escape sequences starting with a backslash.
10175 Backslashes and DEL characters are also converted.
10176 .wen
10177
10178
10179 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10180 .cindex "expansion" "expression evaluation"
10181 .cindex "expansion" "arithmetic expression"
10182 .cindex "&%eval%& expansion item"
10183 These items supports simple arithmetic and bitwise logical operations in
10184 expansion strings. The string (after expansion) must be a conventional
10185 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10186 logical operators, and parentheses. All operations are carried out using
10187 integer arithmetic. The operator priorities are as follows (the same as in the
10188 C programming language):
10189 .table2 70pt 300pt
10190 .irow &'highest:'& "not (~), negate (-)"
10191 .irow ""   "multiply (*), divide (/), remainder (%)"
10192 .irow ""   "plus (+), minus (-)"
10193 .irow ""   "shift-left (<<), shift-right (>>)"
10194 .irow ""   "and (&&)"
10195 .irow ""   "xor (^)"
10196 .irow &'lowest:'&  "or (|)"
10197 .endtable
10198 Binary operators with the same priority are evaluated from left to right. White
10199 space is permitted before or after operators.
10200
10201 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10202 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10203 decimal, even if they start with a leading zero; hexadecimal numbers are not
10204 permitted. This can be useful when processing numbers extracted from dates or
10205 times, which often do have leading zeros.
10206
10207 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10208 or 1024*1024*1024,
10209 respectively. Negative numbers are supported. The result of the computation is
10210 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10211
10212 .display
10213 &`${eval:1+1}            `&  yields 2
10214 &`${eval:1+2*3}          `&  yields 7
10215 &`${eval:(1+2)*3}        `&  yields 9
10216 &`${eval:2+42%5}         `&  yields 4
10217 &`${eval:0xc&amp;5}          `&  yields 4
10218 &`${eval:0xc|5}          `&  yields 13
10219 &`${eval:0xc^5}          `&  yields 9
10220 &`${eval:0xc>>1}         `&  yields 6
10221 &`${eval:0xc<<1}         `&  yields 24
10222 &`${eval:~255&amp;0x1234}    `&  yields 4608
10223 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10224 .endd
10225
10226 As a more realistic example, in an ACL you might have
10227 .code
10228 deny   message = Too many bad recipients
10229        condition =                    \
10230          ${if and {                   \
10231            {>{$rcpt_count}{10}}       \
10232            {                          \
10233            <                          \
10234              {$recipients_count}      \
10235              {${eval:$rcpt_count/2}}  \
10236            }                          \
10237          }{yes}{no}}
10238 .endd
10239 The condition is true if there have been more than 10 RCPT commands and
10240 fewer than half of them have resulted in a valid recipient.
10241
10242
10243 .vitem &*${expand:*&<&'string'&>&*}*&
10244 .cindex "expansion" "re-expansion of substring"
10245 The &%expand%& operator causes a string to be expanded for a second time. For
10246 example,
10247 .code
10248 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10249 .endd
10250 first looks up a string in a file while expanding the operand for &%expand%&,
10251 and then re-expands what it has found.
10252
10253
10254 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10255 .cindex "Unicode"
10256 .cindex "UTF-8" "conversion from"
10257 .cindex "expansion" "UTF-8 conversion"
10258 .cindex "&%from_utf8%& expansion item"
10259 The world is slowly moving towards Unicode, although there are no standards for
10260 email yet. However, other applications (including some databases) are starting
10261 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10262 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10263 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10264 the result is an undefined sequence of bytes.
10265
10266 Unicode code points with values less than 256 are compatible with ASCII and
10267 ISO-8859-1 (also known as Latin-1).
10268 For example, character 169 is the copyright symbol in both cases, though the
10269 way it is encoded is different. In UTF-8, more than one byte is needed for
10270 characters with code values greater than 127, whereas ISO-8859-1 is a
10271 single-byte encoding (but thereby limited to 256 characters). This makes
10272 translation from UTF-8 to ISO-8859-1 straightforward.
10273
10274
10275 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10276 .cindex "hash function" "textual"
10277 .cindex "expansion" "textual hash"
10278 The &%hash%& operator is a simpler interface to the hashing function that can
10279 be used when the two parameters are fixed numbers (as opposed to strings that
10280 change when expanded). The effect is the same as
10281 .code
10282 ${hash{<n>}{<m>}{<string>}}
10283 .endd
10284 See the description of the general &%hash%& item above for details. The
10285 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10286
10287
10288
10289 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10290 .cindex "base64 encoding" "conversion from hex"
10291 .cindex "expansion" "hex to base64"
10292 .cindex "&%hex2b64%& expansion item"
10293 This operator converts a hex string into one that is base64 encoded. This can
10294 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10295
10296
10297
10298 .vitem &*${hexquote:*&<&'string'&>&*}*&
10299 .cindex "quoting" "hex-encoded unprintable characters"
10300 .cindex "&%hexquote%& expansion item"
10301 This operator converts non-printable characters in a string into a hex
10302 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10303 as is, and other byte values are converted to &`\xNN`&, for example a
10304 byte value 127 is converted to &`\x7f`&.
10305
10306
10307 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10308 .cindex "&%ipv6denorm%& expansion item"
10309 .cindex "IP address" normalisation
10310 This expands an IPv6 address to a full eight-element colon-separated set
10311 of hex digits including leading zeroes.
10312 A trailing ipv4-style dotted-decimal set is converted to hex.
10313 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10314
10315 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10316 .cindex "&%ipv6norm%& expansion item"
10317 .cindex "IP address" normalisation
10318 .cindex "IP address" "canonical form"
10319 This converts an IPv6 address to canonical form.
10320 Leading zeroes of groups are omitted, and the longest
10321 set of zero-valued groups is replaced with a double colon.
10322 A trailing ipv4-style dotted-decimal set is converted to hex.
10323 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10324
10325
10326 .vitem &*${lc:*&<&'string'&>&*}*&
10327 .cindex "case forcing in strings"
10328 .cindex "string" "case forcing"
10329 .cindex "lower casing"
10330 .cindex "expansion" "case forcing"
10331 .cindex "&%lc%& expansion item"
10332 This forces the letters in the string into lower-case, for example:
10333 .code
10334 ${lc:$local_part}
10335 .endd
10336
10337 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10338 .cindex "expansion" "string truncation"
10339 .cindex "&%length%& expansion item"
10340 The &%length%& operator is a simpler interface to the &%length%& function that
10341 can be used when the parameter is a fixed number (as opposed to a string that
10342 changes when expanded). The effect is the same as
10343 .code
10344 ${length{<number>}{<string>}}
10345 .endd
10346 See the description of the general &%length%& item above for details. Note that
10347 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10348 when &%length%& is used as an operator.
10349
10350
10351 .vitem &*${listcount:*&<&'string'&>&*}*&
10352 .cindex "expansion" "list item count"
10353 .cindex "list" "item count"
10354 .cindex "list" "count of items"
10355 .cindex "&%listcount%& expansion item"
10356 The string is interpreted as a list and the number of items is returned.
10357
10358
10359 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10360 .cindex "expansion" "named list"
10361 .cindex "&%listnamed%& expansion item"
10362 The name is interpreted as a named list and the content of the list is returned,
10363 expanding any referenced lists, re-quoting as needed for colon-separation.
10364 If the optional type is given it must be one of "a", "d", "h" or "l"
10365 and selects address-, domain-, host- or localpart- lists to search among respectively.
10366 Otherwise all types are searched in an undefined order and the first
10367 matching list is returned.
10368
10369
10370 .vitem &*${local_part:*&<&'string'&>&*}*&
10371 .cindex "expansion" "local part extraction"
10372 .cindex "&%local_part%& expansion item"
10373 The string is interpreted as an RFC 2822 address and the local part is
10374 extracted from it. If the string does not parse successfully, the result is
10375 empty.
10376
10377
10378 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10379 .cindex "masked IP address"
10380 .cindex "IP address" "masking"
10381 .cindex "CIDR notation"
10382 .cindex "expansion" "IP address masking"
10383 .cindex "&%mask%& expansion item"
10384 If the form of the string to be operated on is not an IP address followed by a
10385 slash and an integer (that is, a network address in CIDR notation), the
10386 expansion fails. Otherwise, this operator converts the IP address to binary,
10387 masks off the least significant bits according to the bit count, and converts
10388 the result back to text, with mask appended. For example,
10389 .code
10390 ${mask:10.111.131.206/28}
10391 .endd
10392 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10393 be mostly used for looking up masked addresses in files, the result for an IPv6
10394 address uses dots to separate components instead of colons, because colon
10395 terminates a key string in lsearch files. So, for example,
10396 .code
10397 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10398 .endd
10399 returns the string
10400 .code
10401 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10402 .endd
10403 Letters in IPv6 addresses are always output in lower case.
10404
10405
10406 .vitem &*${md5:*&<&'string'&>&*}*&
10407 .cindex "MD5 hash"
10408 .cindex "expansion" "MD5 hash"
10409 .cindex certificate fingerprint
10410 .cindex "&%md5%& expansion item"
10411 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10412 as a 32-digit hexadecimal number, in which any letters are in lower case.
10413
10414 If the string is a single variable of type certificate,
10415 returns the MD5 hash fingerprint of the certificate.
10416
10417
10418 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10419 .cindex "expansion" "numeric hash"
10420 .cindex "hash function" "numeric"
10421 The &%nhash%& operator is a simpler interface to the numeric hashing function
10422 that can be used when the two parameters are fixed numbers (as opposed to
10423 strings that change when expanded). The effect is the same as
10424 .code
10425 ${nhash{<n>}{<m>}{<string>}}
10426 .endd
10427 See the description of the general &%nhash%& item above for details.
10428
10429
10430 .vitem &*${quote:*&<&'string'&>&*}*&
10431 .cindex "quoting" "in string expansions"
10432 .cindex "expansion" "quoting"
10433 .cindex "&%quote%& expansion item"
10434 The &%quote%& operator puts its argument into double quotes if it
10435 is an empty string or
10436 contains anything other than letters, digits, underscores, dots, and hyphens.
10437 Any occurrences of double quotes and backslashes are escaped with a backslash.
10438 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10439 respectively For example,
10440 .code
10441 ${quote:ab"*"cd}
10442 .endd
10443 becomes
10444 .code
10445 "ab\"*\"cd"
10446 .endd
10447 The place where this is useful is when the argument is a substitution from a
10448 variable or a message header.
10449
10450 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10451 .cindex "&%quote_local_part%& expansion item"
10452 This operator is like &%quote%&, except that it quotes the string only if
10453 required to do so by the rules of RFC 2822 for quoting local parts. For
10454 example, a plus sign would not cause quoting (but it would for &%quote%&).
10455 If you are creating a new email address from the contents of &$local_part$&
10456 (or any other unknown data), you should always use this operator.
10457
10458
10459 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10460 .cindex "quoting" "lookup-specific"
10461 This operator applies lookup-specific quoting rules to the string. Each
10462 query-style lookup type has its own quoting rules which are described with
10463 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10464 .code
10465 ${quote_ldap:two * two}
10466 .endd
10467 returns
10468 .code
10469 two%20%5C2A%20two
10470 .endd
10471 For single-key lookup types, no quoting is ever necessary and this operator
10472 yields an unchanged string.
10473
10474
10475 .vitem &*${randint:*&<&'n'&>&*}*&
10476 .cindex "random number"
10477 This operator returns a somewhat random number which is less than the
10478 supplied number and is at least 0.  The quality of this randomness depends
10479 on how Exim was built; the values are not suitable for keying material.
10480 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10481 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10482 for versions of GnuTLS with that function.
10483 Otherwise, the implementation may be arc4random(), random() seeded by
10484 srandomdev() or srandom(), or a custom implementation even weaker than
10485 random().
10486
10487
10488 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10489 .cindex "expansion" "IP address"
10490 This operator reverses an IP address; for IPv4 addresses, the result is in
10491 dotted-quad decimal form, while for IPv6 addresses the result is in
10492 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10493 for DNS.  For example,
10494 .code
10495 ${reverse_ip:192.0.2.4}
10496 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10497 .endd
10498 returns
10499 .code
10500 4.2.0.192
10501 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
10502 .endd
10503
10504
10505 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10506 .cindex "expansion" "RFC 2047"
10507 .cindex "RFC 2047" "expansion operator"
10508 .cindex "&%rfc2047%& expansion item"
10509 This operator encodes text according to the rules of RFC 2047. This is an
10510 encoding that is used in header lines to encode non-ASCII characters. It is
10511 assumed that the input string is in the encoding specified by the
10512 &%headers_charset%& option, which gets its default at build time. If the string
10513 contains only characters in the range 33&--126, and no instances of the
10514 characters
10515 .code
10516 ? = ( ) < > @ , ; : \ " . [ ] _
10517 .endd
10518 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10519 string, using as many &"encoded words"& as necessary to encode all the
10520 characters.
10521
10522
10523 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10524 .cindex "expansion" "RFC 2047"
10525 .cindex "RFC 2047" "decoding"
10526 .cindex "&%rfc2047d%& expansion item"
10527 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10528 bytes are replaced by question marks. Characters are converted into the
10529 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10530 not recognized unless &%check_rfc2047_length%& is set false.
10531
10532 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10533 access a header line, RFC 2047 decoding is done automatically. You do not need
10534 to use this operator as well.
10535
10536
10537
10538 .vitem &*${rxquote:*&<&'string'&>&*}*&
10539 .cindex "quoting" "in regular expressions"
10540 .cindex "regular expressions" "quoting"
10541 .cindex "&%rxquote%& expansion item"
10542 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10543 characters in its argument. This is useful when substituting the values of
10544 variables or headers inside regular expressions.
10545
10546
10547 .vitem &*${sha1:*&<&'string'&>&*}*&
10548 .cindex "SHA-1 hash"
10549 .cindex "expansion" "SHA-1 hashing"
10550 .cindex certificate fingerprint
10551 .cindex "&%sha1%& expansion item"
10552 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10553 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10554
10555 If the string is a single variable of type certificate,
10556 returns the SHA-1 hash fingerprint of the certificate.
10557
10558
10559 .vitem &*${sha256:*&<&'string'&>&*}*&
10560 .cindex "SHA-256 hash"
10561 .cindex certificate fingerprint
10562 .cindex "expansion" "SHA-256 hashing"
10563 .cindex "&%sha256%& expansion item"
10564 .new
10565 The &%sha256%& operator computes the SHA-256 hash value of the string
10566 and returns
10567 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10568 .wen
10569
10570 If the string is a single variable of type certificate,
10571 returns the SHA-256 hash fingerprint of the certificate.
10572
10573
10574 .new
10575 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10576        &*${sha3_<n>:*&<&'string'&>&*}*&
10577 .cindex "SHA3 hash"
10578 .cindex "expansion" "SHA3 hashing"
10579 .cindex "&%sha3%& expansion item"
10580 The &%sha3%& operator computes the SHA3-256 hash value of the string
10581 and returns
10582 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10583
10584 If a number is appended, separated by an underbar, it specifies
10585 the output length.  Values of 224, 256, 384 and 512 are accepted;
10586 with 256 being the default.
10587
10588 The &%sha3%& expansion item is only supported if Exim has been
10589 compiled with GnuTLS 3.5.0 or later.
10590 .wen
10591
10592
10593 .vitem &*${stat:*&<&'string'&>&*}*&
10594 .cindex "expansion" "statting a file"
10595 .cindex "file" "extracting characteristics"
10596 .cindex "&%stat%& expansion item"
10597 The string, after expansion, must be a file path. A call to the &[stat()]&
10598 function is made for this path. If &[stat()]& fails, an error occurs and the
10599 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10600 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10601 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10602 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10603 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10604 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10605 can extract individual fields using the &%extract%& expansion item.
10606
10607 The use of the &%stat%& expansion in users' filter files can be locked out by
10608 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10609 systems for files larger than 2GB.
10610
10611 .vitem &*${str2b64:*&<&'string'&>&*}*&
10612 .cindex "&%str2b64%& expansion item"
10613 Now deprecated, a synonym for the &%base64%& expansion operator.
10614
10615
10616
10617 .vitem &*${strlen:*&<&'string'&>&*}*&
10618 .cindex "expansion" "string length"
10619 .cindex "string" "length in expansion"
10620 .cindex "&%strlen%& expansion item"
10621 The item is replace by the length of the expanded string, expressed as a
10622 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10623
10624
10625 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10626 .cindex "&%substr%& expansion item"
10627 .cindex "substring extraction"
10628 .cindex "expansion" "substring expansion"
10629 The &%substr%& operator is a simpler interface to the &%substr%& function that
10630 can be used when the two parameters are fixed numbers (as opposed to strings
10631 that change when expanded). The effect is the same as
10632 .code
10633 ${substr{<start>}{<length>}{<string>}}
10634 .endd
10635 See the description of the general &%substr%& item above for details. The
10636 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10637
10638 .vitem &*${time_eval:*&<&'string'&>&*}*&
10639 .cindex "&%time_eval%& expansion item"
10640 .cindex "time interval" "decoding"
10641 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10642 seconds.
10643
10644 .vitem &*${time_interval:*&<&'string'&>&*}*&
10645 .cindex "&%time_interval%& expansion item"
10646 .cindex "time interval" "formatting"
10647 The argument (after sub-expansion) must be a sequence of decimal digits that
10648 represents an interval of time as a number of seconds. It is converted into a
10649 number of larger units and output in Exim's normal time format, for example,
10650 &`1w3d4h2m6s`&.
10651
10652 .vitem &*${uc:*&<&'string'&>&*}*&
10653 .cindex "case forcing in strings"
10654 .cindex "string" "case forcing"
10655 .cindex "upper casing"
10656 .cindex "expansion" "case forcing"
10657 .cindex "&%uc%& expansion item"
10658 This forces the letters in the string into upper-case.
10659
10660 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10661 .cindex "correction of invalid utf-8 sequences in strings"
10662 .cindex "utf-8" "utf-8 sequences"
10663 .cindex "incorrect utf-8"
10664 .cindex "expansion" "utf-8 forcing"
10665 .cindex "&%utf8clean%& expansion item"
10666 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10667
10668 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10669        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10670        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10671        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10672 .cindex expansion UTF-8
10673 .cindex UTF-8 expansion
10674 .cindex EAI
10675 .cindex internationalisation
10676 .cindex "&%utf8_domain_to_alabel%& expansion item"
10677 .cindex "&%utf8_domain_from_alabel%& expansion item"
10678 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10679 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10680 These convert EAI mail name components between UTF-8 and a-label forms.
10681 For information on internationalisation support see &<<SECTi18nMTA>>&.
10682 .endlist
10683
10684
10685
10686
10687
10688
10689 .section "Expansion conditions" "SECTexpcond"
10690 .scindex IIDexpcond "expansion" "conditions"
10691 The following conditions are available for testing by the &%${if%& construct
10692 while expanding strings:
10693
10694 .vlist
10695 .vitem &*!*&<&'condition'&>
10696 .cindex "expansion" "negating a condition"
10697 .cindex "negation" "in expansion condition"
10698 Preceding any condition with an exclamation mark negates the result of the
10699 condition.
10700
10701 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10702 .cindex "numeric comparison"
10703 .cindex "expansion" "numeric comparison"
10704 There are a number of symbolic operators for doing numeric comparisons. They
10705 are:
10706 .display
10707 &`=   `&   equal
10708 &`==  `&   equal
10709 &`>   `&   greater
10710 &`>=  `&   greater or equal
10711 &`<   `&   less
10712 &`<=  `&   less or equal
10713 .endd
10714 For example:
10715 .code
10716 ${if >{$message_size}{10M} ...
10717 .endd
10718 Note that the general negation operator provides for inequality testing. The
10719 two strings must take the form of optionally signed decimal integers,
10720 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10721 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10722 As a special case, the numerical value of an empty string is taken as
10723 zero.
10724
10725 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10726 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10727 10M, not if 10M is larger than &$message_size$&.
10728
10729
10730 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10731         {*&<&'arg2'&>&*}...}*&
10732 .cindex "expansion" "calling an acl"
10733 .cindex "&%acl%&" "expansion condition"
10734 The name and zero to nine argument strings are first expanded separately.  The expanded
10735 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10736 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10737 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10738 and may use the variables; if another acl expansion is used the values
10739 are restored after it returns.  If the ACL sets
10740 a value using a "message =" modifier the variable $value becomes
10741 the result of the expansion, otherwise it is empty.
10742 If the ACL returns accept the condition is true; if deny, false.
10743 If the ACL returns defer the result is a forced-fail.
10744
10745 .vitem &*bool&~{*&<&'string'&>&*}*&
10746 .cindex "expansion" "boolean parsing"
10747 .cindex "&%bool%& expansion condition"
10748 This condition turns a string holding a true or false representation into
10749 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10750 (case-insensitively); also integer numbers map to true if non-zero,
10751 false if zero.
10752 An empty string is treated as false.
10753 Leading and trailing whitespace is ignored;
10754 thus a string consisting only of whitespace is false.
10755 All other string values will result in expansion failure.
10756
10757 When combined with ACL variables, this expansion condition will let you
10758 make decisions in one place and act on those decisions in another place.
10759 For example:
10760 .code
10761 ${if bool{$acl_m_privileged_sender} ...
10762 .endd
10763
10764
10765 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10766 .cindex "expansion" "boolean parsing"
10767 .cindex "&%bool_lax%& expansion condition"
10768 Like &%bool%&, this condition turns a string into a boolean state.  But
10769 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10770 loose definition that the Router &%condition%& option uses.  The empty string
10771 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10772 true.  Leading and trailing whitespace is ignored.
10773
10774 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10775
10776 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10777 .cindex "expansion" "encrypted comparison"
10778 .cindex "encrypted strings, comparing"
10779 .cindex "&%crypteq%& expansion condition"
10780 This condition is included in the Exim binary if it is built to support any
10781 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10782 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10783 included in the binary.
10784
10785 The &%crypteq%& condition has two arguments. The first is encrypted and
10786 compared against the second, which is already encrypted. The second string may
10787 be in the LDAP form for storing encrypted strings, which starts with the
10788 encryption type in curly brackets, followed by the data. If the second string
10789 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10790 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10791 Typically this will be a field from a password file. An example of an encrypted
10792 string in LDAP form is:
10793 .code
10794 {md5}CY9rzUYh03PK3k6DJie09g==
10795 .endd
10796 If such a string appears directly in an expansion, the curly brackets have to
10797 be quoted, because they are part of the expansion syntax. For example:
10798 .code
10799 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10800 .endd
10801 The following encryption types (whose names are matched case-independently) are
10802 supported:
10803
10804 .ilist
10805 .cindex "MD5 hash"
10806 .cindex "base64 encoding" "in encrypted password"
10807 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10808 printable characters to compare with the remainder of the second string. If the
10809 length of the comparison string is 24, Exim assumes that it is base64 encoded
10810 (as in the above example). If the length is 32, Exim assumes that it is a
10811 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10812 comparison fails.
10813
10814 .next
10815 .cindex "SHA-1 hash"
10816 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10817 printable characters to compare with the remainder of the second string. If the
10818 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10819 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10820 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10821
10822 .next
10823 .cindex "&[crypt()]&"
10824 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10825 only the first eight characters of the password. However, in modern operating
10826 systems this is no longer true, and in many cases the entire password is used,
10827 whatever its length.
10828
10829 .next
10830 .cindex "&[crypt16()]&"
10831 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10832 use up to 16 characters of the password in some operating systems. Again, in
10833 modern operating systems, more characters may be used.
10834 .endlist
10835 Exim has its own version of &[crypt16()]&, which is just a double call to
10836 &[crypt()]&. For operating systems that have their own version, setting
10837 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10838 operating system version instead of its own. This option is set by default in
10839 the OS-dependent &_Makefile_& for those operating systems that are known to
10840 support &[crypt16()]&.
10841
10842 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10843 it was not using the same algorithm as some operating systems' versions. It
10844 turns out that as well as &[crypt16()]& there is a function called
10845 &[bigcrypt()]& in some operating systems. This may or may not use the same
10846 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10847
10848 However, since there is now a move away from the traditional &[crypt()]&
10849 functions towards using SHA1 and other algorithms, tidying up this area of
10850 Exim is seen as very low priority.
10851
10852 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10853 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10854 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10855 default is &`{crypt}`&. Whatever the default, you can always use either
10856 function by specifying it explicitly in curly brackets.
10857
10858 .vitem &*def:*&<&'variable&~name'&>
10859 .cindex "expansion" "checking for empty variable"
10860 .cindex "&%def%& expansion condition"
10861 The &%def%& condition must be followed by the name of one of the expansion
10862 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10863 variable does not contain the empty string. For example:
10864 .code
10865 ${if def:sender_ident {from $sender_ident}}
10866 .endd
10867 Note that the variable name is given without a leading &%$%& character. If the
10868 variable does not exist, the expansion fails.
10869
10870 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10871         &~&*def:h_*&<&'header&~name'&>&*:*&"
10872 .cindex "expansion" "checking header line existence"
10873 This condition is true if a message is being processed and the named header
10874 exists in the message. For example,
10875 .code
10876 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10877 .endd
10878 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10879 the header name must be terminated by a colon if white space does not follow.
10880
10881 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10882        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10883 .cindex "string" "comparison"
10884 .cindex "expansion" "string comparison"
10885 .cindex "&%eq%& expansion condition"
10886 .cindex "&%eqi%& expansion condition"
10887 The two substrings are first expanded. The condition is true if the two
10888 resulting strings are identical. For &%eq%& the comparison includes the case of
10889 letters, whereas for &%eqi%& the comparison is case-independent.
10890
10891 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10892 .cindex "expansion" "file existence test"
10893 .cindex "file" "existence test"
10894 .cindex "&%exists%&, expansion condition"
10895 The substring is first expanded and then interpreted as an absolute path. The
10896 condition is true if the named file (or directory) exists. The existence test
10897 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10898 users' filter files may be locked out by the system administrator.
10899
10900 .vitem &*first_delivery*&
10901 .cindex "delivery" "first"
10902 .cindex "first delivery"
10903 .cindex "expansion" "first delivery test"
10904 .cindex "&%first_delivery%& expansion condition"
10905 This condition, which has no data, is true during a message's first delivery
10906 attempt. It is false during any subsequent delivery attempts.
10907
10908
10909 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10910        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10911 .cindex "list" "iterative conditions"
10912 .cindex "expansion" "&*forall*& condition"
10913 .cindex "expansion" "&*forany*& condition"
10914 .vindex "&$item$&"
10915 These conditions iterate over a list. The first argument is expanded to form
10916 the list. By default, the list separator is a colon, but it can be changed by
10917 the normal method. The second argument is interpreted as a condition that is to
10918 be applied to each item in the list in turn. During the interpretation of the
10919 condition, the current list item is placed in a variable called &$item$&.
10920 .ilist
10921 For &*forany*&, interpretation stops if the condition is true for any item, and
10922 the result of the whole condition is true. If the condition is false for all
10923 items in the list, the overall condition is false.
10924 .next
10925 For &*forall*&, interpretation stops if the condition is false for any item,
10926 and the result of the whole condition is false. If the condition is true for
10927 all items in the list, the overall condition is true.
10928 .endlist
10929 Note that negation of &*forany*& means that the condition must be false for all
10930 items for the overall condition to succeed, and negation of &*forall*& means
10931 that the condition must be false for at least one item. In this example, the
10932 list separator is changed to a comma:
10933 .code
10934 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10935 .endd
10936 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10937 being processed, to enable these expansion items to be nested.
10938
10939 To scan a named list, expand it with the &*listnamed*& operator.
10940
10941
10942 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10943        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10944 .cindex "string" "comparison"
10945 .cindex "expansion" "string comparison"
10946 .cindex "&%ge%& expansion condition"
10947 .cindex "&%gei%& expansion condition"
10948 The two substrings are first expanded. The condition is true if the first
10949 string is lexically greater than or equal to the second string. For &%ge%& the
10950 comparison includes the case of letters, whereas for &%gei%& the comparison is
10951 case-independent.
10952
10953 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10954        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10955 .cindex "string" "comparison"
10956 .cindex "expansion" "string comparison"
10957 .cindex "&%gt%& expansion condition"
10958 .cindex "&%gti%& expansion condition"
10959 The two substrings are first expanded. The condition is true if the first
10960 string is lexically greater than the second string. For &%gt%& the comparison
10961 includes the case of letters, whereas for &%gti%& the comparison is
10962 case-independent.
10963
10964 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10965        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10966 .cindex "string" "comparison"
10967 .cindex "list" "iterative conditions"
10968 Both strings are expanded; the second string is treated as a list of simple
10969 strings; if the first string is a member of the second, then the condition
10970 is true.
10971
10972 These are simpler to use versions of the more powerful &*forany*& condition.
10973 Examples, and the &*forany*& equivalents:
10974 .code
10975 ${if inlist{needle}{foo:needle:bar}}
10976   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10977 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10978   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10979 .endd
10980
10981 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10982        &*isip4&~{*&<&'string'&>&*}*& &&&
10983        &*isip6&~{*&<&'string'&>&*}*&
10984 .cindex "IP address" "testing string format"
10985 .cindex "string" "testing for IP address"
10986 .cindex "&%isip%& expansion condition"
10987 .cindex "&%isip4%& expansion condition"
10988 .cindex "&%isip6%& expansion condition"
10989 The substring is first expanded, and then tested to see if it has the form of
10990 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10991 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10992
10993 For an IPv4 address, the test is for four dot-separated components, each of
10994 which consists of from one to three digits. For an IPv6 address, up to eight
10995 colon-separated components are permitted, each containing from one to four
10996 hexadecimal digits. There may be fewer than eight components if an empty
10997 component (adjacent colons) is present. Only one empty component is permitted.
10998
10999 &*Note*&: The checks are just on the form of the address; actual numerical
11000 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
11001 check. The main use of these tests is to distinguish between IP addresses and
11002 host names, or between IPv4 and IPv6 addresses. For example, you could use
11003 .code
11004 ${if isip4{$sender_host_address}...
11005 .endd
11006 to test which IP version an incoming SMTP connection is using.
11007
11008 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11009 .cindex "LDAP" "use for authentication"
11010 .cindex "expansion" "LDAP authentication test"
11011 .cindex "&%ldapauth%& expansion condition"
11012 This condition supports user authentication using LDAP. See section
11013 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11014 queries. For this use, the query must contain a user name and password. The
11015 query itself is not used, and can be empty. The condition is true if the
11016 password is not empty, and the user name and password are accepted by the LDAP
11017 server. An empty password is rejected without calling LDAP because LDAP binds
11018 with an empty password are considered anonymous regardless of the username, and
11019 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11020 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11021 this can be used.
11022
11023
11024 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11025        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11026 .cindex "string" "comparison"
11027 .cindex "expansion" "string comparison"
11028 .cindex "&%le%& expansion condition"
11029 .cindex "&%lei%& expansion condition"
11030 The two substrings are first expanded. The condition is true if the first
11031 string is lexically less than or equal to the second string. For &%le%& the
11032 comparison includes the case of letters, whereas for &%lei%& the comparison is
11033 case-independent.
11034
11035 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11036        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11037 .cindex "string" "comparison"
11038 .cindex "expansion" "string comparison"
11039 .cindex "&%lt%& expansion condition"
11040 .cindex "&%lti%& expansion condition"
11041 The two substrings are first expanded. The condition is true if the first
11042 string is lexically less than the second string. For &%lt%& the comparison
11043 includes the case of letters, whereas for &%lti%& the comparison is
11044 case-independent.
11045
11046
11047 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11048 .cindex "expansion" "regular expression comparison"
11049 .cindex "regular expressions" "match in expanded string"
11050 .cindex "&%match%& expansion condition"
11051 The two substrings are first expanded. The second is then treated as a regular
11052 expression and applied to the first. Because of the pre-expansion, if the
11053 regular expression contains dollar, or backslash characters, they must be
11054 escaped. Care must also be taken if the regular expression contains braces
11055 (curly brackets). A closing brace must be escaped so that it is not taken as a
11056 premature termination of <&'string2'&>. The easiest approach is to use the
11057 &`\N`& feature to disable expansion of the regular expression.
11058 For example,
11059 .code
11060 ${if match {$local_part}{\N^\d{3}\N} ...
11061 .endd
11062 If the whole expansion string is in double quotes, further escaping of
11063 backslashes is also required.
11064
11065 The condition is true if the regular expression match succeeds.
11066 The regular expression is not required to begin with a circumflex
11067 metacharacter, but if there is no circumflex, the expression is not anchored,
11068 and it may match anywhere in the subject, not just at the start. If you want
11069 the pattern to match at the end of the subject, you must include the &`$`&
11070 metacharacter at an appropriate point.
11071
11072 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11073 At the start of an &%if%& expansion the values of the numeric variable
11074 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11075 succeeds causes them to be reset to the substrings of that condition and they
11076 will have these values during the expansion of the success string. At the end
11077 of the &%if%& expansion, the previous values are restored. After testing a
11078 combination of conditions using &%or%&, the subsequent values of the numeric
11079 variables are those of the condition that succeeded.
11080
11081 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11082 .cindex "&%match_address%& expansion condition"
11083 See &*match_local_part*&.
11084
11085 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11086 .cindex "&%match_domain%& expansion condition"
11087 See &*match_local_part*&.
11088
11089 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11090 .cindex "&%match_ip%& expansion condition"
11091 This condition matches an IP address to a list of IP address patterns. It must
11092 be followed by two argument strings. The first (after expansion) must be an IP
11093 address or an empty string. The second (not expanded) is a restricted host
11094 list that can match only an IP address, not a host name. For example:
11095 .code
11096 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11097 .endd
11098 The specific types of host list item that are permitted in the list are:
11099
11100 .ilist
11101 An IP address, optionally with a CIDR mask.
11102 .next
11103 A single asterisk, which matches any IP address.
11104 .next
11105 An empty item, which matches only if the IP address is empty. This could be
11106 useful for testing for a locally submitted message or one from specific hosts
11107 in a single test such as
11108 . ==== As this is a nested list, any displays it contains must be indented
11109 . ==== as otherwise they are too far to the left. This comment applies to
11110 . ==== the use of xmlto plus fop. There's no problem when formatting with
11111 . ==== sdop, with or without the extra indent.
11112 .code
11113   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11114 .endd
11115 where the first item in the list is the empty string.
11116 .next
11117 The item @[] matches any of the local host's interface addresses.
11118 .next
11119 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11120 even if &`net-`& is not specified. There is never any attempt to turn the IP
11121 address into a host name. The most common type of linear search for
11122 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11123 masks. For example:
11124 .code
11125   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11126 .endd
11127 It is of course possible to use other kinds of lookup, and in such a case, you
11128 do need to specify the &`net-`& prefix if you want to specify a specific
11129 address mask, for example:
11130 .code
11131   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11132 .endd
11133 However, unless you are combining a &%match_ip%& condition with others, it is
11134 just as easy to use the fact that a lookup is itself a condition, and write:
11135 .code
11136   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11137 .endd
11138 .endlist ilist
11139
11140 Note that <&'string2'&> is not itself subject to string expansion, unless
11141 Exim was built with the EXPAND_LISTMATCH_RHS option.
11142
11143 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11144
11145 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11146 .cindex "domain list" "in expansion condition"
11147 .cindex "address list" "in expansion condition"
11148 .cindex "local part" "list, in expansion condition"
11149 .cindex "&%match_local_part%& expansion condition"
11150 This condition, together with &%match_address%& and &%match_domain%&, make it
11151 possible to test domain, address, and local part lists within expansions. Each
11152 condition requires two arguments: an item and a list to match. A trivial
11153 example is:
11154 .code
11155 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11156 .endd
11157 In each case, the second argument may contain any of the allowable items for a
11158 list of the appropriate type. Also, because the second argument (after
11159 expansion) is a standard form of list, it is possible to refer to a named list.
11160 Thus, you can use conditions like this:
11161 .code
11162 ${if match_domain{$domain}{+local_domains}{...
11163 .endd
11164 .cindex "&`+caseful`&"
11165 For address lists, the matching starts off caselessly, but the &`+caseful`&
11166 item can be used, as in all address lists, to cause subsequent items to
11167 have their local parts matched casefully. Domains are always matched
11168 caselessly.
11169
11170 Note that <&'string2'&> is not itself subject to string expansion, unless
11171 Exim was built with the EXPAND_LISTMATCH_RHS option.
11172
11173 &*Note*&: Host lists are &'not'& supported in this way. This is because
11174 hosts have two identities: a name and an IP address, and it is not clear
11175 how to specify cleanly how such a test would work. However, IP addresses can be
11176 matched using &%match_ip%&.
11177
11178 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11179 .cindex "PAM authentication"
11180 .cindex "AUTH" "with PAM"
11181 .cindex "Solaris" "PAM support"
11182 .cindex "expansion" "PAM authentication test"
11183 .cindex "&%pam%& expansion condition"
11184 &'Pluggable Authentication Modules'&
11185 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11186 available in the latest releases of Solaris and in some GNU/Linux
11187 distributions. The Exim support, which is intended for use in conjunction with
11188 the SMTP AUTH command, is available only if Exim is compiled with
11189 .code
11190 SUPPORT_PAM=yes
11191 .endd
11192 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11193 in some releases of GNU/Linux &%-ldl%& is also needed.
11194
11195 The argument string is first expanded, and the result must be a
11196 colon-separated list of strings. Leading and trailing white space is ignored.
11197 The PAM module is initialized with the service name &"exim"& and the user name
11198 taken from the first item in the colon-separated data string (<&'string1'&>).
11199 The remaining items in the data string are passed over in response to requests
11200 from the authentication function. In the simple case there will only be one
11201 request, for a password, so the data consists of just two strings.
11202
11203 There can be problems if any of the strings are permitted to contain colon
11204 characters. In the usual way, these have to be doubled to avoid being taken as
11205 separators. If the data is being inserted from a variable, the &%sg%& expansion
11206 item can be used to double any existing colons. For example, the configuration
11207 of a LOGIN authenticator might contain this setting:
11208 .code
11209 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11210 .endd
11211 For a PLAIN authenticator you could use:
11212 .code
11213 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11214 .endd
11215 In some operating systems, PAM authentication can be done only from a process
11216 running as root. Since Exim is running as the Exim user when receiving
11217 messages, this means that PAM cannot be used directly in those systems.
11218 A patched version of the &'pam_unix'& module that comes with the
11219 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11220 The patched module allows one special uid/gid combination, in addition to root,
11221 to authenticate. If you build the patched module to allow the Exim user and
11222 group, PAM can then be used from an Exim authenticator.
11223
11224
11225 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11226 .cindex "&'pwcheck'& daemon"
11227 .cindex "Cyrus"
11228 .cindex "expansion" "&'pwcheck'& authentication test"
11229 .cindex "&%pwcheck%& expansion condition"
11230 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11231 This is one way of making it possible for passwords to be checked by a process
11232 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11233 deprecated. Its replacement is &'saslauthd'& (see below).
11234
11235 The pwcheck support is not included in Exim by default. You need to specify
11236 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11237 building Exim. For example:
11238 .code
11239 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11240 .endd
11241 You do not need to install the full Cyrus software suite in order to use
11242 the pwcheck daemon. You can compile and install just the daemon alone
11243 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11244 access to the &_/var/pwcheck_& directory.
11245
11246 The &%pwcheck%& condition takes one argument, which must be the user name and
11247 password, separated by a colon. For example, in a LOGIN authenticator
11248 configuration, you might have this:
11249 .code
11250 server_condition = ${if pwcheck{$auth1:$auth2}}
11251 .endd
11252 Again, for a PLAIN authenticator configuration, this would be:
11253 .code
11254 server_condition = ${if pwcheck{$auth2:$auth3}}
11255 .endd
11256 .vitem &*queue_running*&
11257 .cindex "queue runner" "detecting when delivering from"
11258 .cindex "expansion" "queue runner test"
11259 .cindex "&%queue_running%& expansion condition"
11260 This condition, which has no data, is true during delivery attempts that are
11261 initiated by queue runner processes, and false otherwise.
11262
11263
11264 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11265 .cindex "Radius"
11266 .cindex "expansion" "Radius authentication"
11267 .cindex "&%radius%& expansion condition"
11268 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11269 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11270 the Radius client configuration file in order to build Exim with Radius
11271 support.
11272
11273 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11274 library, using the original API. If you are using release 0.4.0 or later of
11275 this library, you need to set
11276 .code
11277 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11278 .endd
11279 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11280 &%libradius%& library that comes with FreeBSD. To do this, set
11281 .code
11282 RADIUS_LIB_TYPE=RADLIB
11283 .endd
11284 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11285 You may also have to supply a suitable setting in EXTRALIBS so that the
11286 Radius library can be found when Exim is linked.
11287
11288 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11289 Radius client library, which calls the Radius server. The condition is true if
11290 the authentication is successful. For example:
11291 .code
11292 server_condition = ${if radius{<arguments>}}
11293 .endd
11294
11295
11296 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11297         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11298 .cindex "&'saslauthd'& daemon"
11299 .cindex "Cyrus"
11300 .cindex "expansion" "&'saslauthd'& authentication test"
11301 .cindex "&%saslauthd%& expansion condition"
11302 This condition supports user authentication using the Cyrus &'saslauthd'&
11303 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11304 Using this daemon is one way of making it possible for passwords to be checked
11305 by a process that is not running as root.
11306
11307 The saslauthd support is not included in Exim by default. You need to specify
11308 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11309 building Exim. For example:
11310 .code
11311 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11312 .endd
11313 You do not need to install the full Cyrus software suite in order to use
11314 the saslauthd daemon. You can compile and install just the daemon alone
11315 from the Cyrus SASL library.
11316
11317 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11318 two are mandatory. For example:
11319 .code
11320 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11321 .endd
11322 The service and the realm are optional (which is why the arguments are enclosed
11323 in their own set of braces). For details of the meaning of the service and
11324 realm, and how to run the daemon, consult the Cyrus documentation.
11325 .endlist vlist
11326
11327
11328
11329 .section "Combining expansion conditions" "SECID84"
11330 .cindex "expansion" "combining conditions"
11331 Several conditions can be tested at once by combining them using the &%and%&
11332 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11333 conditions on their own, and precede their lists of sub-conditions. Each
11334 sub-condition must be enclosed in braces within the overall braces that contain
11335 the list. No repetition of &%if%& is used.
11336
11337
11338 .vlist
11339 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11340 .cindex "&""or""& expansion condition"
11341 .cindex "expansion" "&""or""& of conditions"
11342 The sub-conditions are evaluated from left to right. The condition is true if
11343 any one of the sub-conditions is true.
11344 For example,
11345 .code
11346 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11347 .endd
11348 When a true sub-condition is found, the following ones are parsed but not
11349 evaluated. If there are several &"match"& sub-conditions the values of the
11350 numeric variables afterwards are taken from the first one that succeeds.
11351
11352 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11353 .cindex "&""and""& expansion condition"
11354 .cindex "expansion" "&""and""& of conditions"
11355 The sub-conditions are evaluated from left to right. The condition is true if
11356 all of the sub-conditions are true. If there are several &"match"&
11357 sub-conditions, the values of the numeric variables afterwards are taken from
11358 the last one. When a false sub-condition is found, the following ones are
11359 parsed but not evaluated.
11360 .endlist
11361 .ecindex IIDexpcond
11362
11363
11364
11365
11366 .section "Expansion variables" "SECTexpvar"
11367 .cindex "expansion" "variables, list of"
11368 This section contains an alphabetical list of all the expansion variables. Some
11369 of them are available only when Exim is compiled with specific options such as
11370 support for TLS or the content scanning extension.
11371
11372 .vlist
11373 .vitem "&$0$&, &$1$&, etc"
11374 .cindex "numerical variables (&$1$& &$2$& etc)"
11375 When a &%match%& expansion condition succeeds, these variables contain the
11376 captured substrings identified by the regular expression during subsequent
11377 processing of the success string of the containing &%if%& expansion item.
11378 In the expansion condition case
11379 they do not retain their values afterwards; in fact, their previous
11380 values are restored at the end of processing an &%if%& item. The numerical
11381 variables may also be set externally by some other matching process which
11382 precedes the expansion of the string. For example, the commands available in
11383 Exim filter files include an &%if%& command with its own regular expression
11384 matching condition.
11385
11386 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11387 Within an acl condition, expansion condition or expansion item
11388 any arguments are copied to these variables,
11389 any unused variables being made empty.
11390
11391 .vitem "&$acl_c...$&"
11392 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11393 can be given any name that starts with &$acl_c$& and is at least six characters
11394 long, but the sixth character must be either a digit or an underscore. For
11395 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11396 variables persist throughout the lifetime of an SMTP connection. They can be
11397 used to pass information between ACLs and between different invocations of the
11398 same ACL. When a message is received, the values of these variables are saved
11399 with the message, and can be accessed by filters, routers, and transports
11400 during subsequent delivery.
11401
11402 .vitem "&$acl_m...$&"
11403 These variables are like the &$acl_c...$& variables, except that their values
11404 are reset after a message has been received. Thus, if several messages are
11405 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11406 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11407 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11408 message is received, the values of these variables are saved with the message,
11409 and can be accessed by filters, routers, and transports during subsequent
11410 delivery.
11411
11412 .vitem &$acl_narg$&
11413 Within an acl condition, expansion condition or expansion item
11414 this variable has the number of arguments.
11415
11416 .vitem &$acl_verify_message$&
11417 .vindex "&$acl_verify_message$&"
11418 After an address verification has failed, this variable contains the failure
11419 message. It retains its value for use in subsequent modifiers. The message can
11420 be preserved by coding like this:
11421 .code
11422 warn !verify = sender
11423      set acl_m0 = $acl_verify_message
11424 .endd
11425 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11426 &%log_message%& modifiers, to include information about the verification
11427 failure.
11428
11429 .vitem &$address_data$&
11430 .vindex "&$address_data$&"
11431 This variable is set by means of the &%address_data%& option in routers. The
11432 value then remains with the address while it is processed by subsequent routers
11433 and eventually a transport. If the transport is handling multiple addresses,
11434 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11435 for more details. &*Note*&: The contents of &$address_data$& are visible in
11436 user filter files.
11437
11438 If &$address_data$& is set when the routers are called from an ACL to verify
11439 a recipient address, the final value is still in the variable for subsequent
11440 conditions and modifiers of the ACL statement. If routing the address caused it
11441 to be redirected to just one address, the child address is also routed as part
11442 of the verification, and in this case the final value of &$address_data$& is
11443 from the child's routing.
11444
11445 If &$address_data$& is set when the routers are called from an ACL to verify a
11446 sender address, the final value is also preserved, but this time in
11447 &$sender_address_data$&, to distinguish it from data from a recipient
11448 address.
11449
11450 In both cases (recipient and sender verification), the value does not persist
11451 after the end of the current ACL statement. If you want to preserve
11452 these values for longer, you can save them in ACL variables.
11453
11454 .vitem &$address_file$&
11455 .vindex "&$address_file$&"
11456 When, as a result of aliasing, forwarding, or filtering, a message is directed
11457 to a specific file, this variable holds the name of the file when the transport
11458 is running. At other times, the variable is empty. For example, using the
11459 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11460 .code
11461 /home/r2d2/savemail
11462 .endd
11463 then when the &(address_file)& transport is running, &$address_file$&
11464 contains the text string &`/home/r2d2/savemail`&.
11465 .cindex "Sieve filter" "value of &$address_file$&"
11466 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11467 then up to the transport configuration to generate an appropriate absolute path
11468 to the relevant file.
11469
11470 .vitem &$address_pipe$&
11471 .vindex "&$address_pipe$&"
11472 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11473 this variable holds the pipe command when the transport is running.
11474
11475 .vitem "&$auth1$& &-- &$auth3$&"
11476 .vindex "&$auth1$&, &$auth2$&, etc"
11477 These variables are used in SMTP authenticators (see chapters
11478 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11479
11480 .vitem &$authenticated_id$&
11481 .cindex "authentication" "id"
11482 .vindex "&$authenticated_id$&"
11483 When a server successfully authenticates a client it may be configured to
11484 preserve some of the authentication information in the variable
11485 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11486 user/password authenticator configuration might preserve the user name for use
11487 in the routers. Note that this is not the same information that is saved in
11488 &$sender_host_authenticated$&.
11489 When a message is submitted locally (that is, not over a TCP connection)
11490 the value of &$authenticated_id$& is normally the login name of the calling
11491 process. However, a trusted user can override this by means of the &%-oMai%&
11492 command line option.
11493
11494 .vitem &$authenticated_fail_id$&
11495 .cindex "authentication" "fail" "id"
11496 .vindex "&$authenticated_fail_id$&"
11497 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11498 will contain the failed authentication id. If more than one authentication
11499 id is attempted, it will contain only the last one. The variable is
11500 available for processing in the ACL's, generally the quit or notquit ACL.
11501 A message to a local recipient could still be accepted without requiring
11502 authentication, which means this variable could also be visible in all of
11503 the ACL's as well.
11504
11505
11506 .vitem &$authenticated_sender$&
11507 .cindex "sender" "authenticated"
11508 .cindex "authentication" "sender"
11509 .cindex "AUTH" "on MAIL command"
11510 .vindex "&$authenticated_sender$&"
11511 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11512 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11513 described in section &<<SECTauthparamail>>&. Unless the data is the string
11514 &"<>"&, it is set as the authenticated sender of the message, and the value is
11515 available during delivery in the &$authenticated_sender$& variable. If the
11516 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11517
11518 .vindex "&$qualify_domain$&"
11519 When a message is submitted locally (that is, not over a TCP connection), the
11520 value of &$authenticated_sender$& is an address constructed from the login
11521 name of the calling process and &$qualify_domain$&, except that a trusted user
11522 can override this by means of the &%-oMas%& command line option.
11523
11524
11525 .vitem &$authentication_failed$&
11526 .cindex "authentication" "failure"
11527 .vindex "&$authentication_failed$&"
11528 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11529 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11530 possible to distinguish between &"did not try to authenticate"&
11531 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11532 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11533 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11534 negative response to an AUTH command, including (for example) an attempt to use
11535 an undefined mechanism.
11536
11537 .vitem &$av_failed$&
11538 .cindex "content scanning" "AV scanner failure"
11539 This variable is available when Exim is compiled with the content-scanning
11540 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11541 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11542 the ACL malware condition.
11543
11544 .vitem &$body_linecount$&
11545 .cindex "message body" "line count"
11546 .cindex "body of message" "line count"
11547 .vindex "&$body_linecount$&"
11548 When a message is being received or delivered, this variable contains the
11549 number of lines in the message's body. See also &$message_linecount$&.
11550
11551 .vitem &$body_zerocount$&
11552 .cindex "message body" "binary zero count"
11553 .cindex "body of message" "binary zero count"
11554 .cindex "binary zero" "in message body"
11555 .vindex "&$body_zerocount$&"
11556 When a message is being received or delivered, this variable contains the
11557 number of binary zero bytes (ASCII NULs) in the message's body.
11558
11559 .vitem &$bounce_recipient$&
11560 .vindex "&$bounce_recipient$&"
11561 This is set to the recipient address of a bounce message while Exim is creating
11562 it. It is useful if a customized bounce message text file is in use (see
11563 chapter &<<CHAPemsgcust>>&).
11564
11565 .vitem &$bounce_return_size_limit$&
11566 .vindex "&$bounce_return_size_limit$&"
11567 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11568 up to a multiple of 1000. It is useful when a customized error message text
11569 file is in use (see chapter &<<CHAPemsgcust>>&).
11570
11571 .vitem &$caller_gid$&
11572 .cindex "gid (group id)" "caller"
11573 .vindex "&$caller_gid$&"
11574 The real group id under which the process that called Exim was running. This is
11575 not the same as the group id of the originator of a message (see
11576 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11577 incarnation normally contains the Exim gid.
11578
11579 .vitem &$caller_uid$&
11580 .cindex "uid (user id)" "caller"
11581 .vindex "&$caller_uid$&"
11582 The real user id under which the process that called Exim was running. This is
11583 not the same as the user id of the originator of a message (see
11584 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11585 incarnation normally contains the Exim uid.
11586
11587 .vitem &$callout_address$&
11588 .vindex "&$callout_address$&"
11589 After a callout for verification, spamd or malware daemon service, the
11590 address that was connected to.
11591
11592 .vitem &$compile_number$&
11593 .vindex "&$compile_number$&"
11594 The building process for Exim keeps a count of the number
11595 of times it has been compiled. This serves to distinguish different
11596 compilations of the same version of the program.
11597
11598 .vitem &$config_dir$&
11599 .vindex "&$config_dir$&"
11600 The directory name of the main configuration file. That is, the content of
11601 &$config_file$& with the last component stripped. The value does not
11602 contain the trailing slash. If &$config_file$& does not contain a slash,
11603 &$config_dir$& is ".".
11604
11605 .vitem &$config_file$&
11606 .vindex "&$config_file$&"
11607 The name of the main configuration file Exim is using.
11608
11609 .vitem &$dkim_cur_signer$& &&&
11610        &$dkim_verify_status$& &&&
11611        &$dkim_verify_reason$& &&&
11612        &$dkim_domain$& &&&
11613        &$dkim_identity$& &&&
11614        &$dkim_selector$& &&&
11615        &$dkim_algo$& &&&
11616        &$dkim_canon_body$& &&&
11617        &$dkim_canon_headers$& &&&
11618        &$dkim_copiedheaders$& &&&
11619        &$dkim_bodylength$& &&&
11620        &$dkim_created$& &&&
11621        &$dkim_expires$& &&&
11622        &$dkim_headernames$& &&&
11623        &$dkim_key_testing$& &&&
11624        &$dkim_key_nosubdomains$& &&&
11625        &$dkim_key_srvtype$& &&&
11626        &$dkim_key_granularity$& &&&
11627        &$dkim_key_notes$& &&&
11628        &$dkim_key_length$&
11629 These variables are only available within the DKIM ACL.
11630 For details see chapter &<<CHAPdkim>>&.
11631
11632 .vitem &$dkim_signers$&
11633 .vindex &$dkim_signers$&
11634 When a message has been received this variable contains
11635 a colon-separated list of signer domains and identities for the message.
11636 For details see chapter &<<CHAPdkim>>&.
11637
11638 .vitem &$dnslist_domain$& &&&
11639        &$dnslist_matched$& &&&
11640        &$dnslist_text$& &&&
11641        &$dnslist_value$&
11642 .vindex "&$dnslist_domain$&"
11643 .vindex "&$dnslist_matched$&"
11644 .vindex "&$dnslist_text$&"
11645 .vindex "&$dnslist_value$&"
11646 .cindex "black list (DNS)"
11647 When a DNS (black) list lookup succeeds, these variables are set to contain
11648 the following data from the lookup: the list's domain name, the key that was
11649 looked up, the contents of any associated TXT record, and the value from the
11650 main A record. See section &<<SECID204>>& for more details.
11651
11652 .vitem &$domain$&
11653 .vindex "&$domain$&"
11654 When an address is being routed, or delivered on its own, this variable
11655 contains the domain. Uppercase letters in the domain are converted into lower
11656 case for &$domain$&.
11657
11658 Global address rewriting happens when a message is received, so the value of
11659 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11660 is set during user filtering, but not during system filtering, because a
11661 message may have many recipients and the system filter is called just once.
11662
11663 When more than one address is being delivered at once (for example, several
11664 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11665 have the same domain. Transports can be restricted to handling only one domain
11666 at a time if the value of &$domain$& is required at transport time &-- this is
11667 the default for local transports. For further details of the environment in
11668 which local transports are run, see chapter &<<CHAPenvironment>>&.
11669
11670 .oindex "&%delay_warning_condition%&"
11671 At the end of a delivery, if all deferred addresses have the same domain, it is
11672 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11673
11674 The &$domain$& variable is also used in some other circumstances:
11675
11676 .ilist
11677 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11678 the recipient address. The domain of the &'sender'& address is in
11679 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11680 normally set during the running of the MAIL ACL. However, if the sender address
11681 is verified with a callout during the MAIL ACL, the sender domain is placed in
11682 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11683 the &(smtp)& transport.
11684
11685 .next
11686 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11687 &$domain$& contains the domain portion of the address that is being rewritten;
11688 it can be used in the expansion of the replacement address, for example, to
11689 rewrite domains by file lookup.
11690
11691 .next
11692 With one important exception, whenever a domain list is being scanned,
11693 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11694 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11695 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11696 that, in a RCPT ACL, the sender domain list can be dependent on the
11697 recipient domain (which is what is in &$domain$& at this time).
11698
11699 .next
11700 .cindex "ETRN" "value of &$domain$&"
11701 .oindex "&%smtp_etrn_command%&"
11702 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11703 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11704 .endlist
11705
11706
11707 .vitem &$domain_data$&
11708 .vindex "&$domain_data$&"
11709 When the &%domains%& option on a router matches a domain by
11710 means of a lookup, the data read by the lookup is available during the running
11711 of the router as &$domain_data$&. In addition, if the driver routes the
11712 address to a transport, the value is available in that transport. If the
11713 transport is handling multiple addresses, the value from the first address is
11714 used.
11715
11716 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11717 domain by means of a lookup. The data read by the lookup is available during
11718 the rest of the ACL statement. In all other situations, this variable expands
11719 to nothing.
11720
11721 .vitem &$exim_gid$&
11722 .vindex "&$exim_gid$&"
11723 This variable contains the numerical value of the Exim group id.
11724
11725 .vitem &$exim_path$&
11726 .vindex "&$exim_path$&"
11727 This variable contains the path to the Exim binary.
11728
11729 .vitem &$exim_uid$&
11730 .vindex "&$exim_uid$&"
11731 This variable contains the numerical value of the Exim user id.
11732
11733 .vitem &$exim_version$&
11734 .vindex "&$exim_version$&"
11735 This variable contains the version string of the Exim build.
11736 The first character is a major version number, currently 4.
11737 Then after a dot, the next group of digits is a minor version number.
11738 There may be other characters following the minor version.
11739
11740 .vitem &$header_$&<&'name'&>
11741 This is not strictly an expansion variable. It is expansion syntax for
11742 inserting the message header line with the given name. Note that the name must
11743 be terminated by colon or white space, because it may contain a wide variety of
11744 characters. Note also that braces must &'not'& be used.
11745
11746 .vitem &$headers_added$&
11747 .vindex "&$headers_added$&"
11748 Within an ACL this variable contains the headers added so far by
11749 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11750 The headers are a newline-separated list.
11751
11752 .vitem &$home$&
11753 .vindex "&$home$&"
11754 When the &%check_local_user%& option is set for a router, the user's home
11755 directory is placed in &$home$& when the check succeeds. In particular, this
11756 means it is set during the running of users' filter files. A router may also
11757 explicitly set a home directory for use by a transport; this can be overridden
11758 by a setting on the transport itself.
11759
11760 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11761 of the environment variable HOME, which is subject to the
11762 &%keep_environment%& and &%add_environment%& main config options.
11763
11764 .vitem &$host$&
11765 .vindex "&$host$&"
11766 If a router assigns an address to a transport (any transport), and passes a
11767 list of hosts with the address, the value of &$host$& when the transport starts
11768 to run is the name of the first host on the list. Note that this applies both
11769 to local and remote transports.
11770
11771 .cindex "transport" "filter"
11772 .cindex "filter" "transport filter"
11773 For the &(smtp)& transport, if there is more than one host, the value of
11774 &$host$& changes as the transport works its way through the list. In
11775 particular, when the &(smtp)& transport is expanding its options for encryption
11776 using TLS, or for specifying a transport filter (see chapter
11777 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11778 is connected.
11779
11780 When used in the client part of an authenticator configuration (see chapter
11781 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11782 client is connected.
11783
11784
11785 .vitem &$host_address$&
11786 .vindex "&$host_address$&"
11787 This variable is set to the remote host's IP address whenever &$host$& is set
11788 for a remote connection. It is also set to the IP address that is being checked
11789 when the &%ignore_target_hosts%& option is being processed.
11790
11791 .vitem &$host_data$&
11792 .vindex "&$host_data$&"
11793 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11794 result of the lookup is made available in the &$host_data$& variable. This
11795 allows you, for example, to do things like this:
11796 .code
11797 deny  hosts = net-lsearch;/some/file
11798 message = $host_data
11799 .endd
11800 .vitem &$host_lookup_deferred$&
11801 .cindex "host name" "lookup, failure of"
11802 .vindex "&$host_lookup_deferred$&"
11803 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11804 message comes from a remote host and there is an attempt to look up the host's
11805 name from its IP address, and the attempt is not successful, one of these
11806 variables is set to &"1"&.
11807
11808 .ilist
11809 If the lookup receives a definite negative response (for example, a DNS lookup
11810 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11811
11812 .next
11813 If there is any kind of problem during the lookup, such that Exim cannot
11814 tell whether or not the host name is defined (for example, a timeout for a DNS
11815 lookup), &$host_lookup_deferred$& is set to &"1"&.
11816 .endlist ilist
11817
11818 Looking up a host's name from its IP address consists of more than just a
11819 single reverse lookup. Exim checks that a forward lookup of at least one of the
11820 names it receives from a reverse lookup yields the original IP address. If this
11821 is not the case, Exim does not accept the looked up name(s), and
11822 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11823 IP address (for example, the existence of a PTR record in the DNS) is not
11824 sufficient on its own for the success of a host name lookup. If the reverse
11825 lookup succeeds, but there is a lookup problem such as a timeout when checking
11826 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11827 &"1"&. See also &$sender_host_name$&.
11828
11829 .vitem &$host_lookup_failed$&
11830 .vindex "&$host_lookup_failed$&"
11831 See &$host_lookup_deferred$&.
11832
11833 .vitem &$host_port$&
11834 .vindex "&$host_port$&"
11835 This variable is set to the remote host's TCP port whenever &$host$& is set
11836 for an outbound connection.
11837
11838 .vitem &$initial_cwd$&
11839 .vindex "&$initial_cwd$&
11840 This variable contains the full path name of the initial working
11841 directory of the current Exim process. This may differ from the current
11842 working directory, as Exim changes this to "/" during early startup, and
11843 to &$spool_directory$& later.
11844
11845 .vitem &$inode$&
11846 .vindex "&$inode$&"
11847 The only time this variable is set is while expanding the &%directory_file%&
11848 option in the &(appendfile)& transport. The variable contains the inode number
11849 of the temporary file which is about to be renamed. It can be used to construct
11850 a unique name for the file.
11851
11852 .vitem &$interface_address$&
11853 .vindex "&$interface_address$&"
11854 This is an obsolete name for &$received_ip_address$&.
11855
11856 .vitem &$interface_port$&
11857 .vindex "&$interface_port$&"
11858 This is an obsolete name for &$received_port$&.
11859
11860 .vitem &$item$&
11861 .vindex "&$item$&"
11862 This variable is used during the expansion of &*forall*& and &*forany*&
11863 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11864 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11865 empty.
11866
11867 .vitem &$ldap_dn$&
11868 .vindex "&$ldap_dn$&"
11869 This variable, which is available only when Exim is compiled with LDAP support,
11870 contains the DN from the last entry in the most recently successful LDAP
11871 lookup.
11872
11873 .vitem &$load_average$&
11874 .vindex "&$load_average$&"
11875 This variable contains the system load average, multiplied by 1000 so that it
11876 is an integer. For example, if the load average is 0.21, the value of the
11877 variable is 210. The value is recomputed every time the variable is referenced.
11878
11879 .vitem &$local_part$&
11880 .vindex "&$local_part$&"
11881 When an address is being routed, or delivered on its own, this
11882 variable contains the local part. When a number of addresses are being
11883 delivered together (for example, multiple RCPT commands in an SMTP
11884 session), &$local_part$& is not set.
11885
11886 Global address rewriting happens when a message is received, so the value of
11887 &$local_part$& during routing and delivery is the value after rewriting.
11888 &$local_part$& is set during user filtering, but not during system filtering,
11889 because a message may have many recipients and the system filter is called just
11890 once.
11891
11892 .vindex "&$local_part_prefix$&"
11893 .vindex "&$local_part_suffix$&"
11894 If a local part prefix or suffix has been recognized, it is not included in the
11895 value of &$local_part$& during routing and subsequent delivery. The values of
11896 any prefix or suffix are in &$local_part_prefix$& and
11897 &$local_part_suffix$&, respectively.
11898
11899 When a message is being delivered to a file, pipe, or autoreply transport as a
11900 result of aliasing or forwarding, &$local_part$& is set to the local part of
11901 the parent address, not to the file name or command (see &$address_file$& and
11902 &$address_pipe$&).
11903
11904 When an ACL is running for a RCPT command, &$local_part$& contains the
11905 local part of the recipient address.
11906
11907 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11908 &$local_part$& contains the local part of the address that is being rewritten;
11909 it can be used in the expansion of the replacement address, for example.
11910
11911 In all cases, all quoting is removed from the local part. For example, for both
11912 the addresses
11913 .code
11914 "abc:xyz"@test.example
11915 abc\:xyz@test.example
11916 .endd
11917 the value of &$local_part$& is
11918 .code
11919 abc:xyz
11920 .endd
11921 If you use &$local_part$& to create another address, you should always wrap it
11922 inside a quoting operator. For example, in a &(redirect)& router you could
11923 have:
11924 .code
11925 data = ${quote_local_part:$local_part}@new.domain.example
11926 .endd
11927 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11928 to process local parts in a case-dependent manner in a router, you can set the
11929 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11930
11931 .vitem &$local_part_data$&
11932 .vindex "&$local_part_data$&"
11933 When the &%local_parts%& option on a router matches a local part by means of a
11934 lookup, the data read by the lookup is available during the running of the
11935 router as &$local_part_data$&. In addition, if the driver routes the address
11936 to a transport, the value is available in that transport. If the transport is
11937 handling multiple addresses, the value from the first address is used.
11938
11939 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11940 matches a local part by means of a lookup. The data read by the lookup is
11941 available during the rest of the ACL statement. In all other situations, this
11942 variable expands to nothing.
11943
11944 .vitem &$local_part_prefix$&
11945 .vindex "&$local_part_prefix$&"
11946 When an address is being routed or delivered, and a
11947 specific prefix for the local part was recognized, it is available in this
11948 variable, having been removed from &$local_part$&.
11949
11950 .vitem &$local_part_suffix$&
11951 .vindex "&$local_part_suffix$&"
11952 When an address is being routed or delivered, and a
11953 specific suffix for the local part was recognized, it is available in this
11954 variable, having been removed from &$local_part$&.
11955
11956 .vitem &$local_scan_data$&
11957 .vindex "&$local_scan_data$&"
11958 This variable contains the text returned by the &[local_scan()]& function when
11959 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11960
11961 .vitem &$local_user_gid$&
11962 .vindex "&$local_user_gid$&"
11963 See &$local_user_uid$&.
11964
11965 .vitem &$local_user_uid$&
11966 .vindex "&$local_user_uid$&"
11967 This variable and &$local_user_gid$& are set to the uid and gid after the
11968 &%check_local_user%& router precondition succeeds. This means that their values
11969 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11970 and &%condition%&), for the &%address_data%& expansion, and for any
11971 router-specific expansions. At all other times, the values in these variables
11972 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11973
11974 .vitem &$localhost_number$&
11975 .vindex "&$localhost_number$&"
11976 This contains the expanded value of the
11977 &%localhost_number%& option. The expansion happens after the main options have
11978 been read.
11979
11980 .vitem &$log_inodes$&
11981 .vindex "&$log_inodes$&"
11982 The number of free inodes in the disk partition where Exim's
11983 log files are being written. The value is recalculated whenever the variable is
11984 referenced. If the relevant file system does not have the concept of inodes,
11985 the value of is -1. See also the &%check_log_inodes%& option.
11986
11987 .vitem &$log_space$&
11988 .vindex "&$log_space$&"
11989 The amount of free space (as a number of kilobytes) in the disk
11990 partition where Exim's log files are being written. The value is recalculated
11991 whenever the variable is referenced. If the operating system does not have the
11992 ability to find the amount of free space (only true for experimental systems),
11993 the space value is -1. See also the &%check_log_space%& option.
11994
11995
11996 .vitem &$lookup_dnssec_authenticated$&
11997 .vindex "&$lookup_dnssec_authenticated$&"
11998 This variable is set after a DNS lookup done by
11999 a dnsdb lookup expansion, dnslookup router or smtp transport.
12000 .cindex "DNS" "DNSSEC"
12001 It will be empty if &(DNSSEC)& was not requested,
12002 &"no"& if the result was not labelled as authenticated data
12003 and &"yes"& if it was.
12004 Results that are labelled as authoritative answer that match
12005 the &%dns_trust_aa%& configuration variable count also
12006 as authenticated data.
12007
12008 .vitem &$mailstore_basename$&
12009 .vindex "&$mailstore_basename$&"
12010 This variable is set only when doing deliveries in &"mailstore"& format in the
12011 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12012 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12013 contains the basename of the files that are being written, that is, the name
12014 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12015 variable is empty.
12016
12017 .vitem &$malware_name$&
12018 .vindex "&$malware_name$&"
12019 This variable is available when Exim is compiled with the
12020 content-scanning extension. It is set to the name of the virus that was found
12021 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12022
12023 .vitem &$max_received_linelength$&
12024 .vindex "&$max_received_linelength$&"
12025 .cindex "maximum" "line length"
12026 .cindex "line length" "maximum"
12027 This variable contains the number of bytes in the longest line that was
12028 received as part of the message, not counting the line termination
12029 character(s).
12030
12031 .vitem &$message_age$&
12032 .cindex "message" "age of"
12033 .vindex "&$message_age$&"
12034 This variable is set at the start of a delivery attempt to contain the number
12035 of seconds since the message was received. It does not change during a single
12036 delivery attempt.
12037
12038 .vitem &$message_body$&
12039 .cindex "body of message" "expansion variable"
12040 .cindex "message body" "in expansion"
12041 .cindex "binary zero" "in message body"
12042 .vindex "&$message_body$&"
12043 .oindex "&%message_body_visible%&"
12044 This variable contains the initial portion of a message's body while it is
12045 being delivered, and is intended mainly for use in filter files. The maximum
12046 number of characters of the body that are put into the variable is set by the
12047 &%message_body_visible%& configuration option; the default is 500.
12048
12049 .oindex "&%message_body_newlines%&"
12050 By default, newlines are converted into spaces in &$message_body$&, to make it
12051 easier to search for phrases that might be split over a line break. However,
12052 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12053 zeros are always converted into spaces.
12054
12055 .vitem &$message_body_end$&
12056 .cindex "body of message" "expansion variable"
12057 .cindex "message body" "in expansion"
12058 .vindex "&$message_body_end$&"
12059 This variable contains the final portion of a message's
12060 body while it is being delivered. The format and maximum size are as for
12061 &$message_body$&.
12062
12063 .vitem &$message_body_size$&
12064 .cindex "body of message" "size"
12065 .cindex "message body" "size"
12066 .vindex "&$message_body_size$&"
12067 When a message is being delivered, this variable contains the size of the body
12068 in bytes. The count starts from the character after the blank line that
12069 separates the body from the header. Newlines are included in the count. See
12070 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12071
12072 .vitem &$message_exim_id$&
12073 .vindex "&$message_exim_id$&"
12074 When a message is being received or delivered, this variable contains the
12075 unique message id that is generated and used by Exim to identify the message.
12076 An id is not created for a message until after its header has been successfully
12077 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12078 line; it is the local id that Exim assigns to the message, for example:
12079 &`1BXTIK-0001yO-VA`&.
12080
12081 .vitem &$message_headers$&
12082 .vindex &$message_headers$&
12083 This variable contains a concatenation of all the header lines when a message
12084 is being processed, except for lines added by routers or transports. The header
12085 lines are separated by newline characters. Their contents are decoded in the
12086 same way as a header line that is inserted by &%bheader%&.
12087
12088 .vitem &$message_headers_raw$&
12089 .vindex &$message_headers_raw$&
12090 This variable is like &$message_headers$& except that no processing of the
12091 contents of header lines is done.
12092
12093 .vitem &$message_id$&
12094 This is an old name for &$message_exim_id$&. It is now deprecated.
12095
12096 .vitem &$message_linecount$&
12097 .vindex "&$message_linecount$&"
12098 This variable contains the total number of lines in the header and body of the
12099 message. Compare &$body_linecount$&, which is the count for the body only.
12100 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12101 number of lines received. Before delivery happens (that is, before filters,
12102 routers, and transports run) the count is increased to include the
12103 &'Received:'& header line that Exim standardly adds, and also any other header
12104 lines that are added by ACLs. The blank line that separates the message header
12105 from the body is not counted.
12106
12107 As with the special case of &$message_size$&, during the expansion of the
12108 appendfile transport's maildir_tag option in maildir format, the value of
12109 &$message_linecount$& is the precise size of the number of newlines in the
12110 file that has been written (minus one for the blank line between the
12111 header and the body).
12112
12113 Here is an example of the use of this variable in a DATA ACL:
12114 .code
12115 deny message   = Too many lines in message header
12116      condition = \
12117       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12118 .endd
12119 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12120 message has not yet been received.
12121
12122 .vitem &$message_size$&
12123 .cindex "size" "of message"
12124 .cindex "message" "size"
12125 .vindex "&$message_size$&"
12126 When a message is being processed, this variable contains its size in bytes. In
12127 most cases, the size includes those headers that were received with the
12128 message, but not those (such as &'Envelope-to:'&) that are added to individual
12129 deliveries as they are written. However, there is one special case: during the
12130 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12131 doing a delivery in maildir format, the value of &$message_size$& is the
12132 precise size of the file that has been written. See also
12133 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12134
12135 .cindex "RCPT" "value of &$message_size$&"
12136 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12137 contains the size supplied on the MAIL command, or -1 if no size was given. The
12138 value may not, of course, be truthful.
12139
12140 .vitem &$mime_$&&'xxx'&
12141 A number of variables whose names start with &$mime$& are
12142 available when Exim is compiled with the content-scanning extension. For
12143 details, see section &<<SECTscanmimepart>>&.
12144
12145 .vitem "&$n0$& &-- &$n9$&"
12146 These variables are counters that can be incremented by means
12147 of the &%add%& command in filter files.
12148
12149 .vitem &$original_domain$&
12150 .vindex "&$domain$&"
12151 .vindex "&$original_domain$&"
12152 When a top-level address is being processed for delivery, this contains the
12153 same value as &$domain$&. However, if a &"child"& address (for example,
12154 generated by an alias, forward, or filter file) is being processed, this
12155 variable contains the domain of the original address (lower cased). This
12156 differs from &$parent_domain$& only when there is more than one level of
12157 aliasing or forwarding. When more than one address is being delivered in a
12158 single transport run, &$original_domain$& is not set.
12159
12160 If a new address is created by means of a &%deliver%& command in a system
12161 filter, it is set up with an artificial &"parent"& address. This has the local
12162 part &'system-filter'& and the default qualify domain.
12163
12164 .vitem &$original_local_part$&
12165 .vindex "&$local_part$&"
12166 .vindex "&$original_local_part$&"
12167 When a top-level address is being processed for delivery, this contains the
12168 same value as &$local_part$&, unless a prefix or suffix was removed from the
12169 local part, because &$original_local_part$& always contains the full local
12170 part. When a &"child"& address (for example, generated by an alias, forward, or
12171 filter file) is being processed, this variable contains the full local part of
12172 the original address.
12173
12174 If the router that did the redirection processed the local part
12175 case-insensitively, the value in &$original_local_part$& is in lower case.
12176 This variable differs from &$parent_local_part$& only when there is more than
12177 one level of aliasing or forwarding. When more than one address is being
12178 delivered in a single transport run, &$original_local_part$& is not set.
12179
12180 If a new address is created by means of a &%deliver%& command in a system
12181 filter, it is set up with an artificial &"parent"& address. This has the local
12182 part &'system-filter'& and the default qualify domain.
12183
12184 .vitem &$originator_gid$&
12185 .cindex "gid (group id)" "of originating user"
12186 .cindex "sender" "gid"
12187 .vindex "&$caller_gid$&"
12188 .vindex "&$originator_gid$&"
12189 This variable contains the value of &$caller_gid$& that was set when the
12190 message was received. For messages received via the command line, this is the
12191 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12192 normally the gid of the Exim user.
12193
12194 .vitem &$originator_uid$&
12195 .cindex "uid (user id)" "of originating user"
12196 .cindex "sender" "uid"
12197 .vindex "&$caller_uid$&"
12198 .vindex "&$originaltor_uid$&"
12199 The value of &$caller_uid$& that was set when the message was received. For
12200 messages received via the command line, this is the uid of the sending user.
12201 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12202 user.
12203
12204 .vitem &$parent_domain$&
12205 .vindex "&$parent_domain$&"
12206 This variable is similar to &$original_domain$& (see
12207 above), except that it refers to the immediately preceding parent address.
12208
12209 .vitem &$parent_local_part$&
12210 .vindex "&$parent_local_part$&"
12211 This variable is similar to &$original_local_part$&
12212 (see above), except that it refers to the immediately preceding parent address.
12213
12214 .vitem &$pid$&
12215 .cindex "pid (process id)" "of current process"
12216 .vindex "&$pid$&"
12217 This variable contains the current process id.
12218
12219 .vitem &$pipe_addresses$&
12220 .cindex "filter" "transport filter"
12221 .cindex "transport" "filter"
12222 .vindex "&$pipe_addresses$&"
12223 This is not an expansion variable, but is mentioned here because the string
12224 &`$pipe_addresses`& is handled specially in the command specification for the
12225 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12226 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12227 It cannot be used in general expansion strings, and provokes an &"unknown
12228 variable"& error if encountered.
12229
12230 .vitem &$primary_hostname$&
12231 .vindex "&$primary_hostname$&"
12232 This variable contains the value set by &%primary_hostname%& in the
12233 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12234 a single-component name, Exim calls &[gethostbyname()]& (or
12235 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12236 qualified host name. See also &$smtp_active_hostname$&.
12237
12238
12239 .new
12240 .vitem &$proxy_external_address$& &&&
12241        &$proxy_external_port$& &&&
12242        &$proxy_local_address$& &&&
12243        &$proxy_local_port$& &&&
12244        &$proxy_session$&
12245 These variables are only available when built with Proxy Protocol
12246 or Socks5 support
12247 For details see chapter &<<SECTproxyInbound>>&.
12248 .wen
12249
12250 .vitem &$prdr_requested$&
12251 .cindex "PRDR" "variable for"
12252 This variable is set to &"yes"& if PRDR was requested by the client for the
12253 current message, otherwise &"no"&.
12254
12255 .vitem &$prvscheck_address$&
12256 This variable is used in conjunction with the &%prvscheck%& expansion item,
12257 which is described in sections &<<SECTexpansionitems>>& and
12258 &<<SECTverifyPRVS>>&.
12259
12260 .vitem &$prvscheck_keynum$&
12261 This variable is used in conjunction with the &%prvscheck%& expansion item,
12262 which is described in sections &<<SECTexpansionitems>>& and
12263 &<<SECTverifyPRVS>>&.
12264
12265 .vitem &$prvscheck_result$&
12266 This variable is used in conjunction with the &%prvscheck%& expansion item,
12267 which is described in sections &<<SECTexpansionitems>>& and
12268 &<<SECTverifyPRVS>>&.
12269
12270 .vitem &$qualify_domain$&
12271 .vindex "&$qualify_domain$&"
12272 The value set for the &%qualify_domain%& option in the configuration file.
12273
12274 .vitem &$qualify_recipient$&
12275 .vindex "&$qualify_recipient$&"
12276 The value set for the &%qualify_recipient%& option in the configuration file,
12277 or if not set, the value of &$qualify_domain$&.
12278
12279 .new
12280 .vitem &$queue_name$&
12281 .vindex &$queue_name$&
12282 .cindex "named queues"
12283 .cindex queues named
12284 The name of the spool queue in use; empty for the default queue.
12285 .wen
12286
12287 .vitem &$rcpt_count$&
12288 .vindex "&$rcpt_count$&"
12289 When a message is being received by SMTP, this variable contains the number of
12290 RCPT commands received for the current message. If this variable is used in a
12291 RCPT ACL, its value includes the current command.
12292
12293 .vitem &$rcpt_defer_count$&
12294 .vindex "&$rcpt_defer_count$&"
12295 .cindex "4&'xx'& responses" "count of"
12296 When a message is being received by SMTP, this variable contains the number of
12297 RCPT commands in the current message that have previously been rejected with a
12298 temporary (4&'xx'&) response.
12299
12300 .vitem &$rcpt_fail_count$&
12301 .vindex "&$rcpt_fail_count$&"
12302 When a message is being received by SMTP, this variable contains the number of
12303 RCPT commands in the current message that have previously been rejected with a
12304 permanent (5&'xx'&) response.
12305
12306 .vitem &$received_count$&
12307 .vindex "&$received_count$&"
12308 This variable contains the number of &'Received:'& header lines in the message,
12309 including the one added by Exim (so its value is always greater than zero). It
12310 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12311 delivering.
12312
12313 .vitem &$received_for$&
12314 .vindex "&$received_for$&"
12315 If there is only a single recipient address in an incoming message, this
12316 variable contains that address when the &'Received:'& header line is being
12317 built. The value is copied after recipient rewriting has happened, but before
12318 the &[local_scan()]& function is run.
12319
12320 .vitem &$received_ip_address$&
12321 .vindex "&$received_ip_address$&"
12322 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12323 variable is set to the address of the local IP interface, and &$received_port$&
12324 is set to the local port number. (The remote IP address and port are in
12325 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12326 the port value is -1 unless it has been set using the &%-oMi%& command line
12327 option.
12328
12329 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12330 could be used, for example, to make the file name for a TLS certificate depend
12331 on which interface and/or port is being used for the incoming connection. The
12332 values of &$received_ip_address$& and &$received_port$& are saved with any
12333 messages that are received, thus making these variables available at delivery
12334 time.
12335 For outbound connections see &$sending_ip_address$&.
12336
12337 .vitem &$received_port$&
12338 .vindex "&$received_port$&"
12339 See &$received_ip_address$&.
12340
12341 .vitem &$received_protocol$&
12342 .vindex "&$received_protocol$&"
12343 When a message is being processed, this variable contains the name of the
12344 protocol by which it was received. Most of the names used by Exim are defined
12345 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12346 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12347 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12348 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12349 connection and the client was successfully authenticated.
12350
12351 Exim uses the protocol name &"smtps"& for the case when encryption is
12352 automatically set up on connection without the use of STARTTLS (see
12353 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12354 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12355 where the client initially uses EHLO, sets up an encrypted connection using
12356 STARTTLS, and then uses HELO afterwards.
12357
12358 The &%-oMr%& option provides a way of specifying a custom protocol name for
12359 messages that are injected locally by trusted callers. This is commonly used to
12360 identify messages that are being re-injected after some kind of scanning.
12361
12362 .vitem &$received_time$&
12363 .vindex "&$received_time$&"
12364 This variable contains the date and time when the current message was received,
12365 as a number of seconds since the start of the Unix epoch.
12366
12367 .vitem &$recipient_data$&
12368 .vindex "&$recipient_data$&"
12369 This variable is set after an indexing lookup success in an ACL &%recipients%&
12370 condition. It contains the data from the lookup, and the value remains set
12371 until the next &%recipients%& test. Thus, you can do things like this:
12372 .display
12373 &`require recipients  = cdb*@;/some/file`&
12374 &`deny    `&&'some further test involving'& &`$recipient_data`&
12375 .endd
12376 &*Warning*&: This variable is set only when a lookup is used as an indexing
12377 method in the address list, using the semicolon syntax as in the example above.
12378 The variable is not set for a lookup that is used as part of the string
12379 expansion that all such lists undergo before being interpreted.
12380
12381 .vitem &$recipient_verify_failure$&
12382 .vindex "&$recipient_verify_failure$&"
12383 In an ACL, when a recipient verification fails, this variable contains
12384 information about the failure. It is set to one of the following words:
12385
12386 .ilist
12387 &"qualify"&: The address was unqualified (no domain), and the message
12388 was neither local nor came from an exempted host.
12389
12390 .next
12391 &"route"&: Routing failed.
12392
12393 .next
12394 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12395 or before the MAIL command (that is, on initial connection, HELO, or
12396 MAIL).
12397
12398 .next
12399 &"recipient"&: The RCPT command in a callout was rejected.
12400 .next
12401
12402 &"postmaster"&: The postmaster check in a callout was rejected.
12403 .endlist
12404
12405 The main use of this variable is expected to be to distinguish between
12406 rejections of MAIL and rejections of RCPT.
12407
12408 .vitem &$recipients$&
12409 .vindex "&$recipients$&"
12410 This variable contains a list of envelope recipients for a message. A comma and
12411 a space separate the addresses in the replacement text. However, the variable
12412 is not generally available, to prevent exposure of Bcc recipients in
12413 unprivileged users' filter files. You can use &$recipients$& only in these
12414 cases:
12415
12416 .olist
12417 In a system filter file.
12418 .next
12419 In the ACLs associated with the DATA command and with non-SMTP messages, that
12420 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12421 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12422 &%acl_not_smtp_mime%&.
12423 .next
12424 From within a &[local_scan()]& function.
12425 .endlist
12426
12427
12428 .vitem &$recipients_count$&
12429 .vindex "&$recipients_count$&"
12430 When a message is being processed, this variable contains the number of
12431 envelope recipients that came with the message. Duplicates are not excluded
12432 from the count. While a message is being received over SMTP, the number
12433 increases for each accepted recipient. It can be referenced in an ACL.
12434
12435
12436 .vitem &$regex_match_string$&
12437 .vindex "&$regex_match_string$&"
12438 This variable is set to contain the matching regular expression after a
12439 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12440
12441 .vitem "&$regex1$&, &$regex2$&, etc"
12442 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12443 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12444 these variables contain the
12445 captured substrings identified by the regular expression.
12446
12447
12448 .vitem &$reply_address$&
12449 .vindex "&$reply_address$&"
12450 When a message is being processed, this variable contains the contents of the
12451 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12452 contents of the &'From:'& header line. Apart from the removal of leading
12453 white space, the value is not processed in any way. In particular, no RFC 2047
12454 decoding or character code translation takes place.
12455
12456 .vitem &$return_path$&
12457 .vindex "&$return_path$&"
12458 When a message is being delivered, this variable contains the return path &--
12459 the sender field that will be sent as part of the envelope. It is not enclosed
12460 in <> characters. At the start of routing an address, &$return_path$& has the
12461 same value as &$sender_address$&, but if, for example, an incoming message to a
12462 mailing list has been expanded by a router which specifies a different address
12463 for bounce messages, &$return_path$& subsequently contains the new bounce
12464 address, whereas &$sender_address$& always contains the original sender address
12465 that was received with the message. In other words, &$sender_address$& contains
12466 the incoming envelope sender, and &$return_path$& contains the outgoing
12467 envelope sender.
12468
12469 .vitem &$return_size_limit$&
12470 .vindex "&$return_size_limit$&"
12471 This is an obsolete name for &$bounce_return_size_limit$&.
12472
12473 .vitem &$router_name$&
12474 .cindex "router" "name"
12475 .cindex "name" "of router"
12476 .vindex "&$router_name$&"
12477 During the running of a router this variable contains its name.
12478
12479 .vitem &$runrc$&
12480 .cindex "return code" "from &%run%& expansion"
12481 .vindex "&$runrc$&"
12482 This variable contains the return code from a command that is run by the
12483 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12484 assume the order in which option values are expanded, except for those
12485 preconditions whose order of testing is documented. Therefore, you cannot
12486 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12487 another.
12488
12489 .vitem &$self_hostname$&
12490 .oindex "&%self%&" "value of host name"
12491 .vindex "&$self_hostname$&"
12492 When an address is routed to a supposedly remote host that turns out to be the
12493 local host, what happens is controlled by the &%self%& generic router option.
12494 One of its values causes the address to be passed to another router. When this
12495 happens, &$self_hostname$& is set to the name of the local host that the
12496 original router encountered. In other circumstances its contents are null.
12497
12498 .vitem &$sender_address$&
12499 .vindex "&$sender_address$&"
12500 When a message is being processed, this variable contains the sender's address
12501 that was received in the message's envelope. The case of letters in the address
12502 is retained, in both the local part and the domain. For bounce messages, the
12503 value of this variable is the empty string. See also &$return_path$&.
12504
12505 .vitem &$sender_address_data$&
12506 .vindex "&$address_data$&"
12507 .vindex "&$sender_address_data$&"
12508 If &$address_data$& is set when the routers are called from an ACL to verify a
12509 sender address, the final value is preserved in &$sender_address_data$&, to
12510 distinguish it from data from a recipient address. The value does not persist
12511 after the end of the current ACL statement. If you want to preserve it for
12512 longer, you can save it in an ACL variable.
12513
12514 .vitem &$sender_address_domain$&
12515 .vindex "&$sender_address_domain$&"
12516 The domain portion of &$sender_address$&.
12517
12518 .vitem &$sender_address_local_part$&
12519 .vindex "&$sender_address_local_part$&"
12520 The local part portion of &$sender_address$&.
12521
12522 .vitem &$sender_data$&
12523 .vindex "&$sender_data$&"
12524 This variable is set after a lookup success in an ACL &%senders%& condition or
12525 in a router &%senders%& option. It contains the data from the lookup, and the
12526 value remains set until the next &%senders%& test. Thus, you can do things like
12527 this:
12528 .display
12529 &`require senders      = cdb*@;/some/file`&
12530 &`deny    `&&'some further test involving'& &`$sender_data`&
12531 .endd
12532 &*Warning*&: This variable is set only when a lookup is used as an indexing
12533 method in the address list, using the semicolon syntax as in the example above.
12534 The variable is not set for a lookup that is used as part of the string
12535 expansion that all such lists undergo before being interpreted.
12536
12537 .vitem &$sender_fullhost$&
12538 .vindex "&$sender_fullhost$&"
12539 When a message is received from a remote host, this variable contains the host
12540 name and IP address in a single string. It ends with the IP address in square
12541 brackets, followed by a colon and a port number if the logging of ports is
12542 enabled. The format of the rest of the string depends on whether the host
12543 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12544 looking up its IP address. (Looking up the IP address can be forced by the
12545 &%host_lookup%& option, independent of verification.) A plain host name at the
12546 start of the string is a verified host name; if this is not present,
12547 verification either failed or was not requested. A host name in parentheses is
12548 the argument of a HELO or EHLO command. This is omitted if it is identical to
12549 the verified host name or to the host's IP address in square brackets.
12550
12551 .vitem &$sender_helo_dnssec$&
12552 .vindex "&$sender_helo_dnssec$&"
12553 This boolean variable is true if a successful HELO verification was
12554 .cindex "DNS" "DNSSEC"
12555 done using DNS information the resolver library stated was authenticated data.
12556
12557 .vitem &$sender_helo_name$&
12558 .vindex "&$sender_helo_name$&"
12559 When a message is received from a remote host that has issued a HELO or EHLO
12560 command, the argument of that command is placed in this variable. It is also
12561 set if HELO or EHLO is used when a message is received using SMTP locally via
12562 the &%-bs%& or &%-bS%& options.
12563
12564 .vitem &$sender_host_address$&
12565 .vindex "&$sender_host_address$&"
12566 When a message is received from a remote host using SMTP,
12567 this variable contains that
12568 host's IP address. For locally non-SMTP submitted messages, it is empty.
12569
12570 .vitem &$sender_host_authenticated$&
12571 .vindex "&$sender_host_authenticated$&"
12572 This variable contains the name (not the public name) of the authenticator
12573 driver that successfully authenticated the client from which the message was
12574 received. It is empty if there was no successful authentication. See also
12575 &$authenticated_id$&.
12576
12577 .vitem &$sender_host_dnssec$&
12578 .vindex "&$sender_host_dnssec$&"
12579 If an attempt to populate &$sender_host_name$& has been made
12580 (by reference, &%hosts_lookup%& or
12581 otherwise) then this boolean will have been set true if, and only if, the
12582 resolver library states that both
12583 the reverse and forward DNS were authenticated data.  At all
12584 other times, this variable is false.
12585
12586 .cindex "DNS" "DNSSEC"
12587 It is likely that you will need to coerce DNSSEC support on in the resolver
12588 library, by setting:
12589 .code
12590 dns_dnssec_ok = 1
12591 .endd
12592
12593 Exim does not perform DNSSEC validation itself, instead leaving that to a
12594 validating resolver (e.g. unbound, or bind with suitable configuration).
12595
12596 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12597 mechanism in the list, then this variable will be false.
12598
12599
12600 .vitem &$sender_host_name$&
12601 .vindex "&$sender_host_name$&"
12602 When a message is received from a remote host, this variable contains the
12603 host's name as obtained by looking up its IP address. For messages received by
12604 other means, this variable is empty.
12605
12606 .vindex "&$host_lookup_failed$&"
12607 If the host name has not previously been looked up, a reference to
12608 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12609 A looked up name is accepted only if it leads back to the original IP address
12610 via a forward lookup. If either the reverse or the forward lookup fails to find
12611 any data, or if the forward lookup does not yield the original IP address,
12612 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12613
12614 .vindex "&$host_lookup_deferred$&"
12615 However, if either of the lookups cannot be completed (for example, there is a
12616 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12617 &$host_lookup_failed$& remains set to &"0"&.
12618
12619 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12620 host name again if there is a subsequent reference to &$sender_host_name$&
12621 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12622 is set to &"1"&.
12623
12624 Exim does not automatically look up every calling host's name. If you want
12625 maximum efficiency, you should arrange your configuration so that it avoids
12626 these lookups altogether. The lookup happens only if one or more of the
12627 following are true:
12628
12629 .ilist
12630 A string containing &$sender_host_name$& is expanded.
12631 .next
12632 The calling host matches the list in &%host_lookup%&. In the default
12633 configuration, this option is set to *, so it must be changed if lookups are
12634 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12635 .next
12636 Exim needs the host name in order to test an item in a host list. The items
12637 that require this are described in sections &<<SECThoslispatnam>>& and
12638 &<<SECThoslispatnamsk>>&.
12639 .next
12640 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12641 In this case, the host name is required to compare with the name quoted in any
12642 EHLO or HELO commands that the client issues.
12643 .next
12644 The remote host issues a EHLO or HELO command that quotes one of the
12645 domains in &%helo_lookup_domains%&. The default value of this option is
12646 . ==== As this is a nested list, any displays it contains must be indented
12647 . ==== as otherwise they are too far to the left.
12648 .code
12649   helo_lookup_domains = @ : @[]
12650 .endd
12651 which causes a lookup if a remote host (incorrectly) gives the server's name or
12652 IP address in an EHLO or HELO command.
12653 .endlist
12654
12655
12656 .vitem &$sender_host_port$&
12657 .vindex "&$sender_host_port$&"
12658 When a message is received from a remote host, this variable contains the port
12659 number that was used on the remote host.
12660
12661 .vitem &$sender_ident$&
12662 .vindex "&$sender_ident$&"
12663 When a message is received from a remote host, this variable contains the
12664 identification received in response to an RFC 1413 request. When a message has
12665 been received locally, this variable contains the login name of the user that
12666 called Exim.
12667
12668 .vitem &$sender_rate_$&&'xxx'&
12669 A number of variables whose names begin &$sender_rate_$& are set as part of the
12670 &%ratelimit%& ACL condition. Details are given in section
12671 &<<SECTratelimiting>>&.
12672
12673 .vitem &$sender_rcvhost$&
12674 .cindex "DNS" "reverse lookup"
12675 .cindex "reverse DNS lookup"
12676 .vindex "&$sender_rcvhost$&"
12677 This is provided specifically for use in &'Received:'& headers. It starts with
12678 either the verified host name (as obtained from a reverse DNS lookup) or, if
12679 there is no verified host name, the IP address in square brackets. After that
12680 there may be text in parentheses. When the first item is a verified host name,
12681 the first thing in the parentheses is the IP address in square brackets,
12682 followed by a colon and a port number if port logging is enabled. When the
12683 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12684 the parentheses.
12685
12686 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12687 was used and its argument was not identical to the real host name or IP
12688 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12689 all three items are present in the parentheses, a newline and tab are inserted
12690 into the string, to improve the formatting of the &'Received:'& header.
12691
12692 .vitem &$sender_verify_failure$&
12693 .vindex "&$sender_verify_failure$&"
12694 In an ACL, when a sender verification fails, this variable contains information
12695 about the failure. The details are the same as for
12696 &$recipient_verify_failure$&.
12697
12698 .vitem &$sending_ip_address$&
12699 .vindex "&$sending_ip_address$&"
12700 This variable is set whenever an outgoing SMTP connection to another host has
12701 been set up. It contains the IP address of the local interface that is being
12702 used. This is useful if a host that has more than one IP address wants to take
12703 on different personalities depending on which one is being used. For incoming
12704 connections, see &$received_ip_address$&.
12705
12706 .vitem &$sending_port$&
12707 .vindex "&$sending_port$&"
12708 This variable is set whenever an outgoing SMTP connection to another host has
12709 been set up. It contains the local port that is being used. For incoming
12710 connections, see &$received_port$&.
12711
12712 .vitem &$smtp_active_hostname$&
12713 .vindex "&$smtp_active_hostname$&"
12714 During an incoming SMTP session, this variable contains the value of the active
12715 host name, as specified by the &%smtp_active_hostname%& option. The value of
12716 &$smtp_active_hostname$& is saved with any message that is received, so its
12717 value can be consulted during routing and delivery.
12718
12719 .vitem &$smtp_command$&
12720 .vindex "&$smtp_command$&"
12721 During the processing of an incoming SMTP command, this variable contains the
12722 entire command. This makes it possible to distinguish between HELO and EHLO in
12723 the HELO ACL, and also to distinguish between commands such as these:
12724 .code
12725 MAIL FROM:<>
12726 MAIL FROM: <>
12727 .endd
12728 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12729 command, the address in &$smtp_command$& is the original address before any
12730 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12731 the address after SMTP-time rewriting.
12732
12733 .vitem &$smtp_command_argument$&
12734 .cindex "SMTP" "command, argument for"
12735 .vindex "&$smtp_command_argument$&"
12736 While an ACL is running to check an SMTP command, this variable contains the
12737 argument, that is, the text that follows the command name, with leading white
12738 space removed. Following the introduction of &$smtp_command$&, this variable is
12739 somewhat redundant, but is retained for backwards compatibility.
12740
12741 .vitem &$smtp_count_at_connection_start$&
12742 .vindex "&$smtp_count_at_connection_start$&"
12743 This variable is set greater than zero only in processes spawned by the Exim
12744 daemon for handling incoming SMTP connections. The name is deliberately long,
12745 in order to emphasize what the contents are. When the daemon accepts a new
12746 connection, it increments this variable. A copy of the variable is passed to
12747 the child process that handles the connection, but its value is fixed, and
12748 never changes. It is only an approximation of how many incoming connections
12749 there actually are, because many other connections may come and go while a
12750 single connection is being processed. When a child process terminates, the
12751 daemon decrements its copy of the variable.
12752
12753 .vitem "&$sn0$& &-- &$sn9$&"
12754 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12755 that were current at the end of the system filter file. This allows a system
12756 filter file to set values that can be tested in users' filter files. For
12757 example, a system filter could set a value indicating how likely it is that a
12758 message is junk mail.
12759
12760 .vitem &$spam_$&&'xxx'&
12761 A number of variables whose names start with &$spam$& are available when Exim
12762 is compiled with the content-scanning extension. For details, see section
12763 &<<SECTscanspamass>>&.
12764
12765
12766 .vitem &$spool_directory$&
12767 .vindex "&$spool_directory$&"
12768 The name of Exim's spool directory.
12769
12770 .vitem &$spool_inodes$&
12771 .vindex "&$spool_inodes$&"
12772 The number of free inodes in the disk partition where Exim's spool files are
12773 being written. The value is recalculated whenever the variable is referenced.
12774 If the relevant file system does not have the concept of inodes, the value of
12775 is -1. See also the &%check_spool_inodes%& option.
12776
12777 .vitem &$spool_space$&
12778 .vindex "&$spool_space$&"
12779 The amount of free space (as a number of kilobytes) in the disk partition where
12780 Exim's spool files are being written. The value is recalculated whenever the
12781 variable is referenced. If the operating system does not have the ability to
12782 find the amount of free space (only true for experimental systems), the space
12783 value is -1. For example, to check in an ACL that there is at least 50
12784 megabytes free on the spool, you could write:
12785 .code
12786 condition = ${if > {$spool_space}{50000}}
12787 .endd
12788 See also the &%check_spool_space%& option.
12789
12790
12791 .vitem &$thisaddress$&
12792 .vindex "&$thisaddress$&"
12793 This variable is set only during the processing of the &%foranyaddress%&
12794 command in a filter file. Its use is explained in the description of that
12795 command, which can be found in the separate document entitled &'Exim's
12796 interfaces to mail filtering'&.
12797
12798 .vitem &$tls_in_bits$&
12799 .vindex "&$tls_in_bits$&"
12800 Contains an approximation of the TLS cipher's bit-strength
12801 on the inbound connection; the meaning of
12802 this depends upon the TLS implementation used.
12803 If TLS has not been negotiated, the value will be 0.
12804 The value of this is automatically fed into the Cyrus SASL authenticator
12805 when acting as a server, to specify the "external SSF" (a SASL term).
12806
12807 The deprecated &$tls_bits$& variable refers to the inbound side
12808 except when used in the context of an outbound SMTP delivery, when it refers to
12809 the outbound.
12810
12811 .vitem &$tls_out_bits$&
12812 .vindex "&$tls_out_bits$&"
12813 Contains an approximation of the TLS cipher's bit-strength
12814 on an outbound SMTP connection; the meaning of
12815 this depends upon the TLS implementation used.
12816 If TLS has not been negotiated, the value will be 0.
12817
12818 .vitem &$tls_in_ourcert$&
12819 .vindex "&$tls_in_ourcert$&"
12820 .cindex certificate veriables
12821 This variable refers to the certificate presented to the peer of an
12822 inbound connection when the message was received.
12823 It is only useful as the argument of a
12824 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12825 or a &%def%& condition.
12826
12827 .vitem &$tls_in_peercert$&
12828 .vindex "&$tls_in_peercert$&"
12829 This variable refers to the certificate presented by the peer of an
12830 inbound connection when the message was received.
12831 It is only useful as the argument of a
12832 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12833 or a &%def%& condition.
12834 If certificate verification fails it may refer to a failing chain element
12835 which is not the leaf.
12836
12837 .vitem &$tls_out_ourcert$&
12838 .vindex "&$tls_out_ourcert$&"
12839 This variable refers to the certificate presented to the peer of an
12840 outbound connection.  It is only useful as the argument of a
12841 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12842 or a &%def%& condition.
12843
12844 .vitem &$tls_out_peercert$&
12845 .vindex "&$tls_out_peercert$&"
12846 This variable refers to the certificate presented by the peer of an
12847 outbound connection.  It is only useful as the argument of a
12848 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12849 or a &%def%& condition.
12850 If certificate verification fails it may refer to a failing chain element
12851 which is not the leaf.
12852
12853 .vitem &$tls_in_certificate_verified$&
12854 .vindex "&$tls_in_certificate_verified$&"
12855 This variable is set to &"1"& if a TLS certificate was verified when the
12856 message was received, and &"0"& otherwise.
12857
12858 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12859 except when used in the context of an outbound SMTP delivery, when it refers to
12860 the outbound.
12861
12862 .vitem &$tls_out_certificate_verified$&
12863 .vindex "&$tls_out_certificate_verified$&"
12864 This variable is set to &"1"& if a TLS certificate was verified when an
12865 outbound SMTP connection was made,
12866 and &"0"& otherwise.
12867
12868 .vitem &$tls_in_cipher$&
12869 .vindex "&$tls_in_cipher$&"
12870 .vindex "&$tls_cipher$&"
12871 When a message is received from a remote host over an encrypted SMTP
12872 connection, this variable is set to the cipher suite that was negotiated, for
12873 example DES-CBC3-SHA. In other circumstances, in particular, for message
12874 received over unencrypted connections, the variable is empty. Testing
12875 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12876 non-encrypted connections during ACL processing.
12877
12878 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12879 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12880 becomes the same as &$tls_out_cipher$&.
12881
12882 .vitem &$tls_out_cipher$&
12883 .vindex "&$tls_out_cipher$&"
12884 This variable is
12885 cleared before any outgoing SMTP connection is made,
12886 and then set to the outgoing cipher suite if one is negotiated. See chapter
12887 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12888 details of the &(smtp)& transport.
12889
12890 .vitem &$tls_in_ocsp$&
12891 .vindex "&$tls_in_ocsp$&"
12892 When a message is received from a remote client connection
12893 the result of any OCSP request from the client is encoded in this variable:
12894 .code
12895 0 OCSP proof was not requested (default value)
12896 1 No response to request
12897 2 Response not verified
12898 3 Verification failed
12899 4 Verification succeeded
12900 .endd
12901
12902 .vitem &$tls_out_ocsp$&
12903 .vindex "&$tls_out_ocsp$&"
12904 When a message is sent to a remote host connection
12905 the result of any OCSP request made is encoded in this variable.
12906 See &$tls_in_ocsp$& for values.
12907
12908 .vitem &$tls_in_peerdn$&
12909 .vindex "&$tls_in_peerdn$&"
12910 .vindex "&$tls_peerdn$&"
12911 .cindex certificate "extracting fields"
12912 When a message is received from a remote host over an encrypted SMTP
12913 connection, and Exim is configured to request a certificate from the client,
12914 the value of the Distinguished Name of the certificate is made available in the
12915 &$tls_in_peerdn$& during subsequent processing.
12916 If certificate verification fails it may refer to a failing chain element
12917 which is not the leaf.
12918
12919 The deprecated &$tls_peerdn$& variable refers to the inbound side
12920 except when used in the context of an outbound SMTP delivery, when it refers to
12921 the outbound.
12922
12923 .vitem &$tls_out_peerdn$&
12924 .vindex "&$tls_out_peerdn$&"
12925 When a message is being delivered to a remote host over an encrypted SMTP
12926 connection, and Exim is configured to request a certificate from the server,
12927 the value of the Distinguished Name of the certificate is made available in the
12928 &$tls_out_peerdn$& during subsequent processing.
12929 If certificate verification fails it may refer to a failing chain element
12930 which is not the leaf.
12931
12932 .vitem &$tls_in_sni$&
12933 .vindex "&$tls_in_sni$&"
12934 .vindex "&$tls_sni$&"
12935 .cindex "TLS" "Server Name Indication"
12936 When a TLS session is being established, if the client sends the Server
12937 Name Indication extension, the value will be placed in this variable.
12938 If the variable appears in &%tls_certificate%& then this option and
12939 some others, described in &<<SECTtlssni>>&,
12940 will be re-expanded early in the TLS session, to permit
12941 a different certificate to be presented (and optionally a different key to be
12942 used) to the client, based upon the value of the SNI extension.
12943
12944 The deprecated &$tls_sni$& variable refers to the inbound side
12945 except when used in the context of an outbound SMTP delivery, when it refers to
12946 the outbound.
12947
12948 .vitem &$tls_out_sni$&
12949 .vindex "&$tls_out_sni$&"
12950 .cindex "TLS" "Server Name Indication"
12951 During outbound
12952 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12953 the transport.
12954
12955 .vitem &$tod_bsdinbox$&
12956 .vindex "&$tod_bsdinbox$&"
12957 The time of day and the date, in the format required for BSD-style mailbox
12958 files, for example: Thu Oct 17 17:14:09 1995.
12959
12960 .vitem &$tod_epoch$&
12961 .vindex "&$tod_epoch$&"
12962 The time and date as a number of seconds since the start of the Unix epoch.
12963
12964 .vitem &$tod_epoch_l$&
12965 .vindex "&$tod_epoch_l$&"
12966 The time and date as a number of microseconds since the start of the Unix epoch.
12967
12968 .vitem &$tod_full$&
12969 .vindex "&$tod_full$&"
12970 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12971 +0100. The timezone is always given as a numerical offset from UTC, with
12972 positive values used for timezones that are ahead (east) of UTC, and negative
12973 values for those that are behind (west).
12974
12975 .vitem &$tod_log$&
12976 .vindex "&$tod_log$&"
12977 The time and date in the format used for writing Exim's log files, for example:
12978 1995-10-12 15:32:29, but without a timezone.
12979
12980 .vitem &$tod_logfile$&
12981 .vindex "&$tod_logfile$&"
12982 This variable contains the date in the format yyyymmdd. This is the format that
12983 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12984 flag.
12985
12986 .vitem &$tod_zone$&
12987 .vindex "&$tod_zone$&"
12988 This variable contains the numerical value of the local timezone, for example:
12989 -0500.
12990
12991 .vitem &$tod_zulu$&
12992 .vindex "&$tod_zulu$&"
12993 This variable contains the UTC date and time in &"Zulu"& format, as specified
12994 by ISO 8601, for example: 20030221154023Z.
12995
12996 .vitem &$transport_name$&
12997 .cindex "transport" "name"
12998 .cindex "name" "of transport"
12999 .vindex "&$transport_name$&"
13000 During the running of a transport, this variable contains its name.
13001
13002 .vitem &$value$&
13003 .vindex "&$value$&"
13004 This variable contains the result of an expansion lookup, extraction operation,
13005 or external command, as described above. It is also used during a
13006 &*reduce*& expansion.
13007
13008 .vitem &$verify_mode$&
13009 .vindex "&$verify_mode$&"
13010 While a router or transport is being run in verify mode or for cutthrough delivery,
13011 contains "S" for sender-verification or "R" for recipient-verification.
13012 Otherwise, empty.
13013
13014 .vitem &$version_number$&
13015 .vindex "&$version_number$&"
13016 The version number of Exim.
13017
13018 .vitem &$warn_message_delay$&
13019 .vindex "&$warn_message_delay$&"
13020 This variable is set only during the creation of a message warning about a
13021 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13022
13023 .vitem &$warn_message_recipients$&
13024 .vindex "&$warn_message_recipients$&"
13025 This variable is set only during the creation of a message warning about a
13026 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13027 .endlist
13028 .ecindex IIDstrexp
13029
13030
13031
13032 . ////////////////////////////////////////////////////////////////////////////
13033 . ////////////////////////////////////////////////////////////////////////////
13034
13035 .chapter "Embedded Perl" "CHAPperl"
13036 .scindex IIDperl "Perl" "calling from Exim"
13037 Exim can be built to include an embedded Perl interpreter. When this is done,
13038 Perl subroutines can be called as part of the string expansion process. To make
13039 use of the Perl support, you need version 5.004 or later of Perl installed on
13040 your system. To include the embedded interpreter in the Exim binary, include
13041 the line
13042 .code
13043 EXIM_PERL = perl.o
13044 .endd
13045 in your &_Local/Makefile_& and then build Exim in the normal way.
13046
13047
13048 .section "Setting up so Perl can be used" "SECID85"
13049 .oindex "&%perl_startup%&"
13050 Access to Perl subroutines is via a global configuration option called
13051 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13052 no &%perl_startup%& option in the Exim configuration file then no Perl
13053 interpreter is started and there is almost no overhead for Exim (since none of
13054 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13055 option then the associated value is taken to be Perl code which is executed in
13056 a newly created Perl interpreter.
13057
13058 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13059 need backslashes before any characters to escape special meanings. The option
13060 should usually be something like
13061 .code
13062 perl_startup = do '/etc/exim.pl'
13063 .endd
13064 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13065 use from Exim. Exim can be configured either to start up a Perl interpreter as
13066 soon as it is entered, or to wait until the first time it is needed. Starting
13067 the interpreter at the beginning ensures that it is done while Exim still has
13068 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13069 fact used in a particular run. Also, note that this does not mean that Exim is
13070 necessarily running as root when Perl is called at a later time. By default,
13071 the interpreter is started only when it is needed, but this can be changed in
13072 two ways:
13073
13074 .ilist
13075 .oindex "&%perl_at_start%&"
13076 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13077 a startup when Exim is entered.
13078 .next
13079 The command line option &%-ps%& also requests a startup when Exim is entered,
13080 overriding the setting of &%perl_at_start%&.
13081 .endlist
13082
13083 There is also a command line option &%-pd%& (for delay) which suppresses the
13084 initial startup, even if &%perl_at_start%& is set.
13085
13086 .new
13087 .ilist
13088 .oindex "&%perl_taintmode%&"
13089 .cindex "Perl" "taintmode"
13090 To provide more security executing Perl code via the embedded Perl
13091 interpeter, the &%perl_taintmode%& option can be set. This enables the
13092 taint mode of the Perl interpreter. You are encouraged to set this
13093 option to a true value. To avoid breaking existing installations, it
13094 defaults to false.
13095 .wen
13096
13097
13098 .section "Calling Perl subroutines" "SECID86"
13099 When the configuration file includes a &%perl_startup%& option you can make use
13100 of the string expansion item to call the Perl subroutines that are defined
13101 by the &%perl_startup%& code. The operator is used in any of the following
13102 forms:
13103 .code
13104 ${perl{foo}}
13105 ${perl{foo}{argument}}
13106 ${perl{foo}{argument1}{argument2} ... }
13107 .endd
13108 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13109 arguments may be passed. Passing more than this results in an expansion failure
13110 with an error message of the form
13111 .code
13112 Too many arguments passed to Perl subroutine "foo" (max is 8)
13113 .endd
13114 The return value of the Perl subroutine is evaluated in a scalar context before
13115 it is passed back to Exim to be inserted into the expanded string. If the
13116 return value is &'undef'&, the expansion is forced to fail in the same way as
13117 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13118 by obeying Perl's &%die%& function, the expansion fails with the error message
13119 that was passed to &%die%&.
13120
13121
13122 .section "Calling Exim functions from Perl" "SECID87"
13123 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13124 is available to call back into Exim's string expansion function. For example,
13125 the Perl code
13126 .code
13127 my $lp = Exim::expand_string('$local_part');
13128 .endd
13129 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13130 Note those are single quotes and not double quotes to protect against
13131 &$local_part$& being interpolated as a Perl variable.
13132
13133 If the string expansion is forced to fail by a &"fail"& item, the result of
13134 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13135 expansion string, the Perl call from the original expansion string fails with
13136 an appropriate error message, in the same way as if &%die%& were used.
13137
13138 .cindex "debugging" "from embedded Perl"
13139 .cindex "log" "writing from embedded Perl"
13140 Two other Exim functions are available for use from within Perl code.
13141 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13142 debugging is enabled. If you want a newline at the end, you must supply it.
13143 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13144 timestamp. In this case, you should not supply a terminating newline.
13145
13146
13147 .section "Use of standard output and error by Perl" "SECID88"
13148 .cindex "Perl" "standard output and error"
13149 You should not write to the standard error or output streams from within your
13150 Perl code, as it is not defined how these are set up. In versions of Exim
13151 before 4.50, it is possible for the standard output or error to refer to the
13152 SMTP connection during message reception via the daemon. Writing to this stream
13153 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13154 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13155 avoided, but the output is lost.
13156
13157 .cindex "Perl" "use of &%warn%&"
13158 The Perl &%warn%& statement writes to the standard error stream by default.
13159 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13160 you have no control. When Exim starts up the Perl interpreter, it arranges for
13161 output from the &%warn%& statement to be written to the Exim main log. You can
13162 change this by including appropriate Perl magic somewhere in your Perl code.
13163 For example, to discard &%warn%& output completely, you need this:
13164 .code
13165 $SIG{__WARN__} = sub { };
13166 .endd
13167 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13168 example, the code for the subroutine is empty, so it does nothing, but you can
13169 include any Perl code that you like. The text of the &%warn%& message is passed
13170 as the first subroutine argument.
13171 .ecindex IIDperl
13172
13173
13174 . ////////////////////////////////////////////////////////////////////////////
13175 . ////////////////////////////////////////////////////////////////////////////
13176
13177 .chapter "Starting the daemon and the use of network interfaces" &&&
13178          "CHAPinterfaces" &&&
13179          "Starting the daemon"
13180 .cindex "daemon" "starting"
13181 .cindex "interface" "listening"
13182 .cindex "network interface"
13183 .cindex "interface" "network"
13184 .cindex "IP address" "for listening"
13185 .cindex "daemon" "listening IP addresses"
13186 .cindex "TCP/IP" "setting listening interfaces"
13187 .cindex "TCP/IP" "setting listening ports"
13188 A host that is connected to a TCP/IP network may have one or more physical
13189 hardware network interfaces. Each of these interfaces may be configured as one
13190 or more &"logical"& interfaces, which are the entities that a program actually
13191 works with. Each of these logical interfaces is associated with an IP address.
13192 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13193 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13194 knowledge about the host's interfaces for use in three different circumstances:
13195
13196 .olist
13197 When a listening daemon is started, Exim needs to know which interfaces
13198 and ports to listen on.
13199 .next
13200 When Exim is routing an address, it needs to know which IP addresses
13201 are associated with local interfaces. This is required for the correct
13202 processing of MX lists by removing the local host and others with the
13203 same or higher priority values. Also, Exim needs to detect cases
13204 when an address is routed to an IP address that in fact belongs to the
13205 local host. Unless the &%self%& router option or the &%allow_localhost%&
13206 option of the smtp transport is set (as appropriate), this is treated
13207 as an error situation.
13208 .next
13209 When Exim connects to a remote host, it may need to know which interface to use
13210 for the outgoing connection.
13211 .endlist
13212
13213
13214 Exim's default behaviour is likely to be appropriate in the vast majority
13215 of cases. If your host has only one interface, and you want all its IP
13216 addresses to be treated in the same way, and you are using only the
13217 standard SMTP port, you should not need to take any special action. The
13218 rest of this chapter does not apply to you.
13219
13220 In a more complicated situation you may want to listen only on certain
13221 interfaces, or on different ports, and for this reason there are a number of
13222 options that can be used to influence Exim's behaviour. The rest of this
13223 chapter describes how they operate.
13224
13225 When a message is received over TCP/IP, the interface and port that were
13226 actually used are set in &$received_ip_address$& and &$received_port$&.
13227
13228
13229
13230 .section "Starting a listening daemon" "SECID89"
13231 When a listening daemon is started (by means of the &%-bd%& command line
13232 option), the interfaces and ports on which it listens are controlled by the
13233 following options:
13234
13235 .ilist
13236 &%daemon_smtp_ports%& contains a list of default ports
13237 or service names.
13238 (For backward compatibility, this option can also be specified in the singular.)
13239 .next
13240 &%local_interfaces%& contains list of interface IP addresses on which to
13241 listen. Each item may optionally also specify a port.
13242 .endlist
13243
13244 The default list separator in both cases is a colon, but this can be changed as
13245 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13246 it is usually best to change the separator to avoid having to double all the
13247 colons. For example:
13248 .code
13249 local_interfaces = <; 127.0.0.1 ; \
13250                       192.168.23.65 ; \
13251                       ::1 ; \
13252                       3ffe:ffff:836f::fe86:a061
13253 .endd
13254 There are two different formats for specifying a port along with an IP address
13255 in &%local_interfaces%&:
13256
13257 .olist
13258 The port is added onto the address with a dot separator. For example, to listen
13259 on port 1234 on two different IP addresses:
13260 .code
13261 local_interfaces = <; 192.168.23.65.1234 ; \
13262                       3ffe:ffff:836f::fe86:a061.1234
13263 .endd
13264 .next
13265 The IP address is enclosed in square brackets, and the port is added
13266 with a colon separator, for example:
13267 .code
13268 local_interfaces = <; [192.168.23.65]:1234 ; \
13269                       [3ffe:ffff:836f::fe86:a061]:1234
13270 .endd
13271 .endlist
13272
13273 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13274 default setting contains just one port:
13275 .code
13276 daemon_smtp_ports = smtp
13277 .endd
13278 If more than one port is listed, each interface that does not have its own port
13279 specified listens on all of them. Ports that are listed in
13280 &%daemon_smtp_ports%& can be identified either by name (defined in
13281 &_/etc/services_&) or by number. However, when ports are given with individual
13282 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13283
13284
13285
13286 .section "Special IP listening addresses" "SECID90"
13287 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13288 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13289 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13290 instead of setting up separate listening sockets for each interface. The
13291 default value of &%local_interfaces%& is
13292 .code
13293 local_interfaces = 0.0.0.0
13294 .endd
13295 when Exim is built without IPv6 support; otherwise it is:
13296 .code
13297 local_interfaces = <; ::0 ; 0.0.0.0
13298 .endd
13299 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13300
13301
13302
13303 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13304 The &%-oX%& command line option can be used to override the values of
13305 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13306 instance. Another way of doing this would be to use macros and the &%-D%&
13307 option. However, &%-oX%& can be used by any admin user, whereas modification of
13308 the runtime configuration by &%-D%& is allowed only when the caller is root or
13309 exim.
13310
13311 The value of &%-oX%& is a list of items. The default colon separator can be
13312 changed in the usual way if required. If there are any items that do not
13313 contain dots or colons (that is, are not IP addresses), the value of
13314 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13315 items that do contain dots or colons, the value of &%local_interfaces%& is
13316 replaced by those items. Thus, for example,
13317 .code
13318 -oX 1225
13319 .endd
13320 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13321 whereas
13322 .code
13323 -oX 192.168.34.5.1125
13324 .endd
13325 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13326 (However, since &%local_interfaces%& now contains no items without ports, the
13327 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13328
13329
13330
13331 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13332 .cindex "ssmtp protocol"
13333 .cindex "smtps protocol"
13334 .cindex "SMTP" "ssmtp protocol"
13335 .cindex "SMTP" "smtps protocol"
13336 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13337 before the STARTTLS command was standardized for SMTP. Some legacy clients
13338 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13339 list of port numbers or service names,
13340 connections to those ports must use SSMTP. The most
13341 common use of this option is expected to be
13342 .code
13343 tls_on_connect_ports = 465
13344 .endd
13345 because 465 is the usual port number used by the legacy clients. There is also
13346 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13347 this way when a daemon is started.
13348
13349 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13350 daemon to listen on those ports. You must still specify them in
13351 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13352 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13353 connections via the daemon.)
13354
13355
13356
13357
13358 .section "IPv6 address scopes" "SECID92"
13359 .cindex "IPv6" "address scopes"
13360 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13361 can, in principle, have the same link-local IPv6 address on different
13362 interfaces. Thus, additional information is needed, over and above the IP
13363 address, to distinguish individual interfaces. A convention of using a
13364 percent sign followed by something (often the interface name) has been
13365 adopted in some cases, leading to addresses like this:
13366 .code
13367 fe80::202:b3ff:fe03:45c1%eth0
13368 .endd
13369 To accommodate this usage, a percent sign followed by an arbitrary string is
13370 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13371 to convert a textual IPv6 address for actual use. This function recognizes the
13372 percent convention in operating systems that support it, and it processes the
13373 address appropriately. Unfortunately, some older libraries have problems with
13374 &[getaddrinfo()]&. If
13375 .code
13376 IPV6_USE_INET_PTON=yes
13377 .endd
13378 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13379 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13380 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13381 function.) Of course, this means that the additional functionality of
13382 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13383
13384 .section "Disabling IPv6" "SECID93"
13385 .cindex "IPv6" "disabling"
13386 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13387 run on a host whose kernel does not support IPv6. The binary will fall back to
13388 using IPv4, but it may waste resources looking up AAAA records, and trying to
13389 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13390 .oindex "&%disable_ipv6%&"
13391 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13392 activities take place. AAAA records are never looked up, and any IPv6 addresses
13393 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13394 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13395 to handle IPv6 literal addresses.
13396
13397 On the other hand, when IPv6 is in use, there may be times when you want to
13398 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13399 option to globally suppress the lookup of AAAA records for specified domains,
13400 and you can use the &%ignore_target_hosts%& generic router option to ignore
13401 IPv6 addresses in an individual router.
13402
13403
13404
13405 .section "Examples of starting a listening daemon" "SECID94"
13406 The default case in an IPv6 environment is
13407 .code
13408 daemon_smtp_ports = smtp
13409 local_interfaces = <; ::0 ; 0.0.0.0
13410 .endd
13411 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13412 Either one or two sockets may be used, depending on the characteristics of
13413 the TCP/IP stack. (This is complicated and messy; for more information,
13414 read the comments in the &_daemon.c_& source file.)
13415
13416 To specify listening on ports 25 and 26 on all interfaces:
13417 .code
13418 daemon_smtp_ports = 25 : 26
13419 .endd
13420 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13421 .code
13422 local_interfaces = <; ::0.25     ; ::0.26 \
13423                       0.0.0.0.25 ; 0.0.0.0.26
13424 .endd
13425 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13426 IPv4 loopback address only:
13427 .code
13428 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13429 .endd
13430 To specify listening on the default port on specific interfaces only:
13431 .code
13432 local_interfaces = 10.0.0.67 : 192.168.34.67
13433 .endd
13434 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13435
13436
13437
13438 .section "Recognizing the local host" "SECTreclocipadd"
13439 The &%local_interfaces%& option is also used when Exim needs to determine
13440 whether or not an IP address refers to the local host. That is, the IP
13441 addresses of all the interfaces on which a daemon is listening are always
13442 treated as local.
13443
13444 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13445 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13446 available interfaces from the operating system, and extracts the relevant
13447 (that is, IPv4 or IPv6) addresses to use for checking.
13448
13449 Some systems set up large numbers of virtual interfaces in order to provide
13450 many virtual web servers. In this situation, you may want to listen for
13451 email on only a few of the available interfaces, but nevertheless treat all
13452 interfaces as local when routing. You can do this by setting
13453 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13454 &"all"& wildcard values. These addresses are recognized as local, but are not
13455 used for listening. Consider this example:
13456 .code
13457 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13458                       192.168.53.235 ; \
13459                       3ffe:2101:12:1:a00:20ff:fe86:a061
13460
13461 extra_local_interfaces = <; ::0 ; 0.0.0.0
13462 .endd
13463 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13464 address, but all available interface addresses are treated as local when
13465 Exim is routing.
13466
13467 In some environments the local host name may be in an MX list, but with an IP
13468 address that is not assigned to any local interface. In other cases it may be
13469 desirable to treat other host names as if they referred to the local host. Both
13470 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13471 This contains host names rather than IP addresses. When a host is referenced
13472 during routing, either via an MX record or directly, it is treated as the local
13473 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13474 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13475
13476
13477
13478 .section "Delivering to a remote host" "SECID95"
13479 Delivery to a remote host is handled by the smtp transport. By default, it
13480 allows the system's TCP/IP functions to choose which interface to use (if
13481 there is more than one) when connecting to a remote host. However, the
13482 &%interface%& option can be set to specify which interface is used. See the
13483 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13484 details.
13485
13486
13487
13488
13489 . ////////////////////////////////////////////////////////////////////////////
13490 . ////////////////////////////////////////////////////////////////////////////
13491
13492 .chapter "Main configuration" "CHAPmainconfig"
13493 .scindex IIDconfima "configuration file" "main section"
13494 .scindex IIDmaiconf "main configuration"
13495 The first part of the run time configuration file contains three types of item:
13496
13497 .ilist
13498 Macro definitions: These lines start with an upper case letter. See section
13499 &<<SECTmacrodefs>>& for details of macro processing.
13500 .next
13501 Named list definitions: These lines start with one of the words &"domainlist"&,
13502 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13503 section &<<SECTnamedlists>>&.
13504 .next
13505 Main configuration settings: Each setting occupies one line of the file
13506 (with possible continuations). If any setting is preceded by the word
13507 &"hide"&, the &%-bP%& command line option displays its value to admin users
13508 only. See section &<<SECTcos>>& for a description of the syntax of these option
13509 settings.
13510 .endlist
13511
13512 This chapter specifies all the main configuration options, along with their
13513 types and default values. For ease of finding a particular option, they appear
13514 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13515 are now so many options, they are first listed briefly in functional groups, as
13516 an aid to finding the name of the option you are looking for. Some options are
13517 listed in more than one group.
13518
13519 .section "Miscellaneous" "SECID96"
13520 .table2
13521 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13522 .row &%disable_ipv6%&                "do no IPv6 processing"
13523 .row &%keep_malformed%&              "for broken files &-- should not happen"
13524 .row &%localhost_number%&            "for unique message ids in clusters"
13525 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13526 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13527 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13528 .row &%print_topbitchars%&           "top-bit characters are printing"
13529 .row &%timezone%&                    "force time zone"
13530 .endtable
13531
13532
13533 .section "Exim parameters" "SECID97"
13534 .table2
13535 .row &%exim_group%&                  "override compiled-in value"
13536 .row &%exim_path%&                   "override compiled-in value"
13537 .row &%exim_user%&                   "override compiled-in value"
13538 .row &%primary_hostname%&            "default from &[uname()]&"
13539 .row &%split_spool_directory%&       "use multiple directories"
13540 .row &%spool_directory%&             "override compiled-in value"
13541 .endtable
13542
13543
13544
13545 .section "Privilege controls" "SECID98"
13546 .table2
13547 .row &%admin_groups%&                "groups that are Exim admin users"
13548 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13549 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13550 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13551 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13552 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13553 .row &%never_users%&                 "do not run deliveries as these"
13554 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13555 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13556 .row &%trusted_groups%&              "groups that are trusted"
13557 .row &%trusted_users%&               "users that are trusted"
13558 .endtable
13559
13560
13561
13562 .section "Logging" "SECID99"
13563 .table2
13564 .row &%event_action%&                "custom logging"
13565 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13566 .row &%log_file_path%&               "override compiled-in value"
13567 .row &%log_selector%&                "set/unset optional logging"
13568 .row &%log_timezone%&                "add timezone to log lines"
13569 .row &%message_logs%&                "create per-message logs"
13570 .row &%preserve_message_logs%&       "after message completion"
13571 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13572 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13573 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13574 .row &%syslog_facility%&             "set syslog &""facility""& field"
13575 .row &%syslog_processname%&          "set syslog &""ident""& field"
13576 .row &%syslog_timestamp%&            "timestamp syslog lines"
13577 .row &%write_rejectlog%&             "control use of message log"
13578 .endtable
13579
13580
13581
13582 .section "Frozen messages" "SECID100"
13583 .table2
13584 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13585 .row &%freeze_tell%&                 "send message when freezing"
13586 .row &%move_frozen_messages%&        "to another directory"
13587 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13588 .endtable
13589
13590
13591
13592 .section "Data lookups" "SECID101"
13593 .table2
13594 .row &%ibase_servers%&               "InterBase servers"
13595 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13596 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13597 .row &%ldap_cert_file%&              "client cert file for LDAP"
13598 .row &%ldap_cert_key%&               "client key file for LDAP"
13599 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13600 .row &%ldap_default_servers%&        "used if no server in query"
13601 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13602 .row &%ldap_start_tls%&              "require TLS within LDAP"
13603 .row &%ldap_version%&                "set protocol version"
13604 .row &%lookup_open_max%&             "lookup files held open"
13605 .row &%mysql_servers%&               "default MySQL servers"
13606 .row &%oracle_servers%&              "Oracle servers"
13607 .row &%pgsql_servers%&               "default PostgreSQL servers"
13608 .row &%sqlite_lock_timeout%&         "as it says"
13609 .endtable
13610
13611
13612
13613 .section "Message ids" "SECID102"
13614 .table2
13615 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13616 .row &%message_id_header_text%&      "ditto"
13617 .endtable
13618
13619
13620
13621 .section "Embedded Perl Startup" "SECID103"
13622 .table2
13623 .row &%perl_at_start%&               "always start the interpreter"
13624 .row &%perl_startup%&                "code to obey when starting Perl"
13625 .row &%perl_taintmode%&              "enable taint mode in Perl"
13626 .endtable
13627
13628
13629
13630 .section "Daemon" "SECID104"
13631 .table2
13632 .row &%daemon_smtp_ports%&           "default ports"
13633 .row &%daemon_startup_retries%&      "number of times to retry"
13634 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13635 .row &%extra_local_interfaces%&      "not necessarily listened on"
13636 .row &%local_interfaces%&            "on which to listen, with optional ports"
13637 .row &%pid_file_path%&               "override compiled-in value"
13638 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13639 .endtable
13640
13641
13642
13643 .section "Resource control" "SECID105"
13644 .table2
13645 .row &%check_log_inodes%&            "before accepting a message"
13646 .row &%check_log_space%&             "before accepting a message"
13647 .row &%check_spool_inodes%&          "before accepting a message"
13648 .row &%check_spool_space%&           "before accepting a message"
13649 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13650 .row &%queue_only_load%&             "queue incoming if load high"
13651 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13652 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13653 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13654 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13655 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13656 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13657 .row &%smtp_accept_max_per_connection%& "messages per connection"
13658 .row &%smtp_accept_max_per_host%&    "connections from one host"
13659 .row &%smtp_accept_queue%&           "queue mail if more connections"
13660 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13661                                            connection"
13662 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13663 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13664 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13665 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13666 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13667 .endtable
13668
13669
13670
13671 .section "Policy controls" "SECID106"
13672 .table2
13673 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13674 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13675 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13676 .row &%acl_smtp_auth%&               "ACL for AUTH"
13677 .row &%acl_smtp_connect%&            "ACL for connection"
13678 .row &%acl_smtp_data%&               "ACL for DATA"
13679 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13680 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13681 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13682 .row &%acl_smtp_expn%&               "ACL for EXPN"
13683 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13684 .row &%acl_smtp_mail%&               "ACL for MAIL"
13685 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13686 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13687 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13688 .row &%acl_smtp_predata%&            "ACL for start of data"
13689 .row &%acl_smtp_quit%&               "ACL for QUIT"
13690 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13691 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13692 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13693 .row &%av_scanner%&                  "specify virus scanner"
13694 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13695                                       words""&"
13696 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13697 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13698 .row &%header_maxsize%&              "total size of message header"
13699 .row &%header_line_maxsize%&         "individual header line limit"
13700 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13701 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13702 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13703 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13704 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13705 .row &%host_lookup%&                 "host name looked up for these hosts"
13706 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13707 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13708 .row &%host_reject_connection%&      "reject connection from these hosts"
13709 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13710 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13711 .row &%message_size_limit%&          "for all messages"
13712 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13713 .row &%spamd_address%&               "set interface to SpamAssassin"
13714 .row &%strict_acl_vars%&             "object to unset ACL variables"
13715 .endtable
13716
13717
13718
13719 .section "Callout cache" "SECID107"
13720 .table2
13721 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13722                                          item"
13723 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13724                                          item"
13725 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13726 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13727 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13728 .endtable
13729
13730
13731
13732 .section "TLS" "SECID108"
13733 .table2
13734 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13735 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13736 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13737 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13738 .row &%tls_certificate%&             "location of server certificate"
13739 .row &%tls_crl%&                     "certificate revocation list"
13740 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13741 .row &%tls_dhparam%&                 "DH parameters for server"
13742 .row &%tls_eccurve%&                 "EC curve selection for server"
13743 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13744 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13745 .row &%tls_privatekey%&              "location of server private key"
13746 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13747 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13748 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13749 .row &%tls_verify_certificates%&     "expected client certificates"
13750 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13751 .endtable
13752
13753
13754
13755 .section "Local user handling" "SECID109"
13756 .table2
13757 .row &%finduser_retries%&            "useful in NIS environments"
13758 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13759 .row &%gecos_pattern%&               "ditto"
13760 .row &%max_username_length%&         "for systems that truncate"
13761 .row &%unknown_login%&               "used when no login name found"
13762 .row &%unknown_username%&            "ditto"
13763 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13764 .row &%uucp_from_sender%&            "ditto"
13765 .endtable
13766
13767
13768
13769 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13770 .table2
13771 .row &%header_maxsize%&              "total size of message header"
13772 .row &%header_line_maxsize%&         "individual header line limit"
13773 .row &%message_size_limit%&          "applies to all messages"
13774 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13775 .row &%received_header_text%&        "expanded to make &'Received:'&"
13776 .row &%received_headers_max%&        "for mail loop detection"
13777 .row &%recipients_max%&              "limit per message"
13778 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13779 .endtable
13780
13781
13782
13783
13784 .section "Non-SMTP incoming messages" "SECID111"
13785 .table2
13786 .row &%receive_timeout%&             "for non-SMTP messages"
13787 .endtable
13788
13789
13790
13791
13792
13793 .section "Incoming SMTP messages" "SECID112"
13794 See also the &'Policy controls'& section above.
13795
13796 .table2
13797 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13798 .row &%host_lookup%&                 "host name looked up for these hosts"
13799 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13800 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13801 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13802 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13803 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13804 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13805 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13806 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13807 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13808 .row &%smtp_accept_max_per_connection%& "messages per connection"
13809 .row &%smtp_accept_max_per_host%&    "connections from one host"
13810 .row &%smtp_accept_queue%&           "queue mail if more connections"
13811 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13812                                            connection"
13813 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13814 .row &%smtp_active_hostname%&        "host name to use in messages"
13815 .row &%smtp_banner%&                 "text for welcome banner"
13816 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13817 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13818 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13819 .row &%smtp_etrn_command%&           "what to run for ETRN"
13820 .row &%smtp_etrn_serialize%&         "only one at once"
13821 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13822 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13823 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13824 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13825 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13826 .row &%smtp_receive_timeout%&        "per command or data line"
13827 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13828 .row &%smtp_return_error_details%&   "give detail on rejections"
13829 .endtable
13830
13831
13832
13833 .section "SMTP extensions" "SECID113"
13834 .table2
13835 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13836 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13837 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13838 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13839 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13840 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13841 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13842 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13843 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13844 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13845 .endtable
13846
13847
13848
13849 .section "Processing messages" "SECID114"
13850 .table2
13851 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13852 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13853 .row &%allow_utf8_domains%&          "in addresses"
13854 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13855                                       words""&"
13856 .row &%delivery_date_remove%&        "from incoming messages"
13857 .row &%envelope_to_remove%&          "from incoming messages"
13858 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13859 .row &%headers_charset%&             "default for translations"
13860 .row &%qualify_domain%&              "default for senders"
13861 .row &%qualify_recipient%&           "default for recipients"
13862 .row &%return_path_remove%&          "from incoming messages"
13863 .row &%strip_excess_angle_brackets%& "in addresses"
13864 .row &%strip_trailing_dot%&          "at end of addresses"
13865 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13866 .endtable
13867
13868
13869
13870 .section "System filter" "SECID115"
13871 .table2
13872 .row &%system_filter%&               "locate system filter"
13873 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13874                                             directory"
13875 .row &%system_filter_file_transport%& "transport for delivery to a file"
13876 .row &%system_filter_group%&         "group for filter running"
13877 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13878 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13879 .row &%system_filter_user%&          "user for filter running"
13880 .endtable
13881
13882
13883
13884 .section "Routing and delivery" "SECID116"
13885 .table2
13886 .row &%disable_ipv6%&                "do no IPv6 processing"
13887 .row &%dns_again_means_nonexist%&    "for broken domains"
13888 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13889 .row &%dns_dnssec_ok%&               "parameter for resolver"
13890 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13891 .row &%dns_retrans%&                 "parameter for resolver"
13892 .row &%dns_retry%&                   "parameter for resolver"
13893 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13894 .row &%dns_use_edns0%&               "parameter for resolver"
13895 .row &%hold_domains%&                "hold delivery for these domains"
13896 .row &%local_interfaces%&            "for routing checks"
13897 .row &%queue_domains%&               "no immediate delivery for these"
13898 .row &%queue_only%&                  "no immediate delivery at all"
13899 .row &%queue_only_file%&             "no immediate delivery if file exists"
13900 .row &%queue_only_load%&             "no immediate delivery if load is high"
13901 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13902 .row &%queue_only_override%&         "allow command line to override"
13903 .row &%queue_run_in_order%&          "order of arrival"
13904 .row &%queue_run_max%&               "of simultaneous queue runners"
13905 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13906 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13907 .row &%remote_sort_domains%&         "order of remote deliveries"
13908 .row &%retry_data_expire%&           "timeout for retry data"
13909 .row &%retry_interval_max%&          "safety net for retry rules"
13910 .endtable
13911
13912
13913
13914 .section "Bounce and warning messages" "SECID117"
13915 .table2
13916 .row &%bounce_message_file%&         "content of bounce"
13917 .row &%bounce_message_text%&         "content of bounce"
13918 .row &%bounce_return_body%&          "include body if returning message"
13919 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13920 .row &%bounce_return_message%&       "include original message in bounce"
13921 .row &%bounce_return_size_limit%&    "limit on returned message"
13922 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13923 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13924 .row &%errors_copy%&                 "copy bounce messages"
13925 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13926 .row &%delay_warning%&               "time schedule"
13927 .row &%delay_warning_condition%&     "condition for warning messages"
13928 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13929 .row &%smtp_return_error_details%&   "give detail on rejections"
13930 .row &%warn_message_file%&           "content of warning message"
13931 .endtable
13932
13933
13934
13935 .section "Alphabetical list of main options" "SECTalomo"
13936 Those options that undergo string expansion before use are marked with
13937 &dagger;.
13938
13939 .option accept_8bitmime main boolean true
13940 .cindex "8BITMIME"
13941 .cindex "8-bit characters"
13942 .cindex "log" "selectors"
13943 .cindex "log" "8BITMIME"
13944 This option causes Exim to send 8BITMIME in its response to an SMTP
13945 EHLO command, and to accept the BODY= parameter on MAIL commands.
13946 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13947 takes no steps to do anything special with messages received by this route.
13948
13949 Historically Exim kept this option off by default, but the maintainers
13950 feel that in today's Internet, this causes more problems than it solves.
13951 It now defaults to true.
13952 A more detailed analysis of the issues is provided by Dan Bernstein:
13953 .display
13954 &url(http://cr.yp.to/smtp/8bitmime.html)
13955 .endd
13956
13957 To log received 8BITMIME status use
13958 .code
13959 log_selector = +8bitmime
13960 .endd
13961
13962 .option acl_not_smtp main string&!! unset
13963 .cindex "&ACL;" "for non-SMTP messages"
13964 .cindex "non-SMTP messages" "ACLs for"
13965 This option defines the ACL that is run when a non-SMTP message has been
13966 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13967 further details.
13968
13969 .option acl_not_smtp_mime main string&!! unset
13970 This option defines the ACL that is run for individual MIME parts of non-SMTP
13971 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13972 SMTP messages.
13973
13974 .option acl_not_smtp_start main string&!! unset
13975 .cindex "&ACL;" "at start of non-SMTP message"
13976 .cindex "non-SMTP messages" "ACLs for"
13977 This option defines the ACL that is run before Exim starts reading a
13978 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13979
13980 .option acl_smtp_auth main string&!! unset
13981 .cindex "&ACL;" "setting up for SMTP commands"
13982 .cindex "AUTH" "ACL for"
13983 This option defines the ACL that is run when an SMTP AUTH command is
13984 received. See chapter &<<CHAPACL>>& for further details.
13985
13986 .option acl_smtp_connect main string&!! unset
13987 .cindex "&ACL;" "on SMTP connection"
13988 This option defines the ACL that is run when an SMTP connection is received.
13989 See chapter &<<CHAPACL>>& for further details.
13990
13991 .option acl_smtp_data main string&!! unset
13992 .cindex "DATA" "ACL for"
13993 This option defines the ACL that is run after an SMTP DATA command has been
13994 processed and the message itself has been received, but before the final
13995 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13996
13997 .option acl_smtp_data_prdr main string&!! accept
13998 .cindex "PRDR" "ACL for"
13999 .cindex "DATA" "PRDR ACL for"
14000 .cindex "&ACL;" "PRDR-related"
14001 .cindex "&ACL;" "per-user data processing"
14002 This option defines the ACL that,
14003 if the PRDR feature has been negotiated,
14004 is run for each recipient after an SMTP DATA command has been
14005 processed and the message itself has been received, but before the
14006 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14007
14008 .option acl_smtp_dkim main string&!! unset
14009 .cindex DKIM "ACL for"
14010 This option defines the ACL that is run for each DKIM signature
14011 of a received message.
14012 See chapter &<<CHAPdkim>>& for further details.
14013
14014 .option acl_smtp_etrn main string&!! unset
14015 .cindex "ETRN" "ACL for"
14016 This option defines the ACL that is run when an SMTP ETRN command is
14017 received. See chapter &<<CHAPACL>>& for further details.
14018
14019 .option acl_smtp_expn main string&!! unset
14020 .cindex "EXPN" "ACL for"
14021 This option defines the ACL that is run when an SMTP EXPN command is
14022 received. See chapter &<<CHAPACL>>& for further details.
14023
14024 .option acl_smtp_helo main string&!! unset
14025 .cindex "EHLO" "ACL for"
14026 .cindex "HELO" "ACL for"
14027 This option defines the ACL that is run when an SMTP EHLO or HELO
14028 command is received. See chapter &<<CHAPACL>>& for further details.
14029
14030
14031 .option acl_smtp_mail main string&!! unset
14032 .cindex "MAIL" "ACL for"
14033 This option defines the ACL that is run when an SMTP MAIL command is
14034 received. See chapter &<<CHAPACL>>& for further details.
14035
14036 .option acl_smtp_mailauth main string&!! unset
14037 .cindex "AUTH" "on MAIL command"
14038 This option defines the ACL that is run when there is an AUTH parameter on
14039 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14040 &<<CHAPSMTPAUTH>>& for details of authentication.
14041
14042 .option acl_smtp_mime main string&!! unset
14043 .cindex "MIME content scanning" "ACL for"
14044 This option is available when Exim is built with the content-scanning
14045 extension. It defines the ACL that is run for each MIME part in a message. See
14046 section &<<SECTscanmimepart>>& for details.
14047
14048 .option acl_smtp_notquit main string&!! unset
14049 .cindex "not-QUIT, ACL for"
14050 This option defines the ACL that is run when an SMTP session
14051 ends without a QUIT command being received.
14052 See chapter &<<CHAPACL>>& for further details.
14053
14054 .option acl_smtp_predata main string&!! unset
14055 This option defines the ACL that is run when an SMTP DATA command is
14056 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14057 further details.
14058
14059 .option acl_smtp_quit main string&!! unset
14060 .cindex "QUIT, ACL for"
14061 This option defines the ACL that is run when an SMTP QUIT command is
14062 received. See chapter &<<CHAPACL>>& for further details.
14063
14064 .option acl_smtp_rcpt main string&!! unset
14065 .cindex "RCPT" "ACL for"
14066 This option defines the ACL that is run when an SMTP RCPT command is
14067 received. See chapter &<<CHAPACL>>& for further details.
14068
14069 .option acl_smtp_starttls main string&!! unset
14070 .cindex "STARTTLS, ACL for"
14071 This option defines the ACL that is run when an SMTP STARTTLS command is
14072 received. See chapter &<<CHAPACL>>& for further details.
14073
14074 .option acl_smtp_vrfy main string&!! unset
14075 .cindex "VRFY" "ACL for"
14076 This option defines the ACL that is run when an SMTP VRFY command is
14077 received. See chapter &<<CHAPACL>>& for further details.
14078
14079 .option add_environment main "string list" empty
14080 .cindex "environment" "set values"
14081 This option allows to set individual environment variables that the
14082 currently linked libraries and programs in child processes use.
14083 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14084
14085 .option admin_groups main "string list&!!" unset
14086 .cindex "admin user"
14087 This option is expanded just once, at the start of Exim's processing. If the
14088 current group or any of the supplementary groups of an Exim caller is in this
14089 colon-separated list, the caller has admin privileges. If all your system
14090 programmers are in a specific group, for example, you can give them all Exim
14091 admin privileges by putting that group in &%admin_groups%&. However, this does
14092 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14093 To permit this, you have to add individuals to the Exim group.
14094
14095 .option allow_domain_literals main boolean false
14096 .cindex "domain literal"
14097 If this option is set, the RFC 2822 domain literal format is permitted in
14098 email addresses. The option is not set by default, because the domain literal
14099 format is not normally required these days, and few people know about it. It
14100 has, however, been exploited by mail abusers.
14101
14102 Unfortunately, it seems that some DNS black list maintainers are using this
14103 format to report black listing to postmasters. If you want to accept messages
14104 addressed to your hosts by IP address, you need to set
14105 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14106 domains (defined in the named domain list &%local_domains%& in the default
14107 configuration). This &"magic string"& matches the domain literal form of all
14108 the local host's IP addresses.
14109
14110
14111 .option allow_mx_to_ip main boolean false
14112 .cindex "MX record" "pointing to IP address"
14113 It appears that more and more DNS zone administrators are breaking the rules
14114 and putting domain names that look like IP addresses on the right hand side of
14115 MX records. Exim follows the rules and rejects this, giving an error message
14116 that explains the misconfiguration. However, some other MTAs support this
14117 practice, so to avoid &"Why can't Exim do this?"& complaints,
14118 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14119 recommended, except when you have no other choice.
14120
14121 .option allow_utf8_domains main boolean false
14122 .cindex "domain" "UTF-8 characters in"
14123 .cindex "UTF-8" "in domain name"
14124 Lots of discussion is going on about internationalized domain names. One
14125 camp is strongly in favour of just using UTF-8 characters, and it seems
14126 that at least two other MTAs permit this. This option allows Exim users to
14127 experiment if they wish.
14128
14129 If it is set true, Exim's domain parsing function allows valid
14130 UTF-8 multicharacters to appear in domain name components, in addition to
14131 letters, digits, and hyphens. However, just setting this option is not
14132 enough; if you want to look up these domain names in the DNS, you must also
14133 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14134 suitable setting is:
14135 .code
14136 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14137   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14138 .endd
14139 Alternatively, you can just disable this feature by setting
14140 .code
14141 dns_check_names_pattern =
14142 .endd
14143 That is, set the option to an empty string so that no check is done.
14144
14145
14146 .option auth_advertise_hosts main "host list&!!" *
14147 .cindex "authentication" "advertising"
14148 .cindex "AUTH" "advertising"
14149 If any server authentication mechanisms are configured, Exim advertises them in
14150 response to an EHLO command only if the calling host matches this list.
14151 Otherwise, Exim does not advertise AUTH.
14152 Exim does not accept AUTH commands from clients to which it has not
14153 advertised the availability of AUTH. The advertising of individual
14154 authentication mechanisms can be controlled by the use of the
14155 &%server_advertise_condition%& generic authenticator option on the individual
14156 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14157
14158 Certain mail clients (for example, Netscape) require the user to provide a name
14159 and password for authentication if AUTH is advertised, even though it may
14160 not be needed (the host may accept messages from hosts on its local LAN without
14161 authentication, for example). The &%auth_advertise_hosts%& option can be used
14162 to make these clients more friendly by excluding them from the set of hosts to
14163 which Exim advertises AUTH.
14164
14165 .cindex "AUTH" "advertising when encrypted"
14166 If you want to advertise the availability of AUTH only when the connection
14167 is encrypted using TLS, you can make use of the fact that the value of this
14168 option is expanded, with a setting like this:
14169 .code
14170 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14171 .endd
14172 .vindex "&$tls_in_cipher$&"
14173 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14174 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14175 expansion is *, which matches all hosts.
14176
14177
14178 .option auto_thaw main time 0s
14179 .cindex "thawing messages"
14180 .cindex "unfreezing messages"
14181 If this option is set to a time greater than zero, a queue runner will try a
14182 new delivery attempt on any frozen message, other than a bounce message, if
14183 this much time has passed since it was frozen. This may result in the message
14184 being re-frozen if nothing has changed since the last attempt. It is a way of
14185 saying &"keep on trying, even though there are big problems"&.
14186
14187 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14188 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14189 thought to be very useful any more, and its use should probably be avoided.
14190
14191
14192 .option av_scanner main string "see below"
14193 This option is available if Exim is built with the content-scanning extension.
14194 It specifies which anti-virus scanner to use. The default value is:
14195 .code
14196 sophie:/var/run/sophie
14197 .endd
14198 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14199 before use. See section &<<SECTscanvirus>>& for further details.
14200
14201
14202 .option bi_command main string unset
14203 .oindex "&%-bi%&"
14204 This option supplies the name of a command that is run when Exim is called with
14205 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14206 just the command name, it is not a complete command line. If an argument is
14207 required, it must come from the &%-oA%& command line option.
14208
14209
14210 .option bounce_message_file main string unset
14211 .cindex "bounce message" "customizing"
14212 .cindex "customizing" "bounce message"
14213 This option defines a template file containing paragraphs of text to be used
14214 for constructing bounce messages.  Details of the file's contents are given in
14215 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14216
14217
14218 .option bounce_message_text main string unset
14219 When this option is set, its contents are included in the default bounce
14220 message immediately after &"This message was created automatically by mail
14221 delivery software."& It is not used if &%bounce_message_file%& is set.
14222
14223 .option bounce_return_body main boolean true
14224 .cindex "bounce message" "including body"
14225 This option controls whether the body of an incoming message is included in a
14226 bounce message when &%bounce_return_message%& is true. The default setting
14227 causes the entire message, both header and body, to be returned (subject to the
14228 value of &%bounce_return_size_limit%&). If this option is false, only the
14229 message header is included. In the case of a non-SMTP message containing an
14230 error that is detected during reception, only those header lines preceding the
14231 point at which the error was detected are returned.
14232 .cindex "bounce message" "including original"
14233
14234 .option bounce_return_linesize_limit main integer 998
14235 .cindex "size" "of bounce lines, limit"
14236 .cindex "bounce message" "line length limit"
14237 .cindex "limit" "bounce message line length"
14238 This option sets a limit in bytes on the line length of messages
14239 that are returned to senders due to delivery problems,
14240 when &%bounce_return_message%& is true.
14241 The default value corresponds to RFC limits.
14242 If the message being returned has lines longer than this value it is
14243 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14244
14245 The option also applies to bounces returned when an error is detected
14246 during reception of a message.
14247 In this case lines from the original are truncated.
14248
14249 The option does not apply to messages generated by an &(autoreply)& transport.
14250
14251
14252 .option bounce_return_message main boolean true
14253 If this option is set false, none of the original message is included in
14254 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14255 &%bounce_return_body%&.
14256
14257
14258 .option bounce_return_size_limit main integer 100K
14259 .cindex "size" "of bounce, limit"
14260 .cindex "bounce message" "size limit"
14261 .cindex "limit" "bounce message size"
14262 This option sets a limit in bytes on the size of messages that are returned to
14263 senders as part of bounce messages when &%bounce_return_message%& is true. The
14264 limit should be less than the value of the global &%message_size_limit%& and of
14265 any &%message_size_limit%& settings on transports, to allow for the bounce text
14266 that Exim generates. If this option is set to zero there is no limit.
14267
14268 When the body of any message that is to be included in a bounce message is
14269 greater than the limit, it is truncated, and a comment pointing this out is
14270 added at the top. The actual cutoff may be greater than the value given, owing
14271 to the use of buffering for transferring the message in chunks (typically 8K in
14272 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14273 messages.
14274
14275 .option bounce_sender_authentication main string unset
14276 .cindex "bounce message" "sender authentication"
14277 .cindex "authentication" "bounce message"
14278 .cindex "AUTH" "on bounce message"
14279 This option provides an authenticated sender address that is sent with any
14280 bounce messages generated by Exim that are sent over an authenticated SMTP
14281 connection. A typical setting might be:
14282 .code
14283 bounce_sender_authentication = mailer-daemon@my.domain.example
14284 .endd
14285 which would cause bounce messages to be sent using the SMTP command:
14286 .code
14287 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14288 .endd
14289 The value of &%bounce_sender_authentication%& must always be a complete email
14290 address.
14291
14292 .option callout_domain_negative_expire main time 3h
14293 .cindex "caching" "callout timeouts"
14294 .cindex "callout" "caching timeouts"
14295 This option specifies the expiry time for negative callout cache data for a
14296 domain. See section &<<SECTcallver>>& for details of callout verification, and
14297 section &<<SECTcallvercache>>& for details of the caching.
14298
14299
14300 .option callout_domain_positive_expire main time 7d
14301 This option specifies the expiry time for positive callout cache data for a
14302 domain. See section &<<SECTcallver>>& for details of callout verification, and
14303 section &<<SECTcallvercache>>& for details of the caching.
14304
14305
14306 .option callout_negative_expire main time 2h
14307 This option specifies the expiry time for negative callout cache data for an
14308 address. See section &<<SECTcallver>>& for details of callout verification, and
14309 section &<<SECTcallvercache>>& for details of the caching.
14310
14311
14312 .option callout_positive_expire main time 24h
14313 This option specifies the expiry time for positive callout cache data for an
14314 address. See section &<<SECTcallver>>& for details of callout verification, and
14315 section &<<SECTcallvercache>>& for details of the caching.
14316
14317
14318 .option callout_random_local_part main string&!! "see below"
14319 This option defines the &"random"& local part that can be used as part of
14320 callout verification. The default value is
14321 .code
14322 $primary_hostname-$tod_epoch-testing
14323 .endd
14324 See section &<<CALLaddparcall>>& for details of how this value is used.
14325
14326
14327 .new
14328 .option check_log_inodes main integer 100
14329 .wen
14330 See &%check_spool_space%& below.
14331
14332
14333 .new
14334 .option check_log_space main integer 10M
14335 .wen
14336 See &%check_spool_space%& below.
14337
14338 .oindex "&%check_rfc2047_length%&"
14339 .cindex "RFC 2047" "disabling length check"
14340 .option check_rfc2047_length main boolean true
14341 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14342 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14343 word; strings to be encoded that exceed this length are supposed to use
14344 multiple encoded words. By default, Exim does not recognize encoded words that
14345 exceed the maximum length. However, it seems that some software, in violation
14346 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14347 set false, Exim recognizes encoded words of any length.
14348
14349
14350 .new
14351 .option check_spool_inodes main integer 100
14352 .wen
14353 See &%check_spool_space%& below.
14354
14355
14356 .new
14357 .option check_spool_space main integer 10M
14358 .wen
14359 .cindex "checking disk space"
14360 .cindex "disk space, checking"
14361 .cindex "spool directory" "checking space"
14362 The four &%check_...%& options allow for checking of disk resources before a
14363 message is accepted.
14364
14365 .vindex "&$log_inodes$&"
14366 .vindex "&$log_space$&"
14367 .vindex "&$spool_inodes$&"
14368 .vindex "&$spool_space$&"
14369 When any of these options are nonzero, they apply to all incoming messages. If you
14370 want to apply different checks to different kinds of message, you can do so by
14371 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14372 &$spool_space$& in an ACL with appropriate additional conditions.
14373
14374
14375 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14376 either value is greater than zero, for example:
14377 .code
14378 check_spool_space = 100M
14379 check_spool_inodes = 100
14380 .endd
14381 The spool partition is the one that contains the directory defined by
14382 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14383 transit.
14384
14385 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14386 files are written if either is greater than zero. These should be set only if
14387 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14388
14389 If there is less space or fewer inodes than requested, Exim refuses to accept
14390 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14391 error response to the MAIL command. If ESMTP is in use and there was a
14392 SIZE parameter on the MAIL command, its value is added to the
14393 &%check_spool_space%& value, and the check is performed even if
14394 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14395
14396 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14397 number of kilobytes (though specified in bytes).
14398 If a non-multiple of 1024 is specified, it is rounded up.
14399
14400 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14401 failure a message is written to stderr and Exim exits with a non-zero code, as
14402 it obviously cannot send an error message of any kind.
14403
14404 .new
14405 There is a slight performance penalty for these checks.
14406 Versions of Exim preceding 4.88 had these disabled by default;
14407 high-rate intallations confident they will never run out of resources
14408 may wish to deliberately disable them.
14409 .wen
14410
14411 .new
14412 .option chunking_advertise_hosts main "host list&!!" *
14413 .cindex CHUNKING advertisement
14414 .cindex "RFC 3030" "CHUNKING"
14415 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14416 these hosts.
14417 Hosts may use the BDAT command as an alternate to DATA.
14418 .wen
14419
14420 .option daemon_smtp_ports main string &`smtp`&
14421 .cindex "port" "for daemon"
14422 .cindex "TCP/IP" "setting listening ports"
14423 This option specifies one or more default SMTP ports on which the Exim daemon
14424 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14425 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14426
14427 .option daemon_startup_retries main integer 9
14428 .cindex "daemon startup, retrying"
14429 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14430 the daemon at startup when it cannot immediately bind a listening socket
14431 (typically because the socket is already in use): &%daemon_startup_retries%&
14432 defines the number of retries after the first failure, and
14433 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14434
14435 .option daemon_startup_sleep main time 30s
14436 See &%daemon_startup_retries%&.
14437
14438 .option delay_warning main "time list" 24h
14439 .cindex "warning of delay"
14440 .cindex "delay warning, specifying"
14441 .cindex "queue" "delay warning"
14442 When a message is delayed, Exim sends a warning message to the sender at
14443 intervals specified by this option. The data is a colon-separated list of times
14444 after which to send warning messages. If the value of the option is an empty
14445 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14446 message has been on the queue for longer than the last time, the last interval
14447 between the times is used to compute subsequent warning times. For example,
14448 with
14449 .code
14450 delay_warning = 4h:8h:24h
14451 .endd
14452 the first message is sent after 4 hours, the second after 8 hours, and
14453 the third one after 24 hours. After that, messages are sent every 16 hours,
14454 because that is the interval between the last two times on the list. If you set
14455 just one time, it specifies the repeat interval. For example, with:
14456 .code
14457 delay_warning = 6h
14458 .endd
14459 messages are repeated every six hours. To stop warnings after a given time, set
14460 a very large time at the end of the list. For example:
14461 .code
14462 delay_warning = 2h:12h:99d
14463 .endd
14464 Note that the option is only evaluated at the time a delivery attempt fails,
14465 which depends on retry and queue-runner configuration.
14466 Typically retries will be configured more frequently than warning messages.
14467
14468 .option delay_warning_condition main string&!! "see below"
14469 .vindex "&$domain$&"
14470 The string is expanded at the time a warning message might be sent. If all the
14471 deferred addresses have the same domain, it is set in &$domain$& during the
14472 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14473 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14474 &"false"& (the comparison being done caselessly) then the warning message is
14475 not sent. The default is:
14476 .code
14477 delay_warning_condition = ${if or {\
14478   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14479   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14480   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14481   } {no}{yes}}
14482 .endd
14483 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14484 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14485 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14486 &"auto-replied"& in an &'Auto-Submitted:'& header.
14487
14488 .option deliver_drop_privilege main boolean false
14489 .cindex "unprivileged delivery"
14490 .cindex "delivery" "unprivileged"
14491 If this option is set true, Exim drops its root privilege at the start of a
14492 delivery process, and runs as the Exim user throughout. This severely restricts
14493 the kinds of local delivery that are possible, but is viable in certain types
14494 of configuration. There is a discussion about the use of root privilege in
14495 chapter &<<CHAPsecurity>>&.
14496
14497 .option deliver_queue_load_max main fixed-point unset
14498 .cindex "load average"
14499 .cindex "queue runner" "abandoning"
14500 When this option is set, a queue run is abandoned if the system load average
14501 becomes greater than the value of the option. The option has no effect on
14502 ancient operating systems on which Exim cannot determine the load average.
14503 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14504
14505
14506 .option delivery_date_remove main boolean true
14507 .cindex "&'Delivery-date:'& header line"
14508 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14509 message when it is delivered, in exactly the same way as &'Return-path:'& is
14510 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14511 should not be present in incoming messages, and this option causes them to be
14512 removed at the time the message is received, to avoid any problems that might
14513 occur when a delivered message is subsequently sent on to some other recipient.
14514
14515 .option disable_fsync main boolean false
14516 .cindex "&[fsync()]&, disabling"
14517 This option is available only if Exim was built with the compile-time option
14518 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14519 a runtime configuration generates an &"unknown option"& error. You should not
14520 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14521 really, really, really understand what you are doing. &'No pre-compiled
14522 distributions of Exim should ever make this option available.'&
14523
14524 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14525 updated files' data to be written to disc before continuing. Unexpected events
14526 such as crashes and power outages may cause data to be lost or scrambled.
14527 Here be Dragons. &*Beware.*&
14528
14529
14530 .option disable_ipv6 main boolean false
14531 .cindex "IPv6" "disabling"
14532 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14533 activities take place. AAAA records are never looked up, and any IPv6 addresses
14534 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14535 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14536 to handle IPv6 literal addresses.
14537
14538
14539 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14540 .cindex DKIM "controlling calls to the ACL"
14541 This option gives a list of DKIM domains for which the DKIM ACL is run.
14542 It is expanded after the message is received; by default it runs
14543 the ACL once for each signature in the message.
14544 See chapter &<<CHAPdkim>>&.
14545
14546
14547 .option dns_again_means_nonexist main "domain list&!!" unset
14548 .cindex "DNS" "&""try again""& response; overriding"
14549 DNS lookups give a &"try again"& response for the DNS errors
14550 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14551 keep trying to deliver a message, or to give repeated temporary errors to
14552 incoming mail. Sometimes the effect is caused by a badly set up name server and
14553 may persist for a long time. If a domain which exhibits this problem matches
14554 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14555 This option should be used with care. You can make it apply to reverse lookups
14556 by a setting such as this:
14557 .code
14558 dns_again_means_nonexist = *.in-addr.arpa
14559 .endd
14560 This option applies to all DNS lookups that Exim does. It also applies when the
14561 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14562 since these are most likely to be caused by DNS lookup problems. The
14563 &(dnslookup)& router has some options of its own for controlling what happens
14564 when lookups for MX or SRV records give temporary errors. These more specific
14565 options are applied after this global option.
14566
14567 .option dns_check_names_pattern main string "see below"
14568 .cindex "DNS" "pre-check of name syntax"
14569 When this option is set to a non-empty string, it causes Exim to check domain
14570 names for characters that are not allowed in host names before handing them to
14571 the DNS resolver, because some resolvers give temporary errors for names that
14572 contain unusual characters. If a domain name contains any unwanted characters,
14573 a &"not found"& result is forced, and the resolver is not called. The check is
14574 done by matching the domain name against a regular expression, which is the
14575 value of this option. The default pattern is
14576 .code
14577 dns_check_names_pattern = \
14578   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14579 .endd
14580 which permits only letters, digits, slashes, and hyphens in components, but
14581 they must start and end with a letter or digit. Slashes are not, in fact,
14582 permitted in host names, but they are found in certain NS records (which can be
14583 accessed in Exim by using a &%dnsdb%& lookup). If you set
14584 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14585 empty string.
14586
14587 .option dns_csa_search_limit main integer 5
14588 This option controls the depth of parental searching for CSA SRV records in the
14589 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14590
14591 .option dns_csa_use_reverse main boolean true
14592 This option controls whether or not an IP address, given as a CSA domain, is
14593 reversed and looked up in the reverse DNS, as described in more detail in
14594 section &<<SECTverifyCSA>>&.
14595
14596
14597 .option dns_dnssec_ok main integer -1
14598 .cindex "DNS" "resolver options"
14599 .cindex "DNS" "DNSSEC"
14600 If this option is set to a non-negative number then Exim will initialise the
14601 DNS resolver library to either use or not use DNSSEC, overriding the system
14602 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14603
14604 If the resolver library does not support DNSSEC then this option has no effect.
14605
14606
14607 .option dns_ipv4_lookup main "domain list&!!" unset
14608 .cindex "IPv6" "DNS lookup for AAAA records"
14609 .cindex "DNS" "IPv6 lookup for AAAA records"
14610 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14611 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14612 (A records) when trying to find IP addresses for hosts, unless the host's
14613 domain matches this list.
14614
14615 This is a fudge to help with name servers that give big delays or otherwise do
14616 not work for the AAAA record type. In due course, when the world's name
14617 servers have all been upgraded, there should be no need for this option.
14618
14619
14620 .option dns_retrans main time 0s
14621 .cindex "DNS" "resolver options"
14622 .cindex timeout "dns lookup"
14623 .cindex "DNS" timeout
14624 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14625 retransmission and retry parameters for DNS lookups. Values of zero (the
14626 defaults) leave the system default settings unchanged. The first value is the
14627 time between retries, and the second is the number of retries. It isn't
14628 totally clear exactly how these settings affect the total time a DNS lookup may
14629 take. I haven't found any documentation about timeouts on DNS lookups; these
14630 parameter values are available in the external resolver interface structure,
14631 but nowhere does it seem to describe how they are used or what you might want
14632 to set in them.
14633 See also the &%slow_lookup_log%& option.
14634
14635
14636 .option dns_retry main integer 0
14637 See &%dns_retrans%& above.
14638
14639
14640 .option dns_trust_aa main "domain list&!!" unset
14641 .cindex "DNS" "resolver options"
14642 .cindex "DNS" "DNSSEC"
14643 If this option is set then lookup results marked with the AA bit
14644 (Authoritative Answer) are trusted the same way as if they were
14645 DNSSEC-verified. The authority section's name of the answer must
14646 match with this expanded domain list.
14647
14648 Use this option only if you talk directly to a resolver that is
14649 authoritative for some zones and does not set the AD (Authentic Data)
14650 bit in the answer. Some DNS servers may have an configuration option to
14651 mark the answers from their own zones as verified (they set the AD bit).
14652 Others do not have this option. It is considered as poor practice using
14653 a resolver that is an authoritative server for some zones.
14654
14655 Use this option only if you really have to (e.g. if you want
14656 to use DANE for remote delivery to a server that is listed in the DNS
14657 zones that your resolver is authoritative for).
14658
14659 If the DNS answer packet has the AA bit set and contains resource record
14660 in the answer section, the name of the first NS record appearing in the
14661 authority section is compared against the list. If the answer packet is
14662 authoritative but the answer section is empty, the name of the first SOA
14663 record in the authoritative section is used instead.
14664
14665 .cindex "DNS" "resolver options"
14666 .option dns_use_edns0 main integer -1
14667 .cindex "DNS" "resolver options"
14668 .cindex "DNS" "EDNS0"
14669 If this option is set to a non-negative number then Exim will initialise the
14670 DNS resolver library to either use or not use EDNS0 extensions, overriding
14671 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14672 on.
14673
14674 If the resolver library does not support EDNS0 then this option has no effect.
14675
14676
14677 .option drop_cr main boolean false
14678 This is an obsolete option that is now a no-op. It used to affect the way Exim
14679 handled CR and LF characters in incoming messages. What happens now is
14680 described in section &<<SECTlineendings>>&.
14681
14682 .option dsn_advertise_hosts main "host list&!!" unset
14683 .cindex "bounce messages" "success"
14684 .cindex "DSN" "success"
14685 .cindex "Delivery Status Notification" "success"
14686 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14687 and accepted from, these hosts.
14688 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14689 and RET and ORCPT options on MAIL FROM commands.
14690 A NOTIFY=SUCCESS option requests success-DSN messages.
14691 A NOTIFY= option with no argument requests that no delay or failure DSNs
14692 are sent.
14693
14694 .option dsn_from main "string&!!" "see below"
14695 .cindex "&'From:'& header line" "in bounces"
14696 .cindex "bounce messages" "&'From:'& line, specifying"
14697 This option can be used to vary the contents of &'From:'& header lines in
14698 bounces and other automatically generated messages (&"Delivery Status
14699 Notifications"& &-- hence the name of the option). The default setting is:
14700 .code
14701 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14702 .endd
14703 The value is expanded every time it is needed. If the expansion fails, a
14704 panic is logged, and the default value is used.
14705
14706 .option envelope_to_remove main boolean true
14707 .cindex "&'Envelope-to:'& header line"
14708 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14709 message when it is delivered, in exactly the same way as &'Return-path:'& is
14710 handled. &'Envelope-to:'& records the original recipient address from the
14711 message's envelope that caused the delivery to happen. Such headers should not
14712 be present in incoming messages, and this option causes them to be removed at
14713 the time the message is received, to avoid any problems that might occur when a
14714 delivered message is subsequently sent on to some other recipient.
14715
14716
14717 .option errors_copy main "string list&!!" unset
14718 .cindex "bounce message" "copy to other address"
14719 .cindex "copy of bounce message"
14720 Setting this option causes Exim to send bcc copies of bounce messages that it
14721 generates to other addresses. &*Note*&: This does not apply to bounce messages
14722 coming from elsewhere. The value of the option is a colon-separated list of
14723 items. Each item consists of a pattern, terminated by white space, followed by
14724 a comma-separated list of email addresses. If a pattern contains spaces, it
14725 must be enclosed in double quotes.
14726
14727 Each pattern is processed in the same way as a single item in an address list
14728 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14729 the bounce message, the message is copied to the addresses on the list. The
14730 items are scanned in order, and once a matching one is found, no further items
14731 are examined. For example:
14732 .code
14733 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14734               rqps@mydomain   hostmaster@mydomain.example,\
14735                               postmaster@mydomain.example
14736 .endd
14737 .vindex "&$domain$&"
14738 .vindex "&$local_part$&"
14739 The address list is expanded before use. The expansion variables &$local_part$&
14740 and &$domain$& are set from the original recipient of the error message, and if
14741 there was any wildcard matching in the pattern, the expansion
14742 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14743 variables &$0$&, &$1$&, etc. are set in the normal way.
14744
14745
14746 .option errors_reply_to main string unset
14747 .cindex "bounce message" "&'Reply-to:'& in"
14748 By default, Exim's bounce and delivery warning messages contain the header line
14749 .display
14750 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14751 .endd
14752 .oindex &%quota_warn_message%&
14753 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14754 A warning message that is generated by the &%quota_warn_message%& option in an
14755 &(appendfile)& transport may contain its own &'From:'& header line that
14756 overrides the default.
14757
14758 Experience shows that people reply to bounce messages. If the
14759 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14760 and warning messages. For example:
14761 .code
14762 errors_reply_to = postmaster@my.domain.example
14763 .endd
14764 The value of the option is not expanded. It must specify a valid RFC 2822
14765 address. However, if a warning message that is generated by the
14766 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14767 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14768 not used.
14769
14770
14771 .option event_action main string&!! unset
14772 .cindex events
14773 This option declares a string to be expanded for Exim's events mechanism.
14774 For details see &<<CHAPevents>>&.
14775
14776
14777 .option exim_group main string "compile-time configured"
14778 .cindex "gid (group id)" "Exim's own"
14779 .cindex "Exim group"
14780 This option changes the gid under which Exim runs when it gives up root
14781 privilege. The default value is compiled into the binary. The value of this
14782 option is used only when &%exim_user%& is also set. Unless it consists entirely
14783 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14784 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14785 security issues.
14786
14787
14788 .option exim_path main string "see below"
14789 .cindex "Exim binary, path name"
14790 This option specifies the path name of the Exim binary, which is used when Exim
14791 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14792 the directory configured at compile time by the BIN_DIRECTORY setting. It
14793 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14794 other place.
14795 &*Warning*&: Do not use a macro to define the value of this option, because
14796 you will break those Exim utilities that scan the configuration file to find
14797 where the binary is. (They then use the &%-bP%& option to extract option
14798 settings such as the value of &%spool_directory%&.)
14799
14800
14801 .option exim_user main string "compile-time configured"
14802 .cindex "uid (user id)" "Exim's own"
14803 .cindex "Exim user"
14804 This option changes the uid under which Exim runs when it gives up root
14805 privilege. The default value is compiled into the binary. Ownership of the run
14806 time configuration file and the use of the &%-C%& and &%-D%& command line
14807 options is checked against the values in the binary, not what is set here.
14808
14809 Unless it consists entirely of digits, the string is looked up using
14810 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14811 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14812 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14813
14814
14815 .option extra_local_interfaces main "string list" unset
14816 This option defines network interfaces that are to be considered local when
14817 routing, but which are not used for listening by the daemon. See section
14818 &<<SECTreclocipadd>>& for details.
14819
14820
14821 . Allow this long option name to split; give it unsplit as a fifth argument
14822 . for the automatic .oindex that is generated by .option.
14823
14824 .option "extract_addresses_remove_arguments" main boolean true &&&
14825          extract_addresses_remove_arguments
14826 .oindex "&%-t%&"
14827 .cindex "command line" "addresses with &%-t%&"
14828 .cindex "Sendmail compatibility" "&%-t%& option"
14829 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14830 are present on the command line when the &%-t%& option is used to build an
14831 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14832 line addresses are removed from the recipients list. This is also how Smail
14833 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14834 command line addresses are added to those obtained from the header lines. When
14835 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14836 argument headers. If it is set false, Exim adds rather than removes argument
14837 addresses.
14838
14839
14840 .option finduser_retries main integer 0
14841 .cindex "NIS, retrying user lookups"
14842 On systems running NIS or other schemes in which user and group information is
14843 distributed from a remote system, there can be times when &[getpwnam()]& and
14844 related functions fail, even when given valid data, because things time out.
14845 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14846 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14847 many extra times to find a user or a group, waiting for one second between
14848 retries.
14849
14850 .cindex "&_/etc/passwd_&" "multiple reading of"
14851 You should not set this option greater than zero if your user information is in
14852 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14853 search the file multiple times for non-existent users, and also cause delay.
14854
14855
14856
14857 .option freeze_tell main "string list, comma separated" unset
14858 .cindex "freezing messages" "sending a message when freezing"
14859 On encountering certain errors, or when configured to do so in a system filter,
14860 ACL, or special router, Exim freezes a message. This means that no further
14861 delivery attempts take place until an administrator thaws the message, or the
14862 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14863 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14864 warning message whenever it freezes something, unless the message it is
14865 freezing is a locally-generated bounce message. (Without this exception there
14866 is the possibility of looping.) The warning message is sent to the addresses
14867 supplied as the comma-separated value of this option. If several of the
14868 message's addresses cause freezing, only a single message is sent. If the
14869 freezing was automatic, the reason(s) for freezing can be found in the message
14870 log. If you configure freezing in a filter or ACL, you must arrange for any
14871 logging that you require.
14872
14873
14874 .option gecos_name main string&!! unset
14875 .cindex "HP-UX"
14876 .cindex "&""gecos""& field, parsing"
14877 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14878 password file to hold other information in addition to users' real names. Exim
14879 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14880 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14881 of the field are used unchanged, except that, if an ampersand is encountered,
14882 it is replaced by the user's login name with the first character forced to
14883 upper case, since this is a convention that is observed on many systems.
14884
14885 When these options are set, &%gecos_pattern%& is treated as a regular
14886 expression that is to be applied to the field (again with && replaced by the
14887 login name), and if it matches, &%gecos_name%& is expanded and used as the
14888 user's name.
14889
14890 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14891 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14892 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14893 name terminates at the first comma, the following can be used:
14894 .code
14895 gecos_pattern = ([^,]*)
14896 gecos_name = $1
14897 .endd
14898
14899 .option gecos_pattern main string unset
14900 See &%gecos_name%& above.
14901
14902
14903 .option gnutls_compat_mode main boolean unset
14904 This option controls whether GnuTLS is used in compatibility mode in an Exim
14905 server. This reduces security slightly, but improves interworking with older
14906 implementations of TLS.
14907
14908
14909 option gnutls_allow_auto_pkcs11 main boolean unset
14910 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14911 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14912
14913 See
14914 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14915 for documentation.
14916
14917
14918
14919 .option headers_charset main string "see below"
14920 This option sets a default character set for translating from encoded MIME
14921 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14922 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14923 ultimate default is ISO-8859-1. For more details see the description of header
14924 insertions in section &<<SECTexpansionitems>>&.
14925
14926
14927
14928 .option header_maxsize main integer "see below"
14929 .cindex "header section" "maximum size of"
14930 .cindex "limit" "size of message header section"
14931 This option controls the overall maximum size of a message's header
14932 section. The default is the value of HEADER_MAXSIZE in
14933 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14934 sections are rejected.
14935
14936
14937 .option header_line_maxsize main integer 0
14938 .cindex "header lines" "maximum size of"
14939 .cindex "limit" "size of one header line"
14940 This option limits the length of any individual header line in a message, after
14941 all the continuations have been joined together. Messages with individual
14942 header lines that are longer than the limit are rejected. The default value of
14943 zero means &"no limit"&.
14944
14945
14946
14947
14948 .option helo_accept_junk_hosts main "host list&!!" unset
14949 .cindex "HELO" "accepting junk data"
14950 .cindex "EHLO" "accepting junk data"
14951 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14952 mail, and gives an error response for invalid data. Unfortunately, there are
14953 some SMTP clients that send syntactic junk. They can be accommodated by setting
14954 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14955 if you want to do semantic checking.
14956 See also &%helo_allow_chars%& for a way of extending the permitted character
14957 set.
14958
14959
14960 .option helo_allow_chars main string unset
14961 .cindex "HELO" "underscores in"
14962 .cindex "EHLO" "underscores in"
14963 .cindex "underscore in EHLO/HELO"
14964 This option can be set to a string of rogue characters that are permitted in
14965 all EHLO and HELO names in addition to the standard letters, digits,
14966 hyphens, and dots. If you really must allow underscores, you can set
14967 .code
14968 helo_allow_chars = _
14969 .endd
14970 Note that the value is one string, not a list.
14971
14972
14973 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14974 .cindex "HELO" "forcing reverse lookup"
14975 .cindex "EHLO" "forcing reverse lookup"
14976 If the domain given by a client in a HELO or EHLO command matches this
14977 list, a reverse lookup is done in order to establish the host's true name. The
14978 default forces a lookup if the client host gives the server's name or any of
14979 its IP addresses (in brackets), something that broken clients have been seen to
14980 do.
14981
14982
14983 .option helo_try_verify_hosts main "host list&!!" unset
14984 .cindex "HELO verifying" "optional"
14985 .cindex "EHLO" "verifying, optional"
14986 By default, Exim just checks the syntax of HELO and EHLO commands (see
14987 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14988 to do more extensive checking of the data supplied by these commands. The ACL
14989 condition &`verify = helo`& is provided to make this possible.
14990 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14991 to force the check to occur. From release 4.53 onwards, this is no longer
14992 necessary. If the check has not been done before &`verify = helo`& is
14993 encountered, it is done at that time. Consequently, this option is obsolete.
14994 Its specification is retained here for backwards compatibility.
14995
14996 When an EHLO or HELO command is received, if the calling host matches
14997 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14998 EHLO command either:
14999
15000 .ilist
15001 is an IP literal matching the calling address of the host, or
15002 .next
15003 .cindex "DNS" "reverse lookup"
15004 .cindex "reverse DNS lookup"
15005 matches the host name that Exim obtains by doing a reverse lookup of the
15006 calling host address, or
15007 .next
15008 when looked up in DNS yields the calling host address.
15009 .endlist
15010
15011 However, the EHLO or HELO command is not rejected if any of the checks
15012 fail. Processing continues, but the result of the check is remembered, and can
15013 be detected later in an ACL by the &`verify = helo`& condition.
15014
15015 If DNS was used for successful verification, the variable
15016 .cindex "DNS" "DNSSEC"
15017 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15018
15019 .option helo_verify_hosts main "host list&!!" unset
15020 .cindex "HELO verifying" "mandatory"
15021 .cindex "EHLO" "verifying, mandatory"
15022 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15023 backwards compatibility. For hosts that match this option, Exim checks the host
15024 name given in the HELO or EHLO in the same way as for
15025 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15026 rejected with a 550 error, and entries are written to the main and reject logs.
15027 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15028 error.
15029
15030 .option hold_domains main "domain list&!!" unset
15031 .cindex "domain" "delaying delivery"
15032 .cindex "delivery" "delaying certain domains"
15033 This option allows mail for particular domains to be held on the queue
15034 manually. The option is overridden if a message delivery is forced with the
15035 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15036 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15037 item in &%hold_domains%&, no routing or delivery for that address is done, and
15038 it is deferred every time the message is looked at.
15039
15040 This option is intended as a temporary operational measure for delaying the
15041 delivery of mail while some problem is being sorted out, or some new
15042 configuration tested. If you just want to delay the processing of some
15043 domains until a queue run occurs, you should use &%queue_domains%& or
15044 &%queue_smtp_domains%&, not &%hold_domains%&.
15045
15046 A setting of &%hold_domains%& does not override Exim's code for removing
15047 messages from the queue if they have been there longer than the longest retry
15048 time in any retry rule. If you want to hold messages for longer than the normal
15049 retry times, insert a dummy retry rule with a long retry time.
15050
15051
15052 .option host_lookup main "host list&!!" unset
15053 .cindex "host name" "lookup, forcing"
15054 Exim does not look up the name of a calling host from its IP address unless it
15055 is required to compare against some host list, or the host matches
15056 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15057 option (which normally contains IP addresses rather than host names). The
15058 default configuration file contains
15059 .code
15060 host_lookup = *
15061 .endd
15062 which causes a lookup to happen for all hosts. If the expense of these lookups
15063 is felt to be too great, the setting can be changed or removed.
15064
15065 After a successful reverse lookup, Exim does a forward lookup on the name it
15066 has obtained, to verify that it yields the IP address that it started with. If
15067 this check fails, Exim behaves as if the name lookup failed.
15068
15069 .vindex "&$host_lookup_failed$&"
15070 .vindex "&$sender_host_name$&"
15071 After any kind of failure, the host name (in &$sender_host_name$&) remains
15072 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15073 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15074 &`verify = reverse_host_lookup`& in ACLs.
15075
15076
15077 .option host_lookup_order main "string list" &`bydns:byaddr`&
15078 This option specifies the order of different lookup methods when Exim is trying
15079 to find a host name from an IP address. The default is to do a DNS lookup
15080 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15081 if that fails. You can change the order of these lookups, or omit one entirely,
15082 if you want.
15083
15084 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15085 multiple PTR records in the DNS and the IP address is not listed in
15086 &_/etc/hosts_&. Different operating systems give different results in this
15087 case. That is why the default tries a DNS lookup first.
15088
15089
15090
15091 .option host_reject_connection main "host list&!!" unset
15092 .cindex "host" "rejecting connections from"
15093 If this option is set, incoming SMTP calls from the hosts listed are rejected
15094 as soon as the connection is made.
15095 This option is obsolete, and retained only for backward compatibility, because
15096 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15097 connections immediately.
15098
15099 The ability to give an immediate rejection (either by this option or using an
15100 ACL) is provided for use in unusual cases. Many hosts will just try again,
15101 sometimes without much delay. Normally, it is better to use an ACL to reject
15102 incoming messages at a later stage, such as after RCPT commands. See
15103 chapter &<<CHAPACL>>&.
15104
15105
15106 .option hosts_connection_nolog main "host list&!!" unset
15107 .cindex "host" "not logging connections from"
15108 This option defines a list of hosts for which connection logging does not
15109 happen, even though the &%smtp_connection%& log selector is set. For example,
15110 you might want not to log SMTP connections from local processes, or from
15111 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15112 the daemon; you should therefore strive to restrict its value to a short inline
15113 list of IP addresses and networks. To disable logging SMTP connections from
15114 local processes, you must create a host list with an empty item. For example:
15115 .code
15116 hosts_connection_nolog = :
15117 .endd
15118 If the &%smtp_connection%& log selector is not set, this option has no effect.
15119
15120
15121
15122 .option hosts_proxy main "host list&!!" unset
15123 .cindex proxy "proxy protocol"
15124 This option enables use of Proxy Protocol proxies for incoming
15125 connections.  For details see &<<SECTproxyInbound>>&.
15126
15127
15128 .option hosts_treat_as_local main "domain list&!!" unset
15129 .cindex "local host" "domains treated as"
15130 .cindex "host" "treated as local"
15131 If this option is set, any host names that match the domain list are treated as
15132 if they were the local host when Exim is scanning host lists obtained from MX
15133 records
15134 or other sources. Note that the value of this option is a domain list, not a
15135 host list, because it is always used to check host names, not IP addresses.
15136
15137 This option also applies when Exim is matching the special items
15138 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15139 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15140 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15141 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15142 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15143 interfaces and recognizing the local host.
15144
15145
15146 .option ibase_servers main "string list" unset
15147 .cindex "InterBase" "server list"
15148 This option provides a list of InterBase servers and associated connection data,
15149 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15150 The option is available only if Exim has been built with InterBase support.
15151
15152
15153
15154 .option ignore_bounce_errors_after main time 10w
15155 .cindex "bounce message" "discarding"
15156 .cindex "discarding bounce message"
15157 This option affects the processing of bounce messages that cannot be delivered,
15158 that is, those that suffer a permanent delivery failure. (Bounce messages that
15159 suffer temporary delivery failures are of course retried in the usual way.)
15160
15161 After a permanent delivery failure, bounce messages are frozen,
15162 because there is no sender to whom they can be returned. When a frozen bounce
15163 message has been on the queue for more than the given time, it is unfrozen at
15164 the next queue run, and a further delivery is attempted. If delivery fails
15165 again, the bounce message is discarded. This makes it possible to keep failed
15166 bounce messages around for a shorter time than the normal maximum retry time
15167 for frozen messages. For example,
15168 .code
15169 ignore_bounce_errors_after = 12h
15170 .endd
15171 retries failed bounce message deliveries after 12 hours, discarding any further
15172 failures. If the value of this option is set to a zero time period, bounce
15173 failures are discarded immediately. Setting a very long time (as in the default
15174 value) has the effect of disabling this option. For ways of automatically
15175 dealing with other kinds of frozen message, see &%auto_thaw%& and
15176 &%timeout_frozen_after%&.
15177
15178
15179 .option ignore_fromline_hosts main "host list&!!" unset
15180 .cindex "&""From""& line"
15181 .cindex "UUCP" "&""From""& line"
15182 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15183 the headers of a message. By default this is treated as the start of the
15184 message's body, which means that any following headers are not recognized as
15185 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15186 match those hosts that insist on sending it. If the sender is actually a local
15187 process rather than a remote host, and is using &%-bs%& to inject the messages,
15188 &%ignore_fromline_local%& must be set to achieve this effect.
15189
15190
15191 .option ignore_fromline_local main boolean false
15192 See &%ignore_fromline_hosts%& above.
15193
15194 .option keep_environment main "string list" unset
15195 .cindex "environment" "values from"
15196 This option contains a string list of environment variables to keep.
15197 You have to trust these variables or you have to be sure that
15198 these variables do not impose any security risk. Keep in mind that
15199 during the startup phase Exim is running with an effective UID 0 in most
15200 installations. As the default value is an empty list, the default
15201 environment for using libraries, running embedded Perl code, or running
15202 external binaries is empty, and does not not even contain PATH or HOME.
15203
15204 Actually the list is interpreted as a list of patterns
15205 (&<<SECTlistexpand>>&), except that it is not expanded first.
15206
15207 WARNING: Macro substitution is still done first, so having a macro
15208 FOO and having FOO_HOME in your &%keep_environment%& option may have
15209 unexpected results. You may work around this using a regular expression
15210 that does not match the macro name: ^[F]OO_HOME$.
15211
15212 Current versions of Exim issue a warning during startup if you do not mention
15213 &%keep_environment%& in your runtime configuration file and if your
15214 current environment is not empty. Future versions may not issue that warning
15215 anymore.
15216
15217 See the &%add_environment%& main config option for a way to set
15218 environment variables to a fixed value.  The environment for &(pipe)&
15219 transports is handled separately, see section &<<SECTpipeenv>>& for
15220 details.
15221
15222
15223 .option keep_malformed main time 4d
15224 This option specifies the length of time to keep messages whose spool files
15225 have been corrupted in some way. This should, of course, never happen. At the
15226 next attempt to deliver such a message, it gets removed. The incident is
15227 logged.
15228
15229
15230 .option ldap_ca_cert_dir main string unset
15231 .cindex "LDAP", "TLS CA certificate directory"
15232 .cindex certificate "directory for LDAP"
15233 This option indicates which directory contains CA certificates for verifying
15234 a TLS certificate presented by an LDAP server.
15235 While Exim does not provide a default value, your SSL library may.
15236 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15237 and constrained to be a directory.
15238
15239
15240 .option ldap_ca_cert_file main string unset
15241 .cindex "LDAP", "TLS CA certificate file"
15242 .cindex certificate "file for LDAP"
15243 This option indicates which file contains CA certificates for verifying
15244 a TLS certificate presented by an LDAP server.
15245 While Exim does not provide a default value, your SSL library may.
15246 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15247 and constrained to be a file.
15248
15249
15250 .option ldap_cert_file main string unset
15251 .cindex "LDAP" "TLS client certificate file"
15252 .cindex certificate "file for LDAP"
15253 This option indicates which file contains an TLS client certificate which
15254 Exim should present to the LDAP server during TLS negotiation.
15255 Should be used together with &%ldap_cert_key%&.
15256
15257
15258 .option ldap_cert_key main string unset
15259 .cindex "LDAP" "TLS client key file"
15260 .cindex certificate "key for LDAP"
15261 This option indicates which file contains the secret/private key to use
15262 to prove identity to the LDAP server during TLS negotiation.
15263 Should be used together with &%ldap_cert_file%&, which contains the
15264 identity to be proven.
15265
15266
15267 .option ldap_cipher_suite main string unset
15268 .cindex "LDAP" "TLS cipher suite"
15269 This controls the TLS cipher-suite negotiation during TLS negotiation with
15270 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15271 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15272
15273
15274 .option ldap_default_servers main "string list" unset
15275 .cindex "LDAP" "default servers"
15276 This option provides a list of LDAP servers which are tried in turn when an
15277 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15278 details of LDAP queries. This option is available only when Exim has been built
15279 with LDAP support.
15280
15281
15282 .option ldap_require_cert main string unset.
15283 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15284 This should be one of the values "hard", "demand", "allow", "try" or "never".
15285 A value other than one of these is interpreted as "never".
15286 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15287 Although Exim does not set a default, the LDAP library probably defaults
15288 to hard/demand.
15289
15290
15291 .option ldap_start_tls main boolean false
15292 .cindex "LDAP" "whether or not to negotiate TLS"
15293 If set, Exim will attempt to negotiate TLS with the LDAP server when
15294 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15295 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15296 of SSL-on-connect.
15297 In the event of failure to negotiate TLS, the action taken is controlled
15298 by &%ldap_require_cert%&.
15299
15300
15301 .option ldap_version main integer unset
15302 .cindex "LDAP" "protocol version, forcing"
15303 This option can be used to force Exim to set a specific protocol version for
15304 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15305 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15306 the LDAP headers; otherwise it is 2. This option is available only when Exim
15307 has been built with LDAP support.
15308
15309
15310
15311 .option local_from_check main boolean true
15312 .cindex "&'Sender:'& header line" "disabling addition of"
15313 .cindex "&'From:'& header line" "disabling checking of"
15314 When a message is submitted locally (that is, not over a TCP/IP connection) by
15315 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15316 checks that the &'From:'& header line matches the login of the calling user and
15317 the domain specified by &%qualify_domain%&.
15318
15319 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15320 locally submitted message is automatically qualified by Exim, unless the
15321 &%-bnq%& command line option is used.
15322
15323 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15324 on the local part. If the &'From:'& header line does not match, Exim adds a
15325 &'Sender:'& header with an address constructed from the calling user's login
15326 and the default qualify domain.
15327
15328 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15329 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15330 &'Sender:'& header lines supplied by untrusted users, you must also set
15331 &%local_sender_retain%& to be true.
15332
15333 .cindex "envelope sender"
15334 These options affect only the header lines in the message. The envelope sender
15335 is still forced to be the login id at the qualify domain unless
15336 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15337
15338 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15339 request similar header line checking. See section &<<SECTthesenhea>>&, which
15340 has more details about &'Sender:'& processing.
15341
15342
15343
15344
15345 .option local_from_prefix main string unset
15346 When Exim checks the &'From:'& header line of locally submitted messages for
15347 matching the login id (see &%local_from_check%& above), it can be configured to
15348 ignore certain prefixes and suffixes in the local part of the address. This is
15349 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15350 appropriate lists, in the same form as the &%local_part_prefix%& and
15351 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15352 example, if
15353 .code
15354 local_from_prefix = *-
15355 .endd
15356 is set, a &'From:'& line containing
15357 .code
15358 From: anything-user@your.domain.example
15359 .endd
15360 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15361 matches the actual sender address that is constructed from the login name and
15362 qualify domain.
15363
15364
15365 .option local_from_suffix main string unset
15366 See &%local_from_prefix%& above.
15367
15368
15369 .option local_interfaces main "string list" "see below"
15370 This option controls which network interfaces are used by the daemon for
15371 listening; they are also used to identify the local host when routing. Chapter
15372 &<<CHAPinterfaces>>& contains a full description of this option and the related
15373 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15374 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15375 &%local_interfaces%& is
15376 .code
15377 local_interfaces = 0.0.0.0
15378 .endd
15379 when Exim is built without IPv6 support; otherwise it is
15380 .code
15381 local_interfaces = <; ::0 ; 0.0.0.0
15382 .endd
15383
15384 .option local_scan_timeout main time 5m
15385 .cindex "timeout" "for &[local_scan()]& function"
15386 .cindex "&[local_scan()]& function" "timeout"
15387 This timeout applies to the &[local_scan()]& function (see chapter
15388 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15389 the incoming message is rejected with a temporary error if it is an SMTP
15390 message. For a non-SMTP message, the message is dropped and Exim ends with a
15391 non-zero code. The incident is logged on the main and reject logs.
15392
15393
15394
15395 .option local_sender_retain main boolean false
15396 .cindex "&'Sender:'& header line" "retaining from local submission"
15397 When a message is submitted locally (that is, not over a TCP/IP connection) by
15398 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15399 do not want this to happen, you must set &%local_sender_retain%&, and you must
15400 also set &%local_from_check%& to be false (Exim will complain if you do not).
15401 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15402 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15403
15404
15405
15406
15407 .option localhost_number main string&!! unset
15408 .cindex "host" "locally unique number for"
15409 .cindex "message ids" "with multiple hosts"
15410 .vindex "&$localhost_number$&"
15411 Exim's message ids are normally unique only within the local host. If
15412 uniqueness among a set of hosts is required, each host must set a different
15413 value for the &%localhost_number%& option. The string is expanded immediately
15414 after reading the configuration file (so that a number can be computed from the
15415 host name, for example) and the result of the expansion must be a number in the
15416 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15417 systems). This is available in subsequent string expansions via the variable
15418 &$localhost_number$&. When &%localhost_number is set%&, the final two
15419 characters of the message id, instead of just being a fractional part of the
15420 time, are computed from the time and the local host number as described in
15421 section &<<SECTmessiden>>&.
15422
15423
15424
15425 .option log_file_path main "string list&!!" "set at compile time"
15426 .cindex "log" "file path for"
15427 This option sets the path which is used to determine the names of Exim's log
15428 files, or indicates that logging is to be to syslog, or both. It is expanded
15429 when Exim is entered, so it can, for example, contain a reference to the host
15430 name. If no specific path is set for the log files at compile or run time,
15431 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15432 they are written in a sub-directory called &_log_& in Exim's spool directory.
15433 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15434 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15435 used. If this string is fixed at your installation (contains no expansion
15436 variables) it is recommended that you do not set this option in the
15437 configuration file, but instead supply the path using LOG_FILE_PATH in
15438 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15439 early on &-- in particular, failure to read the configuration file.
15440
15441
15442 .option log_selector main string unset
15443 .cindex "log" "selectors"
15444 This option can be used to reduce or increase the number of things that Exim
15445 writes to its log files. Its argument is made up of names preceded by plus or
15446 minus characters. For example:
15447 .code
15448 log_selector = +arguments -retry_defer
15449 .endd
15450 A list of possible names and what they control is given in the chapter on
15451 logging, in section &<<SECTlogselector>>&.
15452
15453
15454 .option log_timezone main boolean false
15455 .cindex "log" "timezone for entries"
15456 .vindex "&$tod_log$&"
15457 .vindex "&$tod_zone$&"
15458 By default, the timestamps on log lines are in local time without the
15459 timezone. This means that if your timezone changes twice a year, the timestamps
15460 in log lines are ambiguous for an hour when the clocks go back. One way of
15461 avoiding this problem is to set the timezone to UTC. An alternative is to set
15462 &%log_timezone%& true. This turns on the addition of the timezone offset to
15463 timestamps in log lines. Turning on this option can add quite a lot to the size
15464 of log files because each line is extended by 6 characters. Note that the
15465 &$tod_log$& variable contains the log timestamp without the zone, but there is
15466 another variable called &$tod_zone$& that contains just the timezone offset.
15467
15468
15469 .option lookup_open_max main integer 25
15470 .cindex "too many open files"
15471 .cindex "open files, too many"
15472 .cindex "file" "too many open"
15473 .cindex "lookup" "maximum open files"
15474 .cindex "limit" "open files for lookups"
15475 This option limits the number of simultaneously open files for single-key
15476 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15477 Exim normally keeps these files open during routing, because often the same
15478 file is required several times. If the limit is reached, Exim closes the least
15479 recently used file. Note that if you are using the &'ndbm'& library, it
15480 actually opens two files for each logical DBM database, though it still counts
15481 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15482 open files"& errors with NDBM, you need to reduce the value of
15483 &%lookup_open_max%&.
15484
15485
15486 .option max_username_length main integer 0
15487 .cindex "length of login name"
15488 .cindex "user name" "maximum length"
15489 .cindex "limit" "user name length"
15490 Some operating systems are broken in that they truncate long arguments to
15491 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15492 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15493 an argument that is longer behaves as if &[getpwnam()]& failed.
15494
15495
15496 .option message_body_newlines main bool false
15497 .cindex "message body" "newlines in variables"
15498 .cindex "newline" "in message body variables"
15499 .vindex "&$message_body$&"
15500 .vindex "&$message_body_end$&"
15501 By default, newlines in the message body are replaced by spaces when setting
15502 the &$message_body$& and &$message_body_end$& expansion variables. If this
15503 option is set true, this no longer happens.
15504
15505
15506 .option message_body_visible main integer 500
15507 .cindex "body of message" "visible size"
15508 .cindex "message body" "visible size"
15509 .vindex "&$message_body$&"
15510 .vindex "&$message_body_end$&"
15511 This option specifies how much of a message's body is to be included in the
15512 &$message_body$& and &$message_body_end$& expansion variables.
15513
15514
15515 .option message_id_header_domain main string&!! unset
15516 .cindex "&'Message-ID:'& header line"
15517 If this option is set, the string is expanded and used as the right hand side
15518 (domain) of the &'Message-ID:'& header that Exim creates if a
15519 locally-originated incoming message does not have one. &"Locally-originated"&
15520 means &"not received over TCP/IP."&
15521 Otherwise, the primary host name is used.
15522 Only letters, digits, dot and hyphen are accepted; any other characters are
15523 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15524 empty string, the option is ignored.
15525
15526
15527 .option message_id_header_text main string&!! unset
15528 If this variable is set, the string is expanded and used to augment the text of
15529 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15530 message does not have one. The text of this header is required by RFC 2822 to
15531 take the form of an address. By default, Exim uses its internal message id as
15532 the local part, and the primary host name as the domain. If this option is set,
15533 it is expanded, and provided the expansion is not forced to fail, and does not
15534 yield an empty string, the result is inserted into the header immediately
15535 before the @, separated from the internal message id by a dot. Any characters
15536 that are illegal in an address are automatically converted into hyphens. This
15537 means that variables such as &$tod_log$& can be used, because the spaces and
15538 colons will become hyphens.
15539
15540
15541 .option message_logs main boolean true
15542 .cindex "message logs" "disabling"
15543 .cindex "log" "message log; disabling"
15544 If this option is turned off, per-message log files are not created in the
15545 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15546 Exim, by reducing the number of files involved in handling a message from a
15547 minimum of four (header spool file, body spool file, delivery journal, and
15548 per-message log) to three. The other major I/O activity is Exim's main log,
15549 which is not affected by this option.
15550
15551
15552 .option message_size_limit main string&!! 50M
15553 .cindex "message" "size limit"
15554 .cindex "limit" "message size"
15555 .cindex "size" "of message, limit"
15556 This option limits the maximum size of message that Exim will process. The
15557 value is expanded for each incoming connection so, for example, it can be made
15558 to depend on the IP address of the remote host for messages arriving via
15559 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15560 optionally followed by K or M.
15561
15562 &*Note*&: This limit cannot be made to depend on a message's sender or any
15563 other properties of an individual message, because it has to be advertised in
15564 the server's response to EHLO. String expansion failure causes a temporary
15565 error. A value of zero means no limit, but its use is not recommended. See also
15566 &%bounce_return_size_limit%&.
15567
15568 Incoming SMTP messages are failed with a 552 error if the limit is
15569 exceeded; locally-generated messages either get a stderr message or a delivery
15570 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15571 an oversized message is logged in both the main and the reject logs. See also
15572 the generic transport option &%message_size_limit%&, which limits the size of
15573 message that an individual transport can process.
15574
15575 If you use a virus-scanner and set this option to to a value larger than the
15576 maximum size that your virus-scanner is configured to support, you may get
15577 failures triggered by large mails.  The right size to configure for the
15578 virus-scanner depends upon what data is passed and the options in use but it's
15579 probably safest to just set it to a little larger than this value.  E.g., with a
15580 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15581 some problems may result.
15582
15583 A value of 0 will disable size limit checking; Exim will still advertise the
15584 SIZE extension in an EHLO response, but without a limit, so as to permit
15585 SMTP clients to still indicate the message size along with the MAIL verb.
15586
15587
15588 .option move_frozen_messages main boolean false
15589 .cindex "frozen messages" "moving"
15590 This option, which is available only if Exim has been built with the setting
15591 .code
15592 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15593 .endd
15594 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15595 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15596 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15597 standard utilities for handling such moved messages, and they do not show up in
15598 lists generated by &%-bp%& or by the Exim monitor.
15599
15600
15601 .option mua_wrapper main boolean false
15602 Setting this option true causes Exim to run in a very restrictive mode in which
15603 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15604 contains a full description of this facility.
15605
15606
15607
15608 .option mysql_servers main "string list" unset
15609 .cindex "MySQL" "server list"
15610 This option provides a list of MySQL servers and associated connection data, to
15611 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15612 option is available only if Exim has been built with MySQL support.
15613
15614
15615 .option never_users main "string list&!!" unset
15616 This option is expanded just once, at the start of Exim's processing. Local
15617 message deliveries are normally run in processes that are setuid to the
15618 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15619 It is usually desirable to prevent any deliveries from running as root, as a
15620 safety precaution.
15621
15622 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15623 list of users that must not be used for local deliveries. This list is fixed in
15624 the binary and cannot be overridden by the configuration file. By default, it
15625 contains just the single user name &"root"&. The &%never_users%& runtime option
15626 can be used to add more users to the fixed list.
15627
15628 If a message is to be delivered as one of the users on the fixed list or the
15629 &%never_users%& list, an error occurs, and delivery is deferred. A common
15630 example is
15631 .code
15632 never_users = root:daemon:bin
15633 .endd
15634 Including root is redundant if it is also on the fixed list, but it does no
15635 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15636 transport driver.
15637
15638
15639 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15640 .cindex "OpenSSL "compatibility options"
15641 This option allows an administrator to adjust the SSL options applied
15642 by OpenSSL to connections.  It is given as a space-separated list of items,
15643 each one to be +added or -subtracted from the current value.
15644
15645 This option is only available if Exim is built against OpenSSL.  The values
15646 available for this option vary according to the age of your OpenSSL install.
15647 The &"all"& value controls a subset of flags which are available, typically
15648 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15649 list the values known on your system and Exim should support all the
15650 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15651 names lose the leading &"SSL_OP_"& and are lower-cased.
15652
15653 Note that adjusting the options can have severe impact upon the security of
15654 SSL as used by Exim.  It is possible to disable safety checks and shoot
15655 yourself in the foot in various unpleasant ways.  This option should not be
15656 adjusted lightly.  An unrecognised item will be detected at startup, by
15657 invoking Exim with the &%-bV%& flag.
15658
15659 The option affects Exim operating both as a server and as a client.
15660
15661 Historical note: prior to release 4.80, Exim defaulted this value to
15662 "+dont_insert_empty_fragments", which may still be needed for compatibility
15663 with some clients, but which lowers security by increasing exposure to
15664 some now infamous attacks.
15665
15666 Examples:
15667 .code
15668 # Make both old MS and old Eudora happy:
15669 openssl_options = -all +microsoft_big_sslv3_buffer \
15670                        +dont_insert_empty_fragments
15671
15672 # Disable older protocol versions:
15673 openssl_options = +no_sslv2 +no_sslv3
15674 .endd
15675
15676 Possible options may include:
15677 .ilist
15678 &`all`&
15679 .next
15680 &`allow_unsafe_legacy_renegotiation`&
15681 .next
15682 &`cipher_server_preference`&
15683 .next
15684 &`dont_insert_empty_fragments`&
15685 .next
15686 &`ephemeral_rsa`&
15687 .next
15688 &`legacy_server_connect`&
15689 .next
15690 &`microsoft_big_sslv3_buffer`&
15691 .next
15692 &`microsoft_sess_id_bug`&
15693 .next
15694 &`msie_sslv2_rsa_padding`&
15695 .next
15696 &`netscape_challenge_bug`&
15697 .next
15698 &`netscape_reuse_cipher_change_bug`&
15699 .next
15700 &`no_compression`&
15701 .next
15702 &`no_session_resumption_on_renegotiation`&
15703 .next
15704 &`no_sslv2`&
15705 .next
15706 &`no_sslv3`&
15707 .next
15708 &`no_ticket`&
15709 .next
15710 &`no_tlsv1`&
15711 .next
15712 &`no_tlsv1_1`&
15713 .next
15714 &`no_tlsv1_2`&
15715 .next
15716 &`safari_ecdhe_ecdsa_bug`&
15717 .next
15718 &`single_dh_use`&
15719 .next
15720 &`single_ecdh_use`&
15721 .next
15722 &`ssleay_080_client_dh_bug`&
15723 .next
15724 &`sslref2_reuse_cert_type_bug`&
15725 .next
15726 &`tls_block_padding_bug`&
15727 .next
15728 &`tls_d5_bug`&
15729 .next
15730 &`tls_rollback_bug`&
15731 .endlist
15732
15733 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15734 all clients connecting using the MacOS SecureTransport TLS facility prior
15735 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15736 to negotiate TLS then this option value might help, provided that your OpenSSL
15737 release is new enough to contain this work-around.  This may be a situation
15738 where you have to upgrade OpenSSL to get buggy clients working.
15739
15740
15741 .option oracle_servers main "string list" unset
15742 .cindex "Oracle" "server list"
15743 This option provides a list of Oracle servers and associated connection data,
15744 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15745 The option is available only if Exim has been built with Oracle support.
15746
15747
15748 .option percent_hack_domains main "domain list&!!" unset
15749 .cindex "&""percent hack""&"
15750 .cindex "source routing" "in email address"
15751 .cindex "address" "source-routed"
15752 The &"percent hack"& is the convention whereby a local part containing a
15753 percent sign is re-interpreted as a new email address, with the percent
15754 replaced by @. This is sometimes called &"source routing"&, though that term is
15755 also applied to RFC 2822 addresses that begin with an @ character. If this
15756 option is set, Exim implements the percent facility for those domains listed,
15757 but no others. This happens before an incoming SMTP address is tested against
15758 an ACL.
15759
15760 &*Warning*&: The &"percent hack"& has often been abused by people who are
15761 trying to get round relaying restrictions. For this reason, it is best avoided
15762 if at all possible. Unfortunately, a number of less security-conscious MTAs
15763 implement it unconditionally. If you are running Exim on a gateway host, and
15764 routing mail through to internal MTAs without processing the local parts, it is
15765 a good idea to reject recipient addresses with percent characters in their
15766 local parts. Exim's default configuration does this.
15767
15768
15769 .option perl_at_start main boolean false
15770 .cindex "Perl"
15771 This option is available only when Exim is built with an embedded Perl
15772 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15773
15774
15775 .option perl_startup main string unset
15776 .cindex "Perl"
15777 This option is available only when Exim is built with an embedded Perl
15778 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15779
15780 .option perl_startup main boolean false
15781 .cindex "Perl"
15782 This Option enables the taint mode of the embedded Perl interpreter.
15783
15784
15785 .option pgsql_servers main "string list" unset
15786 .cindex "PostgreSQL lookup type" "server list"
15787 This option provides a list of PostgreSQL servers and associated connection
15788 data, to be used in conjunction with &(pgsql)& lookups (see section
15789 &<<SECID72>>&). The option is available only if Exim has been built with
15790 PostgreSQL support.
15791
15792
15793 .option pid_file_path main string&!! "set at compile time"
15794 .cindex "daemon" "pid file path"
15795 .cindex "pid file, path for"
15796 This option sets the name of the file to which the Exim daemon writes its
15797 process id. The string is expanded, so it can contain, for example, references
15798 to the host name:
15799 .code
15800 pid_file_path = /var/log/$primary_hostname/exim.pid
15801 .endd
15802 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15803 spool directory.
15804 The value set by the option can be overridden by the &%-oP%& command line
15805 option. A pid file is not written if a &"non-standard"& daemon is run by means
15806 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15807
15808
15809 .option pipelining_advertise_hosts main "host list&!!" *
15810 .cindex "PIPELINING" "suppressing advertising"
15811 This option can be used to suppress the advertisement of the SMTP
15812 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15813 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15814 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15815 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15816 that clients will use it; &"out of order"& commands that are &"expected"& do
15817 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15818
15819
15820 .option prdr_enable main boolean false
15821 .cindex "PRDR" "enabling on server"
15822 This option can be used to enable the Per-Recipient Data Response extension
15823 to SMTP, defined by Eric Hall.
15824 If the option is set, PRDR is advertised by Exim when operating as a server.
15825 If the client requests PRDR, and more than one recipient, for a message
15826 an additional ACL is called for each recipient after the message content
15827 is received.  See section &<<SECTPRDRACL>>&.
15828
15829 .option preserve_message_logs main boolean false
15830 .cindex "message logs" "preserving"
15831 If this option is set, message log files are not deleted when messages are
15832 completed. Instead, they are moved to a sub-directory of the spool directory
15833 called &_msglog.OLD_&, where they remain available for statistical or debugging
15834 purposes. This is a dangerous option to set on systems with any appreciable
15835 volume of mail. Use with care!
15836
15837
15838 .option primary_hostname main string "see below"
15839 .cindex "name" "of local host"
15840 .cindex "host" "name of local"
15841 .cindex "local host" "name of"
15842 .vindex "&$primary_hostname$&"
15843 This specifies the name of the current host. It is used in the default EHLO or
15844 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15845 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15846 The value is also used by default in some SMTP response messages from an Exim
15847 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15848
15849 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15850 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15851 contains only one component, Exim passes it to &[gethostbyname()]& (or
15852 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15853 version. The variable &$primary_hostname$& contains the host name, whether set
15854 explicitly by this option, or defaulted.
15855
15856
15857 .option print_topbitchars main boolean false
15858 .cindex "printing characters"
15859 .cindex "8-bit characters"
15860 By default, Exim considers only those characters whose codes lie in the range
15861 32&--126 to be printing characters. In a number of circumstances (for example,
15862 when writing log entries) non-printing characters are converted into escape
15863 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15864 is set, code values of 128 and above are also considered to be printing
15865 characters.
15866
15867 This option also affects the header syntax checks performed by the
15868 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15869 the user's full name when constructing From: and Sender: addresses (as
15870 described in section &<<SECTconstr>>&). Setting this option can cause
15871 Exim to generate eight bit message headers that do not conform to the
15872 standards.
15873
15874
15875 .option process_log_path main string unset
15876 .cindex "process log path"
15877 .cindex "log" "process log"
15878 .cindex "&'exiwhat'&"
15879 This option sets the name of the file to which an Exim process writes its
15880 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15881 utility script. If this option is unset, the file called &_exim-process.info_&
15882 in Exim's spool directory is used. The ability to specify the name explicitly
15883 can be useful in environments where two different Exims are running, using
15884 different spool directories.
15885
15886
15887 .option prod_requires_admin main boolean true
15888 .oindex "&%-M%&"
15889 .oindex "&%-R%&"
15890 .oindex "&%-q%&"
15891 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15892 admin user unless &%prod_requires_admin%& is set false. See also
15893 &%queue_list_requires_admin%&.
15894
15895
15896 .option qualify_domain main string "see below"
15897 .cindex "domain" "for qualifying addresses"
15898 .cindex "address" "qualification"
15899 This option specifies the domain name that is added to any envelope sender
15900 addresses that do not have a domain qualification. It also applies to
15901 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15902 are accepted by default only for locally-generated messages. Qualification is
15903 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15904 locally-generated messages, unless the &%-bnq%& command line option is used.
15905
15906 Messages from external sources must always contain fully qualified addresses,
15907 unless the sending host matches &%sender_unqualified_hosts%& or
15908 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15909 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15910 necessary. Internally, Exim always works with fully qualified envelope
15911 addresses. If &%qualify_domain%& is not set, it defaults to the
15912 &%primary_hostname%& value.
15913
15914
15915 .option qualify_recipient main string "see below"
15916 This option allows you to specify a different domain for qualifying recipient
15917 addresses to the one that is used for senders. See &%qualify_domain%& above.
15918
15919
15920
15921 .option queue_domains main "domain list&!!" unset
15922 .cindex "domain" "specifying non-immediate delivery"
15923 .cindex "queueing incoming messages"
15924 .cindex "message" "queueing certain domains"
15925 This option lists domains for which immediate delivery is not required.
15926 A delivery process is started whenever a message is received, but only those
15927 domains that do not match are processed. All other deliveries wait until the
15928 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15929
15930
15931 .option queue_list_requires_admin main boolean true
15932 .oindex "&%-bp%&"
15933 The &%-bp%& command-line option, which lists the messages that are on the
15934 queue, requires the caller to be an admin user unless
15935 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15936
15937
15938 .option queue_only main boolean false
15939 .cindex "queueing incoming messages"
15940 .cindex "message" "queueing unconditionally"
15941 If &%queue_only%& is set, a delivery process is not automatically started
15942 whenever a message is received. Instead, the message waits on the queue for the
15943 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15944 delivered immediately when certain conditions (such as heavy load) occur.
15945
15946 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15947 and &%-odi%& command line options override &%queue_only%& unless
15948 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15949 &%queue_only_load%&, and &%smtp_accept_queue%&.
15950
15951
15952 .option queue_only_file main string unset
15953 .cindex "queueing incoming messages"
15954 .cindex "message" "queueing by file existence"
15955 This option can be set to a colon-separated list of absolute path names, each
15956 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15957 it tests for the existence of each listed path using a call to &[stat()]&. For
15958 each path that exists, the corresponding queueing option is set.
15959 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15960 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15961 .code
15962 queue_only_file = smtp/some/file
15963 .endd
15964 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15965 &_/some/file_& exists.
15966
15967
15968 .option queue_only_load main fixed-point unset
15969 .cindex "load average"
15970 .cindex "queueing incoming messages"
15971 .cindex "message" "queueing by load"
15972 If the system load average is higher than this value, incoming messages from
15973 all sources are queued, and no automatic deliveries are started. If this
15974 happens during local or remote SMTP input, all subsequent messages received on
15975 the same SMTP connection are queued by default, whatever happens to the load in
15976 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15977 false.
15978
15979 Deliveries will subsequently be performed by queue runner processes. This
15980 option has no effect on ancient operating systems on which Exim cannot
15981 determine the load average. See also &%deliver_queue_load_max%& and
15982 &%smtp_load_reserve%&.
15983
15984
15985 .option queue_only_load_latch main boolean true
15986 .cindex "load average" "re-evaluating per message"
15987 When this option is true (the default), once one message has been queued
15988 because the load average is higher than the value set by &%queue_only_load%&,
15989 all subsequent messages received on the same SMTP connection are also queued.
15990 This is a deliberate choice; even though the load average may fall below the
15991 threshold, it doesn't seem right to deliver later messages on the same
15992 connection when not delivering earlier ones. However, there are special
15993 circumstances such as very long-lived connections from scanning appliances
15994 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15995 should be set false. This causes the value of the load average to be
15996 re-evaluated for each message.
15997
15998
15999 .option queue_only_override main boolean true
16000 .cindex "queueing incoming messages"
16001 When this option is true, the &%-od%&&'x'& command line options override the
16002 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16003 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16004 to override; they are accepted, but ignored.
16005
16006
16007 .option queue_run_in_order main boolean false
16008 .cindex "queue runner" "processing messages in order"
16009 If this option is set, queue runs happen in order of message arrival instead of
16010 in an arbitrary order. For this to happen, a complete list of the entire queue
16011 must be set up before the deliveries start. When the queue is all held in a
16012 single directory (the default), a single list is created for both the ordered
16013 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16014 single list is not created when &%queue_run_in_order%& is false. In this case,
16015 the sub-directories are processed one at a time (in a random order), and this
16016 avoids setting up one huge list for the whole queue. Thus, setting
16017 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16018 when the queue is large, because of the extra work in setting up the single,
16019 large list. In most situations, &%queue_run_in_order%& should not be set.
16020
16021
16022
16023 .option queue_run_max main integer&!! 5
16024 .cindex "queue runner" "maximum number of"
16025 This controls the maximum number of queue runner processes that an Exim daemon
16026 can run simultaneously. This does not mean that it starts them all at once,
16027 but rather that if the maximum number are still running when the time comes to
16028 start another one, it refrains from starting another one. This can happen with
16029 very large queues and/or very sluggish deliveries. This option does not,
16030 however, interlock with other processes, so additional queue runners can be
16031 started by other means, or by killing and restarting the daemon.
16032
16033 Setting this option to zero does not suppress queue runs; rather, it disables
16034 the limit, allowing any number of simultaneous queue runner processes to be
16035 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16036 the daemon's command line.
16037
16038 .new
16039 .cindex queues named
16040 .cindex "named queues"
16041 To set limits for different named queues use
16042 an expansion depending on the &$queue_name$& variable.
16043 .wen
16044
16045 .option queue_smtp_domains main "domain list&!!" unset
16046 .cindex "queueing incoming messages"
16047 .cindex "message" "queueing remote deliveries"
16048 When this option is set, a delivery process is started whenever a message is
16049 received, routing is performed, and local deliveries take place.
16050 However, if any SMTP deliveries are required for domains that match
16051 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16052 message waits on the queue for the next queue run. Since routing of the message
16053 has taken place, Exim knows to which remote hosts it must be delivered, and so
16054 when the queue run happens, multiple messages for the same host are delivered
16055 over a single SMTP connection. The &%-odqs%& command line option causes all
16056 SMTP deliveries to be queued in this way, and is equivalent to setting
16057 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16058 &%queue_domains%&.
16059
16060
16061 .option receive_timeout main time 0s
16062 .cindex "timeout" "for non-SMTP input"
16063 This option sets the timeout for accepting a non-SMTP message, that is, the
16064 maximum time that Exim waits when reading a message on the standard input. If
16065 the value is zero, it will wait for ever. This setting is overridden by the
16066 &%-or%& command line option. The timeout for incoming SMTP messages is
16067 controlled by &%smtp_receive_timeout%&.
16068
16069 .option received_header_text main string&!! "see below"
16070 .cindex "customizing" "&'Received:'& header"
16071 .cindex "&'Received:'& header line" "customizing"
16072 This string defines the contents of the &'Received:'& message header that is
16073 added to each message, except for the timestamp, which is automatically added
16074 on at the end (preceded by a semicolon). The string is expanded each time it is
16075 used. If the expansion yields an empty string, no &'Received:'& header line is
16076 added to the message. Otherwise, the string should start with the text
16077 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16078 header lines. The default setting is:
16079
16080 .code
16081 received_header_text = Received: \
16082   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16083   {${if def:sender_ident \
16084   {from ${quote_local_part:$sender_ident} }}\
16085   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16086   by $primary_hostname \
16087   ${if def:received_protocol {with $received_protocol}} \
16088   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16089   (Exim $version_number)\n\t\
16090   ${if def:sender_address \
16091   {(envelope-from <$sender_address>)\n\t}}\
16092   id $message_exim_id\
16093   ${if def:received_for {\n\tfor $received_for}}
16094 .endd
16095
16096 The reference to the TLS cipher is omitted when Exim is built without TLS
16097 support. The use of conditional expansions ensures that this works for both
16098 locally generated messages and messages received from remote hosts, giving
16099 header lines such as the following:
16100 .code
16101 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16102 by marley.carol.example with esmtp (Exim 4.00)
16103 (envelope-from <bob@carol.example>)
16104 id 16IOWa-00019l-00
16105 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16106 Received: by scrooge.carol.example with local (Exim 4.00)
16107 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16108 .endd
16109 Until the body of the message has been received, the timestamp is the time when
16110 the message started to be received. Once the body has arrived, and all policy
16111 checks have taken place, the timestamp is updated to the time at which the
16112 message was accepted.
16113
16114
16115 .option received_headers_max main integer 30
16116 .cindex "loop" "prevention"
16117 .cindex "mail loop prevention"
16118 .cindex "&'Received:'& header line" "counting"
16119 When a message is to be delivered, the number of &'Received:'& headers is
16120 counted, and if it is greater than this parameter, a mail loop is assumed to
16121 have occurred, the delivery is abandoned, and an error message is generated.
16122 This applies to both local and remote deliveries.
16123
16124
16125 .option recipient_unqualified_hosts main "host list&!!" unset
16126 .cindex "unqualified addresses"
16127 .cindex "host" "unqualified addresses from"
16128 This option lists those hosts from which Exim is prepared to accept unqualified
16129 recipient addresses in message envelopes. The addresses are made fully
16130 qualified by the addition of the &%qualify_recipient%& value. This option also
16131 affects message header lines. Exim does not reject unqualified recipient
16132 addresses in headers, but it qualifies them only if the message came from a
16133 host that matches &%recipient_unqualified_hosts%&,
16134 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16135 option was not set.
16136
16137
16138 .option recipients_max main integer 0
16139 .cindex "limit" "number of recipients"
16140 .cindex "recipient" "maximum number"
16141 If this option is set greater than zero, it specifies the maximum number of
16142 original recipients for any message. Additional recipients that are generated
16143 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16144 all recipients over the limit; earlier recipients are delivered as normal.
16145 Non-SMTP messages with too many recipients are failed, and no deliveries are
16146 done.
16147
16148 .cindex "RCPT" "maximum number of incoming"
16149 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16150 RCPT commands in a single message.
16151
16152
16153 .option recipients_max_reject main boolean false
16154 If this option is set true, Exim rejects SMTP messages containing too many
16155 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16156 error to the eventual DATA command. Otherwise (the default) it gives a 452
16157 error to the surplus RCPT commands and accepts the message on behalf of the
16158 initial set of recipients. The remote server should then re-send the message
16159 for the remaining recipients at a later time.
16160
16161
16162 .option remote_max_parallel main integer 2
16163 .cindex "delivery" "parallelism for remote"
16164 This option controls parallel delivery of one message to a number of remote
16165 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16166 does all the remote deliveries for a message one by one. Otherwise, if a single
16167 message has to be delivered to more than one remote host, or if several copies
16168 have to be sent to the same remote host, up to &%remote_max_parallel%&
16169 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16170 deliveries are required, the maximum number of processes are started, and as
16171 each one finishes, another is begun. The order of starting processes is the
16172 same as if sequential delivery were being done, and can be controlled by the
16173 &%remote_sort_domains%& option. If parallel delivery takes place while running
16174 with debugging turned on, the debugging output from each delivery process is
16175 tagged with its process id.
16176
16177 This option controls only the maximum number of parallel deliveries for one
16178 message in one Exim delivery process. Because Exim has no central queue
16179 manager, there is no way of controlling the total number of simultaneous
16180 deliveries if the configuration allows a delivery attempt as soon as a message
16181 is received.
16182
16183 .cindex "number of deliveries"
16184 .cindex "delivery" "maximum number of"
16185 If you want to control the total number of deliveries on the system, you
16186 need to set the &%queue_only%& option. This ensures that all incoming messages
16187 are added to the queue without starting a delivery process. Then set up an Exim
16188 daemon to start queue runner processes at appropriate intervals (probably
16189 fairly often, for example, every minute), and limit the total number of queue
16190 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16191 delivers only one message at a time, the maximum number of deliveries that can
16192 then take place at once is &%queue_run_max%& multiplied by
16193 &%remote_max_parallel%&.
16194
16195 If it is purely remote deliveries you want to control, use
16196 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16197 doing the SMTP routing before queueing, so that several messages for the same
16198 host will eventually get delivered down the same connection.
16199
16200
16201 .option remote_sort_domains main "domain list&!!" unset
16202 .cindex "sorting remote deliveries"
16203 .cindex "delivery" "sorting remote"
16204 When there are a number of remote deliveries for a message, they are sorted by
16205 domain into the order given by this list. For example,
16206 .code
16207 remote_sort_domains = *.cam.ac.uk:*.uk
16208 .endd
16209 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16210 then to those in the &%uk%& domain, then to any others.
16211
16212
16213 .option retry_data_expire main time 7d
16214 .cindex "hints database" "data expiry"
16215 This option sets a &"use before"& time on retry information in Exim's hints
16216 database. Any older retry data is ignored. This means that, for example, once a
16217 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16218 past failures.
16219
16220
16221 .option retry_interval_max main time 24h
16222 .cindex "retry" "limit on interval"
16223 .cindex "limit" "on retry interval"
16224 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16225 intervals between delivery attempts for messages that cannot be delivered
16226 straight away. This option sets an overall limit to the length of time between
16227 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16228 the default value.
16229
16230
16231 .option return_path_remove main boolean true
16232 .cindex "&'Return-path:'& header line" "removing"
16233 RFC 2821, section 4.4, states that an SMTP server must insert a
16234 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16235 The &'Return-path:'& header preserves the sender address as received in the
16236 MAIL command. This description implies that this header should not be present
16237 in an incoming message. If &%return_path_remove%& is true, any existing
16238 &'Return-path:'& headers are removed from messages at the time they are
16239 received. Exim's transports have options for adding &'Return-path:'& headers at
16240 the time of delivery. They are normally used only for final local deliveries.
16241
16242
16243 .option return_size_limit main integer 100K
16244 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16245
16246
16247 .option rfc1413_hosts main "host list&!!" @[]
16248 .cindex "RFC 1413"
16249 .cindex "host" "for RFC 1413 calls"
16250 RFC 1413 identification calls are made to any client host which matches
16251 an item in the list.
16252 The default value specifies just this host, being any local interface
16253 for the system.
16254
16255 .option rfc1413_query_timeout main time 0s
16256 .cindex "RFC 1413" "query timeout"
16257 .cindex "timeout" "for RFC 1413 call"
16258 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16259 no RFC 1413 calls are ever made.
16260
16261
16262 .option sender_unqualified_hosts main "host list&!!" unset
16263 .cindex "unqualified addresses"
16264 .cindex "host" "unqualified addresses from"
16265 This option lists those hosts from which Exim is prepared to accept unqualified
16266 sender addresses. The addresses are made fully qualified by the addition of
16267 &%qualify_domain%&. This option also affects message header lines. Exim does
16268 not reject unqualified addresses in headers that contain sender addresses, but
16269 it qualifies them only if the message came from a host that matches
16270 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16271 using TCP/IP), and the &%-bnq%& option was not set.
16272
16273 .option set_environment main "string list" empty
16274 .cindex "environment"
16275 This option allows to set individual environment variables that the
16276 currently linked libraries and programs in child processes use. The
16277 default list is empty,
16278
16279
16280 .option slow_lookup_log main integer 0
16281 .cindex "logging" "slow lookups"
16282 .cindex "dns" "logging slow lookups"
16283 This option controls logging of slow lookups.
16284 If the value is nonzero it is taken as a number of milliseconds
16285 and lookups taking longer than this are logged.
16286 Currently this applies only to DNS lookups.
16287
16288
16289
16290 .option smtp_accept_keepalive main boolean true
16291 .cindex "keepalive" "on incoming connection"
16292 This option controls the setting of the SO_KEEPALIVE option on incoming
16293 TCP/IP socket connections. When set, it causes the kernel to probe idle
16294 connections periodically, by sending packets with &"old"& sequence numbers. The
16295 other end of the connection should send an acknowledgment if the connection is
16296 still okay or a reset if the connection has been aborted. The reason for doing
16297 this is that it has the beneficial effect of freeing up certain types of
16298 connection that can get stuck when the remote host is disconnected without
16299 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16300 hours to detect unreachable hosts.
16301
16302
16303
16304 .option smtp_accept_max main integer 20
16305 .cindex "limit" "incoming SMTP connections"
16306 .cindex "SMTP" "incoming connection count"
16307 .cindex "inetd"
16308 This option specifies the maximum number of simultaneous incoming SMTP calls
16309 that Exim will accept. It applies only to the listening daemon; there is no
16310 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16311 value is set to zero, no limit is applied. However, it is required to be
16312 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16313 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16314
16315 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16316 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16317 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16318 and &%smtp_load_reserve%& are then checked before accepting the connection.
16319
16320
16321 .option smtp_accept_max_nonmail main integer 10
16322 .cindex "limit" "non-mail SMTP commands"
16323 .cindex "SMTP" "limiting non-mail commands"
16324 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16325 the connection if there are too many. This option defines &"too many"&. The
16326 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16327 client looping sending EHLO, for example. The check is applied only if the
16328 client host matches &%smtp_accept_max_nonmail_hosts%&.
16329
16330 When a new message is expected, one occurrence of RSET is not counted. This
16331 allows a client to send one RSET between messages (this is not necessary,
16332 but some clients do it). Exim also allows one uncounted occurrence of HELO
16333 or EHLO, and one occurrence of STARTTLS between messages. After
16334 starting up a TLS session, another EHLO is expected, and so it too is not
16335 counted. The first occurrence of AUTH in a connection, or immediately
16336 following STARTTLS is not counted. Otherwise, all commands other than
16337 MAIL, RCPT, DATA, and QUIT are counted.
16338
16339
16340 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16341 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16342 check by setting this option. The default value makes it apply to all hosts. By
16343 changing the value, you can exclude any badly-behaved hosts that you have to
16344 live with.
16345
16346
16347 . Allow this long option name to split; give it unsplit as a fifth argument
16348 . for the automatic .oindex that is generated by .option.
16349 . We insert " &~&~" which is both pretty nasty visually and results in
16350 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16351 . zero-width-space, which would be nicer visually and results in (at least)
16352 . html that Firefox will split on when it's forced to reflow (rather than
16353 . inserting a horizontal scrollbar).  However, the text is still not
16354 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16355 . the option name to split.
16356
16357 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16358          smtp_accept_max_per_connection
16359 .cindex "SMTP" "limiting incoming message count"
16360 .cindex "limit" "messages per SMTP connection"
16361 The value of this option limits the number of MAIL commands that Exim is
16362 prepared to accept over a single SMTP connection, whether or not each command
16363 results in the transfer of a message. After the limit is reached, a 421
16364 response is given to subsequent MAIL commands. This limit is a safety
16365 precaution against a client that goes mad (incidents of this type have been
16366 seen).
16367
16368
16369 .option smtp_accept_max_per_host main string&!! unset
16370 .cindex "limit" "SMTP connections from one host"
16371 .cindex "host" "limiting SMTP connections from"
16372 This option restricts the number of simultaneous IP connections from a single
16373 host (strictly, from a single IP address) to the Exim daemon. The option is
16374 expanded, to enable different limits to be applied to different hosts by
16375 reference to &$sender_host_address$&. Once the limit is reached, additional
16376 connection attempts from the same host are rejected with error code 421. This
16377 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16378 of zero imposes no limit. If this option is set greater than zero, it is
16379 required that &%smtp_accept_max%& be non-zero.
16380
16381 &*Warning*&: When setting this option you should not use any expansion
16382 constructions that take an appreciable amount of time. The expansion and test
16383 happen in the main daemon loop, in order to reject additional connections
16384 without forking additional processes (otherwise a denial-of-service attack
16385 could cause a vast number or processes to be created). While the daemon is
16386 doing this processing, it cannot accept any other incoming connections.
16387
16388
16389
16390 .option smtp_accept_queue main integer 0
16391 .cindex "SMTP" "incoming connection count"
16392 .cindex "queueing incoming messages"
16393 .cindex "message" "queueing by SMTP connection count"
16394 If the number of simultaneous incoming SMTP connections being handled via the
16395 listening daemon exceeds this value, messages received by SMTP are just placed
16396 on the queue; no delivery processes are started automatically. The count is
16397 fixed at the start of an SMTP connection. It cannot be updated in the
16398 subprocess that receives messages, and so the queueing or not queueing applies
16399 to all messages received in the same connection.
16400
16401 A value of zero implies no limit, and clearly any non-zero value is useful only
16402 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16403 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16404 various &%-od%&&'x'& command line options.
16405
16406
16407 . See the comment on smtp_accept_max_per_connection
16408
16409 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16410          smtp_accept_queue_per_connection
16411 .cindex "queueing incoming messages"
16412 .cindex "message" "queueing by message count"
16413 This option limits the number of delivery processes that Exim starts
16414 automatically when receiving messages via SMTP, whether via the daemon or by
16415 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16416 and the number of messages received in a single SMTP session exceeds this
16417 number, subsequent messages are placed on the queue, but no delivery processes
16418 are started. This helps to limit the number of Exim processes when a server
16419 restarts after downtime and there is a lot of mail waiting for it on other
16420 systems. On large systems, the default should probably be increased, and on
16421 dial-in client systems it should probably be set to zero (that is, disabled).
16422
16423
16424 .option smtp_accept_reserve main integer 0
16425 .cindex "SMTP" "incoming call count"
16426 .cindex "host" "reserved"
16427 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16428 number of SMTP connections that are reserved for connections from the hosts
16429 that are specified in &%smtp_reserve_hosts%&. The value set in
16430 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16431 restricted to this number of connections; the option specifies a minimum number
16432 of connection slots for them, not a maximum. It is a guarantee that this group
16433 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16434 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16435 individual host.
16436
16437 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16438 set to 5, once there are 45 active connections (from any hosts), new
16439 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16440 provided the other criteria for acceptance are met.
16441
16442
16443 .option smtp_active_hostname main string&!! unset
16444 .cindex "host" "name in SMTP responses"
16445 .cindex "SMTP" "host name in responses"
16446 .vindex "&$primary_hostname$&"
16447 This option is provided for multi-homed servers that want to masquerade as
16448 several different hosts. At the start of an incoming SMTP connection, its value
16449 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16450 responses. For example, it is used as domain name in the response to an
16451 incoming HELO or EHLO command.
16452
16453 .vindex "&$smtp_active_hostname$&"
16454 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16455 is saved with any messages that are received. It is therefore available for use
16456 in routers and transports when the message is later delivered.
16457
16458 If this option is unset, or if its expansion is forced to fail, or if the
16459 expansion results in an empty string, the value of &$primary_hostname$& is
16460 used. Other expansion failures cause a message to be written to the main and
16461 panic logs, and the SMTP command receives a temporary error. Typically, the
16462 value of &%smtp_active_hostname%& depends on the incoming interface address.
16463 For example:
16464 .code
16465 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16466   {cox.mydomain}{box.mydomain}}
16467 .endd
16468
16469 Although &$smtp_active_hostname$& is primarily concerned with incoming
16470 messages, it is also used as the default for HELO commands in callout
16471 verification if there is no remote transport from which to obtain a
16472 &%helo_data%& value.
16473
16474 .option smtp_banner main string&!! "see below"
16475 .cindex "SMTP" "welcome banner"
16476 .cindex "banner for SMTP"
16477 .cindex "welcome banner for SMTP"
16478 .cindex "customizing" "SMTP banner"
16479 This string, which is expanded every time it is used, is output as the initial
16480 positive response to an SMTP connection. The default setting is:
16481 .code
16482 smtp_banner = $smtp_active_hostname ESMTP Exim \
16483   $version_number $tod_full
16484 .endd
16485 Failure to expand the string causes a panic error. If you want to create a
16486 multiline response to the initial SMTP connection, use &"\n"& in the string at
16487 appropriate points, but not at the end. Note that the 220 code is not included
16488 in this string. Exim adds it automatically (several times in the case of a
16489 multiline response).
16490
16491
16492 .option smtp_check_spool_space main boolean true
16493 .cindex "checking disk space"
16494 .cindex "disk space, checking"
16495 .cindex "spool directory" "checking space"
16496 When this option is set, if an incoming SMTP session encounters the SIZE
16497 option on a MAIL command, it checks that there is enough space in the
16498 spool directory's partition to accept a message of that size, while still
16499 leaving free the amount specified by &%check_spool_space%& (even if that value
16500 is zero). If there isn't enough space, a temporary error code is returned.
16501
16502
16503 .option smtp_connect_backlog main integer 20
16504 .cindex "connection backlog"
16505 .cindex "SMTP" "connection backlog"
16506 .cindex "backlog of connections"
16507 This option specifies a maximum number of waiting SMTP connections. Exim passes
16508 this value to the TCP/IP system when it sets up its listener. Once this number
16509 of connections are waiting for the daemon's attention, subsequent connection
16510 attempts are refused at the TCP/IP level. At least, that is what the manuals
16511 say; in some circumstances such connection attempts have been observed to time
16512 out instead. For large systems it is probably a good idea to increase the
16513 value (to 50, say). It also gives some protection against denial-of-service
16514 attacks by SYN flooding.
16515
16516
16517 .option smtp_enforce_sync main boolean true
16518 .cindex "SMTP" "synchronization checking"
16519 .cindex "synchronization checking in SMTP"
16520 The SMTP protocol specification requires the client to wait for a response from
16521 the server at certain points in the dialogue. Without PIPELINING these
16522 synchronization points are after every command; with PIPELINING they are
16523 fewer, but they still exist.
16524
16525 Some spamming sites send out a complete set of SMTP commands without waiting
16526 for any response. Exim protects against this by rejecting a message if the
16527 client has sent further input when it should not have. The error response &"554
16528 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16529 for this error cannot be perfect because of transmission delays (unexpected
16530 input may be on its way but not yet received when Exim checks). However, it
16531 does detect many instances.
16532
16533 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16534 If you want to disable the check selectively (for example, only for certain
16535 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16536 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16537
16538
16539
16540 .option smtp_etrn_command main string&!! unset
16541 .cindex "ETRN" "command to be run"
16542 .vindex "&$domain$&"
16543 If this option is set, the given command is run whenever an SMTP ETRN
16544 command is received from a host that is permitted to issue such commands (see
16545 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16546 are independently expanded. The expansion variable &$domain$& is set to the
16547 argument of the ETRN command, and no syntax checking is done on it. For
16548 example:
16549 .code
16550 smtp_etrn_command = /etc/etrn_command $domain \
16551                     $sender_host_address
16552 .endd
16553 A new process is created to run the command, but Exim does not wait for it to
16554 complete. Consequently, its status cannot be checked. If the command cannot be
16555 run, a line is written to the panic log, but the ETRN caller still receives
16556 a 250 success response. Exim is normally running under its own uid when
16557 receiving SMTP, so it is not possible for it to change the uid before running
16558 the command.
16559
16560
16561 .option smtp_etrn_serialize main boolean true
16562 .cindex "ETRN" "serializing"
16563 When this option is set, it prevents the simultaneous execution of more than
16564 one identical command as a result of ETRN in an SMTP connection. See
16565 section &<<SECTETRN>>& for details.
16566
16567
16568 .option smtp_load_reserve main fixed-point unset
16569 .cindex "load average"
16570 If the system load average ever gets higher than this, incoming SMTP calls are
16571 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16572 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16573 the load is over the limit. The option has no effect on ancient operating
16574 systems on which Exim cannot determine the load average. See also
16575 &%deliver_queue_load_max%& and &%queue_only_load%&.
16576
16577
16578
16579 .option smtp_max_synprot_errors main integer 3
16580 .cindex "SMTP" "limiting syntax and protocol errors"
16581 .cindex "limit" "SMTP syntax and protocol errors"
16582 Exim rejects SMTP commands that contain syntax or protocol errors. In
16583 particular, a syntactically invalid email address, as in this command:
16584 .code
16585 RCPT TO:<abc xyz@a.b.c>
16586 .endd
16587 causes immediate rejection of the command, before any other tests are done.
16588 (The ACL cannot be run if there is no valid address to set up for it.) An
16589 example of a protocol error is receiving RCPT before MAIL. If there are
16590 too many syntax or protocol errors in one SMTP session, the connection is
16591 dropped. The limit is set by this option.
16592
16593 .cindex "PIPELINING" "expected errors"
16594 When the PIPELINING extension to SMTP is in use, some protocol errors are
16595 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16596 Exim assumes that PIPELINING will be used if it advertises it (see
16597 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16598 not count towards the limit.
16599
16600
16601
16602 .option smtp_max_unknown_commands main integer 3
16603 .cindex "SMTP" "limiting unknown commands"
16604 .cindex "limit" "unknown SMTP commands"
16605 If there are too many unrecognized commands in an incoming SMTP session, an
16606 Exim server drops the connection. This is a defence against some kinds of abuse
16607 that subvert web
16608 clients
16609 into making connections to SMTP ports; in these circumstances, a number of
16610 non-SMTP command lines are sent first.
16611
16612
16613
16614 .option smtp_ratelimit_hosts main "host list&!!" unset
16615 .cindex "SMTP" "rate limiting"
16616 .cindex "limit" "rate of message arrival"
16617 .cindex "RCPT" "rate limiting"
16618 Some sites find it helpful to be able to limit the rate at which certain hosts
16619 can send them messages, and the rate at which an individual message can specify
16620 recipients.
16621
16622 Exim has two rate-limiting facilities. This section describes the older
16623 facility, which can limit rates within a single connection. The newer
16624 &%ratelimit%& ACL condition can limit rates across all connections. See section
16625 &<<SECTratelimiting>>& for details of the newer facility.
16626
16627 When a host matches &%smtp_ratelimit_hosts%&, the values of
16628 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16629 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16630 respectively. Each option, if set, must contain a set of four comma-separated
16631 values:
16632
16633 .ilist
16634 A threshold, before which there is no rate limiting.
16635 .next
16636 An initial time delay. Unlike other times in Exim, numbers with decimal
16637 fractional parts are allowed here.
16638 .next
16639 A factor by which to increase the delay each time.
16640 .next
16641 A maximum value for the delay. This should normally be less than 5 minutes,
16642 because after that time, the client is liable to timeout the SMTP command.
16643 .endlist
16644
16645 For example, these settings have been used successfully at the site which
16646 first suggested this feature, for controlling mail from their customers:
16647 .code
16648 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16649 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16650 .endd
16651 The first setting specifies delays that are applied to MAIL commands after
16652 two have been received over a single connection. The initial delay is 0.5
16653 seconds, increasing by a factor of 1.05 each time. The second setting applies
16654 delays to RCPT commands when more than four occur in a single message.
16655
16656
16657 .option smtp_ratelimit_mail main string unset
16658 See &%smtp_ratelimit_hosts%& above.
16659
16660
16661 .option smtp_ratelimit_rcpt main string unset
16662 See &%smtp_ratelimit_hosts%& above.
16663
16664
16665 .option smtp_receive_timeout main time&!! 5m
16666 .cindex "timeout" "for SMTP input"
16667 .cindex "SMTP" "input timeout"
16668 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16669 input, including batch SMTP. If a line of input (either an SMTP command or a
16670 data line) is not received within this time, the SMTP connection is dropped and
16671 the message is abandoned.
16672 A line is written to the log containing one of the following messages:
16673 .code
16674 SMTP command timeout on connection from...
16675 SMTP data timeout on connection from...
16676 .endd
16677 The former means that Exim was expecting to read an SMTP command; the latter
16678 means that it was in the DATA phase, reading the contents of a message.
16679
16680 If the first character of the option is a &"$"& the option is
16681 expanded before use and may depend on
16682 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16683
16684
16685 .oindex "&%-os%&"
16686 The value set by this option can be overridden by the
16687 &%-os%& command-line option. A setting of zero time disables the timeout, but
16688 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16689 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16690 timeout is controlled by &%receive_timeout%& and &%-or%&.
16691
16692
16693 .option smtp_reserve_hosts main "host list&!!" unset
16694 This option defines hosts for which SMTP connections are reserved; see
16695 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16696
16697
16698 .option smtp_return_error_details main boolean false
16699 .cindex "SMTP" "details policy failures"
16700 .cindex "policy control" "rejection, returning details"
16701 In the default state, Exim uses bland messages such as
16702 &"Administrative prohibition"& when it rejects SMTP commands for policy
16703 reasons. Many sysadmins like this because it gives away little information
16704 to spammers. However, some other sysadmins who are applying strict checking
16705 policies want to give out much fuller information about failures. Setting
16706 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16707 example, instead of &"Administrative prohibition"&, it might give:
16708 .code
16709 550-Rejected after DATA: '>' missing at end of address:
16710 550 failing address in "From" header is: <user@dom.ain
16711 .endd
16712
16713
16714 .option smtputf8_advertise_hosts main "host list&!!" *
16715 .cindex "SMTPUTF8" "advertising"
16716 When Exim is built with support for internationalised mail names,
16717 the availability therof is advertised in
16718 response to EHLO only to those client hosts that match this option. See
16719 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16720
16721
16722 .option spamd_address main string "see below"
16723 This option is available when Exim is compiled with the content-scanning
16724 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16725 The default value is
16726 .code
16727 127.0.0.1 783
16728 .endd
16729 See section &<<SECTscanspamass>>& for more details.
16730
16731
16732
16733 .option split_spool_directory main boolean false
16734 .cindex "multiple spool directories"
16735 .cindex "spool directory" "split"
16736 .cindex "directories, multiple"
16737 If this option is set, it causes Exim to split its input directory into 62
16738 subdirectories, each with a single alphanumeric character as its name. The
16739 sixth character of the message id is used to allocate messages to
16740 subdirectories; this is the least significant base-62 digit of the time of
16741 arrival of the message.
16742
16743 Splitting up the spool in this way may provide better performance on systems
16744 where there are long mail queues, by reducing the number of files in any one
16745 directory. The msglog directory is also split up in a similar way to the input
16746 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16747 are still placed in the single directory &_msglog.OLD_&.
16748
16749 It is not necessary to take any special action for existing messages when
16750 changing &%split_spool_directory%&. Exim notices messages that are in the
16751 &"wrong"& place, and continues to process them. If the option is turned off
16752 after a period of being on, the subdirectories will eventually empty and be
16753 automatically deleted.
16754
16755 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16756 changes. Instead of creating a list of all messages in the queue, and then
16757 trying to deliver each one in turn, it constructs a list of those in one
16758 sub-directory and tries to deliver them, before moving on to the next
16759 sub-directory. The sub-directories are processed in a random order. This
16760 spreads out the scanning of the input directories, and uses less memory. It is
16761 particularly beneficial when there are lots of messages on the queue. However,
16762 if &%queue_run_in_order%& is set, none of this new processing happens. The
16763 entire queue has to be scanned and sorted before any deliveries can start.
16764
16765
16766 .option spool_directory main string&!! "set at compile time"
16767 .cindex "spool directory" "path to"
16768 This defines the directory in which Exim keeps its spool, that is, the messages
16769 it is waiting to deliver. The default value is taken from the compile-time
16770 configuration setting, if there is one. If not, this option must be set. The
16771 string is expanded, so it can contain, for example, a reference to
16772 &$primary_hostname$&.
16773
16774 If the spool directory name is fixed on your installation, it is recommended
16775 that you set it at build time rather than from this option, particularly if the
16776 log files are being written to the spool directory (see &%log_file_path%&).
16777 Otherwise log files cannot be used for errors that are detected early on, such
16778 as failures in the configuration file.
16779
16780 By using this option to override the compiled-in path, it is possible to run
16781 tests of Exim without using the standard spool.
16782
16783 .option sqlite_lock_timeout main time 5s
16784 .cindex "sqlite lookup type" "lock timeout"
16785 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16786 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16787
16788 .option strict_acl_vars main boolean false
16789 .cindex "&ACL;" "variables, handling unset"
16790 This option controls what happens if a syntactically valid but undefined ACL
16791 variable is referenced. If it is false (the default), an empty string
16792 is substituted; if it is true, an error is generated. See section
16793 &<<SECTaclvariables>>& for details of ACL variables.
16794
16795 .option strip_excess_angle_brackets main boolean false
16796 .cindex "angle brackets, excess"
16797 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16798 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16799 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16800 passed on to another MTA, the excess angle brackets are not passed on. If this
16801 option is not set, multiple pairs of angle brackets cause a syntax error.
16802
16803
16804 .option strip_trailing_dot main boolean false
16805 .cindex "trailing dot on domain"
16806 .cindex "dot" "trailing on domain"
16807 If this option is set, a trailing dot at the end of a domain in an address is
16808 ignored. If this is in the envelope and the message is passed on to another
16809 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16810 domain causes a syntax error.
16811 However, addresses in header lines are checked only when an ACL requests header
16812 syntax checking.
16813
16814
16815 .option syslog_duplication main boolean true
16816 .cindex "syslog" "duplicate log lines; suppressing"
16817 When Exim is logging to syslog, it writes the log lines for its three
16818 separate logs at different syslog priorities so that they can in principle
16819 be separated on the logging hosts. Some installations do not require this
16820 separation, and in those cases, the duplication of certain log lines is a
16821 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16822 particular log line is written to syslog. For lines that normally go to
16823 both the main log and the reject log, the reject log version (possibly
16824 containing message header lines) is written, at LOG_NOTICE priority.
16825 Lines that normally go to both the main and the panic log are written at
16826 the LOG_ALERT priority.
16827
16828
16829 .option syslog_facility main string unset
16830 .cindex "syslog" "facility; setting"
16831 This option sets the syslog &"facility"& name, used when Exim is logging to
16832 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16833 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16834 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16835 details of Exim's logging.
16836
16837
16838
16839 .option syslog_processname main string &`exim`&
16840 .cindex "syslog" "process name; setting"
16841 This option sets the syslog &"ident"& name, used when Exim is logging to
16842 syslog. The value must be no longer than 32 characters. See chapter
16843 &<<CHAPlog>>& for details of Exim's logging.
16844
16845
16846
16847 .option syslog_timestamp main boolean true
16848 .cindex "syslog" "timestamps"
16849 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16850 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16851 details of Exim's logging.
16852
16853
16854 .option system_filter main string&!! unset
16855 .cindex "filter" "system filter"
16856 .cindex "system filter" "specifying"
16857 .cindex "Sieve filter" "not available for system filter"
16858 This option specifies an Exim filter file that is applied to all messages at
16859 the start of each delivery attempt, before any routing is done. System filters
16860 must be Exim filters; they cannot be Sieve filters. If the system filter
16861 generates any deliveries to files or pipes, or any new mail messages, the
16862 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16863 which transports are to be used. Details of this facility are given in chapter
16864 &<<CHAPsystemfilter>>&.
16865
16866
16867 .option system_filter_directory_transport main string&!! unset
16868 .vindex "&$address_file$&"
16869 This sets the name of the transport driver that is to be used when the
16870 &%save%& command in a system message filter specifies a path ending in &"/"&,
16871 implying delivery of each message into a separate file in some directory.
16872 During the delivery, the variable &$address_file$& contains the path name.
16873
16874
16875 .option system_filter_file_transport main string&!! unset
16876 .cindex "file" "transport for system filter"
16877 This sets the name of the transport driver that is to be used when the &%save%&
16878 command in a system message filter specifies a path not ending in &"/"&. During
16879 the delivery, the variable &$address_file$& contains the path name.
16880
16881 .option system_filter_group main string unset
16882 .cindex "gid (group id)" "system filter"
16883 This option is used only when &%system_filter_user%& is also set. It sets the
16884 gid under which the system filter is run, overriding any gid that is associated
16885 with the user. The value may be numerical or symbolic.
16886
16887 .option system_filter_pipe_transport main string&!! unset
16888 .cindex "&(pipe)& transport" "for system filter"
16889 .vindex "&$address_pipe$&"
16890 This specifies the transport driver that is to be used when a &%pipe%& command
16891 is used in a system filter. During the delivery, the variable &$address_pipe$&
16892 contains the pipe command.
16893
16894
16895 .option system_filter_reply_transport main string&!! unset
16896 .cindex "&(autoreply)& transport" "for system filter"
16897 This specifies the transport driver that is to be used when a &%mail%& command
16898 is used in a system filter.
16899
16900
16901 .option system_filter_user main string unset
16902 .cindex "uid (user id)" "system filter"
16903 If this option is set to root, the system filter is run in the main Exim
16904 delivery process, as root.  Otherwise, the system filter runs in a separate
16905 process, as the given user, defaulting to the Exim run-time user.
16906 Unless the string consists entirely of digits, it
16907 is looked up in the password data. Failure to find the named user causes a
16908 configuration error. The gid is either taken from the password data, or
16909 specified by &%system_filter_group%&. When the uid is specified numerically,
16910 &%system_filter_group%& is required to be set.
16911
16912 If the system filter generates any pipe, file, or reply deliveries, the uid
16913 under which the filter is run is used when transporting them, unless a
16914 transport option overrides.
16915
16916
16917 .option tcp_nodelay main boolean true
16918 .cindex "daemon" "TCP_NODELAY on sockets"
16919 .cindex "Nagle algorithm"
16920 .cindex "TCP_NODELAY on listening sockets"
16921 If this option is set false, it stops the Exim daemon setting the
16922 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16923 turns off the &"Nagle algorithm"&, which is a way of improving network
16924 performance in interactive (character-by-character) situations. Turning it off
16925 should improve Exim's performance a bit, so that is what happens by default.
16926 However, it appears that some broken clients cannot cope, and time out. Hence
16927 this option. It affects only those sockets that are set up for listening by the
16928 daemon. Sockets created by the smtp transport for delivering mail always set
16929 TCP_NODELAY.
16930
16931
16932 .option timeout_frozen_after main time 0s
16933 .cindex "frozen messages" "timing out"
16934 .cindex "timeout" "frozen messages"
16935 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16936 message of any kind that has been on the queue for longer than the given time
16937 is automatically cancelled at the next queue run. If the frozen message is a
16938 bounce message, it is just discarded; otherwise, a bounce is sent to the
16939 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16940 If you want to timeout frozen bounce messages earlier than other kinds of
16941 frozen message, see &%ignore_bounce_errors_after%&.
16942
16943 &*Note:*& the default value of zero means no timeouts; with this setting,
16944 frozen messages remain on the queue forever (except for any frozen bounce
16945 messages that are released by &%ignore_bounce_errors_after%&).
16946
16947
16948 .option timezone main string unset
16949 .cindex "timezone, setting"
16950 .cindex "environment" "values from"
16951 The value of &%timezone%& is used to set the environment variable TZ while
16952 running Exim (if it is different on entry). This ensures that all timestamps
16953 created by Exim are in the required timezone. If you want all your timestamps
16954 to be in UTC (aka GMT) you should set
16955 .code
16956 timezone = UTC
16957 .endd
16958 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16959 or, if that is not set, from the value of the TZ environment variable when Exim
16960 is built. If &%timezone%& is set to the empty string, either at build or run
16961 time, any existing TZ variable is removed from the environment when Exim
16962 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16963 unfortunately not all, operating systems.
16964
16965
16966 .option tls_advertise_hosts main "host list&!!" *
16967 .cindex "TLS" "advertising"
16968 .cindex "encryption" "on SMTP connection"
16969 .cindex "SMTP" "encrypted connection"
16970 When Exim is built with support for TLS encrypted connections, the availability
16971 of the STARTTLS command to set up an encrypted session is advertised in
16972 response to EHLO only to those client hosts that match this option. See
16973 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16974 Note that the default value requires that a certificate be supplied
16975 using the &%tls_certificate%& option.  If TLS support for incoming connections
16976 is not required the &%tls_advertise_hosts%& option should be set empty.
16977
16978
16979 .option tls_certificate main string&!! unset
16980 .cindex "TLS" "server certificate; location of"
16981 .cindex "certificate" "server, location of"
16982 The value of this option is expanded, and must then be the absolute path to a
16983 file which contains the server's certificates. The server's private key is also
16984 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16985 &<<CHAPTLS>>& for further details.
16986
16987 &*Note*&: The certificates defined by this option are used only when Exim is
16988 receiving incoming messages as a server. If you want to supply certificates for
16989 use when sending messages as a client, you must set the &%tls_certificate%&
16990 option in the relevant &(smtp)& transport.
16991
16992 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16993 if the OpenSSL build supports TLS extensions and the TLS client sends the
16994 Server Name Indication extension, then this option and others documented in
16995 &<<SECTtlssni>>& will be re-expanded.
16996
16997 .new
16998 If this option is unset or empty a fresh self-signed certificate will be
16999 generated for every connection.
17000 .wen
17001
17002 .option tls_crl main string&!! unset
17003 .cindex "TLS" "server certificate revocation list"
17004 .cindex "certificate" "revocation list for server"
17005 This option specifies a certificate revocation list. The expanded value must
17006 be the name of a file that contains a CRL in PEM format.
17007
17008 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17009
17010
17011 .option tls_dh_max_bits main integer 2236
17012 .cindex "TLS" "D-H bit count"
17013 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17014 the chosen TLS library.  That value might prove to be too high for
17015 interoperability.  This option provides a maximum clamp on the value
17016 suggested, trading off security for interoperability.
17017
17018 The value must be at least 1024.
17019
17020 The value 2236 was chosen because, at time of adding the option, it was the
17021 hard-coded maximum value supported by the NSS cryptographic library, as used
17022 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17023
17024 If you prefer more security and are willing to break some clients, raise this
17025 number.
17026
17027 Note that the value passed to GnuTLS for *generating* a new prime may be a
17028 little less than this figure, because GnuTLS is inexact and may produce a
17029 larger prime than requested.
17030
17031
17032 .option tls_dhparam main string&!! unset
17033 .cindex "TLS" "D-H parameters for server"
17034 The value of this option is expanded and indicates the source of DH parameters
17035 to be used by Exim.
17036
17037 If it is a filename starting with a &`/`&, then it names a file from which DH
17038 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17039 PKCS#3 representation of the DH prime.  If the file does not exist, for
17040 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17041 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17042 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17043 and treated as though the &%tls_dhparam%& were set to "none".
17044
17045 If this option expands to the string "none", then no DH parameters will be
17046 loaded by Exim.
17047
17048 If this option expands to the string "historic" and Exim is using GnuTLS, then
17049 Exim will attempt to load a file from inside the spool directory.  If the file
17050 does not exist, Exim will attempt to create it.
17051 See section &<<SECTgnutlsparam>>& for further details.
17052
17053 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17054 a default DH prime; the default is the 2048 bit prime described in section
17055 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17056 in IKE is assigned number 23.
17057
17058 Otherwise, the option must expand to the name used by Exim for any of a number
17059 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
17060 "ike" followed by the number used by IKE, or "default" which corresponds to
17061 "ike23".
17062
17063 The available primes are:
17064 &`ike1`&, &`ike2`&, &`ike5`&,
17065 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17066 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
17067
17068 Some of these will be too small to be accepted by clients.
17069 Some may be too large to be accepted by clients.
17070
17071 The TLS protocol does not negotiate an acceptable size for this; clients tend
17072 to hard-drop connections if what is offered by the server is unacceptable,
17073 whether too large or too small, and there's no provision for the client to
17074 tell the server what these constraints are.  Thus, as a server operator, you
17075 need to make an educated guess as to what is most likely to work for your
17076 userbase.
17077
17078 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17079 is most likely to maximise interoperability.  The upper bound comes from
17080 applications using the Mozilla Network Security Services (NSS) library, which
17081 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17082 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17083 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17084 acceptable bound from 1024 to 2048.
17085
17086
17087 .option tls_eccurve main string&!! prime256v1
17088 .cindex TLS "EC cryptography"
17089 If built with a recent-enough version of OpenSSL,
17090 this option selects a EC curve for use by Exim.
17091
17092 Curve names of the form &'prime256v1'& are accepted.
17093 For even more-recent library versions, names of the form &'P-512'&
17094 are also accepted, plus the special value &'auto'&
17095 which tells the library to choose.
17096
17097 If the option is set to an empty string, no EC curves will be enabled.
17098
17099
17100 .option tls_ocsp_file main string&!! unset
17101 .cindex TLS "certificate status"
17102 .cindex TLS "OCSP proof file"
17103 This option
17104 must if set expand to the absolute path to a file which contains a current
17105 status proof for the server's certificate, as obtained from the
17106 Certificate Authority.
17107
17108 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17109
17110
17111 .option tls_on_connect_ports main "string list" unset
17112 .cindex SSMTP
17113 .cindex SMTPS
17114 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17115 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17116 set up without waiting for the client to issue a STARTTLS command. For
17117 further details, see section &<<SECTsupobssmt>>&.
17118
17119
17120
17121 .option tls_privatekey main string&!! unset
17122 .cindex "TLS" "server private key; location of"
17123 The value of this option is expanded, and must then be the absolute path to a
17124 file which contains the server's private key. If this option is unset, or if
17125 the expansion is forced to fail, or the result is an empty string, the private
17126 key is assumed to be in the same file as the server's certificates. See chapter
17127 &<<CHAPTLS>>& for further details.
17128
17129 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17130
17131
17132 .option tls_remember_esmtp main boolean false
17133 .cindex "TLS" "esmtp state; remembering"
17134 .cindex "TLS" "broken clients"
17135 If this option is set true, Exim violates the RFCs by remembering that it is in
17136 &"esmtp"& state after successfully negotiating a TLS session. This provides
17137 support for broken clients that fail to send a new EHLO after starting a
17138 TLS session.
17139
17140
17141 .option tls_require_ciphers main string&!! unset
17142 .cindex "TLS" "requiring specific ciphers"
17143 .cindex "cipher" "requiring specific"
17144 This option controls which ciphers can be used for incoming TLS connections.
17145 The &(smtp)& transport has an option of the same name for controlling outgoing
17146 connections. This option is expanded for each connection, so can be varied for
17147 different clients if required. The value of this option must be a list of
17148 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17149 in somewhat different ways. If GnuTLS is being used, the client controls the
17150 preference order of the available ciphers. Details are given in sections
17151 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17152
17153
17154 .option tls_try_verify_hosts main "host list&!!" unset
17155 .cindex "TLS" "client certificate verification"
17156 .cindex "certificate" "verification of client"
17157 See &%tls_verify_hosts%& below.
17158
17159
17160 .option tls_verify_certificates main string&!! system
17161 .cindex "TLS" "client certificate verification"
17162 .cindex "certificate" "verification of client"
17163 The value of this option is expanded, and must then be either the
17164 word "system"
17165 or the absolute path to
17166 a file or directory containing permitted certificates for clients that
17167 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17168
17169 The "system" value for the option will use a
17170 system default location compiled into the SSL library.
17171 This is not available for GnuTLS versions preceding 3.0.20,
17172 and will be taken as empty; an explicit location
17173 must be specified.
17174
17175 The use of a directory for the option value is not available for GnuTLS versions
17176 preceding 3.3.6 and a single file must be used.
17177
17178 With OpenSSL the certificates specified
17179 explicitly
17180 either by file or directory
17181 are added to those given by the system default location.
17182
17183 These certificates should be for the certificate authorities trusted, rather
17184 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17185 the value is a file then the certificates are sent by Exim as a server to
17186 connecting clients, defining the list of accepted certificate authorities.
17187 Thus the values defined should be considered public data.  To avoid this,
17188 use the explicit directory version.
17189
17190 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17191
17192 A forced expansion failure or setting to an empty string is equivalent to
17193 being unset.
17194
17195
17196 .option tls_verify_hosts main "host list&!!" unset
17197 .cindex "TLS" "client certificate verification"
17198 .cindex "certificate" "verification of client"
17199 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17200 certificates from clients. The expected certificates are defined by
17201 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17202 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17203 &%tls_verify_certificates%& is not set.
17204
17205 Any client that matches &%tls_verify_hosts%& is constrained by
17206 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17207 present one of the listed certificates. If it does not, the connection is
17208 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17209 the host to use TLS. It can still send SMTP commands through unencrypted
17210 connections. Forcing a client to use TLS has to be done separately using an
17211 ACL to reject inappropriate commands when the connection is not encrypted.
17212
17213 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17214 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17215 certificate and checks it against &%tls_verify_certificates%&, but does not
17216 abort the connection if there is no certificate or if it does not match. This
17217 state can be detected in an ACL, which makes it possible to implement policies
17218 such as &"accept for relay only if a verified certificate has been received,
17219 but accept for local delivery if encrypted, even without a verified
17220 certificate"&.
17221
17222 Client hosts that match neither of these lists are not asked to present
17223 certificates.
17224
17225
17226 .option trusted_groups main "string list&!!" unset
17227 .cindex "trusted groups"
17228 .cindex "groups" "trusted"
17229 This option is expanded just once, at the start of Exim's processing. If this
17230 option is set, any process that is running in one of the listed groups, or
17231 which has one of them as a supplementary group, is trusted. The groups can be
17232 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17233 details of what trusted callers are permitted to do. If neither
17234 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17235 are trusted.
17236
17237 .option trusted_users main "string list&!!" unset
17238 .cindex "trusted users"
17239 .cindex "user" "trusted"
17240 This option is expanded just once, at the start of Exim's processing. If this
17241 option is set, any process that is running as one of the listed users is
17242 trusted. The users can be specified numerically or by name. See section
17243 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17244 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17245 Exim user are trusted.
17246
17247 .option unknown_login main string&!! unset
17248 .cindex "uid (user id)" "unknown caller"
17249 .vindex "&$caller_uid$&"
17250 This is a specialized feature for use in unusual configurations. By default, if
17251 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17252 gives up. The &%unknown_login%& option can be used to set a login name to be
17253 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17254 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17255 is used for the user's real name (gecos field), unless this has been set by the
17256 &%-F%& option.
17257
17258 .option unknown_username main string unset
17259 See &%unknown_login%&.
17260
17261 .option untrusted_set_sender main "address list&!!" unset
17262 .cindex "trusted users"
17263 .cindex "sender" "setting by untrusted user"
17264 .cindex "untrusted user setting sender"
17265 .cindex "user" "untrusted setting sender"
17266 .cindex "envelope sender"
17267 When an untrusted user submits a message to Exim using the standard input, Exim
17268 normally creates an envelope sender address from the user's login and the
17269 default qualification domain. Data from the &%-f%& option (for setting envelope
17270 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17271 is used) is ignored.
17272
17273 However, untrusted users are permitted to set an empty envelope sender address,
17274 to declare that a message should never generate any bounces. For example:
17275 .code
17276 exim -f '<>' user@domain.example
17277 .endd
17278 .vindex "&$sender_ident$&"
17279 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17280 other envelope sender addresses in a controlled way. When it is set, untrusted
17281 users are allowed to set envelope sender addresses that match any of the
17282 patterns in the list. Like all address lists, the string is expanded. The
17283 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17284 users to setting senders that start with their login ids
17285 followed by a hyphen
17286 by a setting like this:
17287 .code
17288 untrusted_set_sender = ^$sender_ident-
17289 .endd
17290 If you want to allow untrusted users to set envelope sender addresses without
17291 restriction, you can use
17292 .code
17293 untrusted_set_sender = *
17294 .endd
17295 The &%untrusted_set_sender%& option applies to all forms of local input, but
17296 only to the setting of the envelope sender. It does not permit untrusted users
17297 to use the other options which trusted user can use to override message
17298 parameters. Furthermore, it does not stop Exim from removing an existing
17299 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17300 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17301 overriding these actions. The handling of the &'Sender:'& header is also
17302 described in section &<<SECTthesenhea>>&.
17303
17304 The log line for a message's arrival shows the envelope sender following
17305 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17306 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17307 envelope sender address, the user's login is shown in parentheses after the
17308 sender address.
17309
17310
17311 .option uucp_from_pattern main string "see below"
17312 .cindex "&""From""& line"
17313 .cindex "UUCP" "&""From""& line"
17314 Some applications that pass messages to an MTA via a command line interface use
17315 an initial line starting with &"From&~"& to pass the envelope sender. In
17316 particular, this is used by UUCP software. Exim recognizes such a line by means
17317 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17318 matches, the sender address is constructed by expanding the contents of
17319 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17320 default pattern recognizes lines in the following two forms:
17321 .code
17322 From ph10 Fri Jan  5 12:35 GMT 1996
17323 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17324 .endd
17325 The pattern can be seen by running
17326 .code
17327 exim -bP uucp_from_pattern
17328 .endd
17329 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17330 year in the second case. The first word after &"From&~"& is matched in the
17331 regular expression by a parenthesized subpattern. The default value for
17332 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17333 (&"ph10"& in the example above) as the message's sender. See also
17334 &%ignore_fromline_hosts%&.
17335
17336
17337 .option uucp_from_sender main string&!! &`$1`&
17338 See &%uucp_from_pattern%& above.
17339
17340
17341 .option warn_message_file main string unset
17342 .cindex "warning of delay" "customizing the message"
17343 .cindex "customizing" "warning message"
17344 This option defines a template file containing paragraphs of text to be used
17345 for constructing the warning message which is sent by Exim when a message has
17346 been on the queue for a specified amount of time, as specified by
17347 &%delay_warning%&. Details of the file's contents are given in chapter
17348 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17349
17350
17351 .option write_rejectlog main boolean true
17352 .cindex "reject log" "disabling"
17353 If this option is set false, Exim no longer writes anything to the reject log.
17354 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17355 .ecindex IIDconfima
17356 .ecindex IIDmaiconf
17357
17358
17359
17360
17361 . ////////////////////////////////////////////////////////////////////////////
17362 . ////////////////////////////////////////////////////////////////////////////
17363
17364 .chapter "Generic options for routers" "CHAProutergeneric"
17365 .scindex IIDgenoprou1 "options" "generic; for routers"
17366 .scindex IIDgenoprou2 "generic options" "router"
17367 This chapter describes the generic options that apply to all routers.
17368 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17369
17370 For a general description of how a router operates, see sections
17371 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17372 which the preconditions are tested. The order of expansion of the options that
17373 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17374 &%headers_remove%&, &%transport%&.
17375
17376
17377
17378 .option address_data routers string&!! unset
17379 .cindex "router" "data attached to address"
17380 The string is expanded just before the router is run, that is, after all the
17381 precondition tests have succeeded. If the expansion is forced to fail, the
17382 router declines, the value of &%address_data%& remains unchanged, and the
17383 &%more%& option controls what happens next. Other expansion failures cause
17384 delivery of the address to be deferred.
17385
17386 .vindex "&$address_data$&"
17387 When the expansion succeeds, the value is retained with the address, and can be
17388 accessed using the variable &$address_data$& in the current router, subsequent
17389 routers, and the eventual transport.
17390
17391 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17392 that runs a user's filter file, the contents of &$address_data$& are accessible
17393 in the filter. This is not normally a problem, because such data is usually
17394 either not confidential or it &"belongs"& to the current user, but if you do
17395 put confidential data into &$address_data$& you need to remember this point.
17396
17397 Even if the router declines or passes, the value of &$address_data$& remains
17398 with the address, though it can be changed by another &%address_data%& setting
17399 on a subsequent router. If a router generates child addresses, the value of
17400 &$address_data$& propagates to them. This also applies to the special kind of
17401 &"child"& that is generated by a router with the &%unseen%& option.
17402
17403 The idea of &%address_data%& is that you can use it to look up a lot of data
17404 for the address once, and then pick out parts of the data later. For example,
17405 you could use a single LDAP lookup to return a string of the form
17406 .code
17407 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17408 .endd
17409 In the transport you could pick out the mailbox by a setting such as
17410 .code
17411 file = ${extract{mailbox}{$address_data}}
17412 .endd
17413 This makes the configuration file less messy, and also reduces the number of
17414 lookups (though Exim does cache lookups).
17415
17416 .vindex "&$sender_address_data$&"
17417 .vindex "&$address_data$&"
17418 The &%address_data%& facility is also useful as a means of passing information
17419 from one router to another, and from a router to a transport. In addition, if
17420 &$address_data$& is set by a router when verifying a recipient address from an
17421 ACL, it remains available for use in the rest of the ACL statement. After
17422 verifying a sender, the value is transferred to &$sender_address_data$&.
17423
17424
17425
17426 .option address_test routers&!? boolean true
17427 .oindex "&%-bt%&"
17428 .cindex "router" "skipping when address testing"
17429 If this option is set false, the router is skipped when routing is being tested
17430 by means of the &%-bt%& command line option. This can be a convenience when
17431 your first router sends messages to an external scanner, because it saves you
17432 having to set the &"already scanned"& indicator when testing real address
17433 routing.
17434
17435
17436
17437 .option cannot_route_message routers string&!! unset
17438 .cindex "router" "customizing &""cannot route""& message"
17439 .cindex "customizing" "&""cannot route""& message"
17440 This option specifies a text message that is used when an address cannot be
17441 routed because Exim has run out of routers. The default message is
17442 &"Unrouteable address"&. This option is useful only on routers that have
17443 &%more%& set false, or on the very last router in a configuration, because the
17444 value that is used is taken from the last router that is considered. This
17445 includes a router that is skipped because its preconditions are not met, as
17446 well as a router that declines. For example, using the default configuration,
17447 you could put:
17448 .code
17449 cannot_route_message = Remote domain not found in DNS
17450 .endd
17451 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17452 and
17453 .code
17454 cannot_route_message = Unknown local user
17455 .endd
17456 on the final router that checks for local users. If string expansion fails for
17457 this option, the default message is used. Unless the expansion failure was
17458 explicitly forced, a message about the failure is written to the main and panic
17459 logs, in addition to the normal message about the routing failure.
17460
17461
17462 .option caseful_local_part routers boolean false
17463 .cindex "case of local parts"
17464 .cindex "router" "case of local parts"
17465 By default, routers handle the local parts of addresses in a case-insensitive
17466 manner, though the actual case is preserved for transmission with the message.
17467 If you want the case of letters to be significant in a router, you must set
17468 this option true. For individual router options that contain address or local
17469 part lists (for example, &%local_parts%&), case-sensitive matching can be
17470 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17471 more details.
17472
17473 .vindex "&$local_part$&"
17474 .vindex "&$original_local_part$&"
17475 .vindex "&$parent_local_part$&"
17476 The value of the &$local_part$& variable is forced to lower case while a
17477 router is running unless &%caseful_local_part%& is set. When a router assigns
17478 an address to a transport, the value of &$local_part$& when the transport runs
17479 is the same as it was in the router. Similarly, when a router generates child
17480 addresses by aliasing or forwarding, the values of &$original_local_part$&
17481 and &$parent_local_part$& are those that were used by the redirecting router.
17482
17483 This option applies to the processing of an address by a router. When a
17484 recipient address is being processed in an ACL, there is a separate &%control%&
17485 modifier that can be used to specify case-sensitive processing within the ACL
17486 (see section &<<SECTcontrols>>&).
17487
17488
17489
17490 .option check_local_user routers&!? boolean false
17491 .cindex "local user, checking in router"
17492 .cindex "router" "checking for local user"
17493 .cindex "&_/etc/passwd_&"
17494 .vindex "&$home$&"
17495 When this option is true, Exim checks that the local part of the recipient
17496 address (with affixes removed if relevant) is the name of an account on the
17497 local system. The check is done by calling the &[getpwnam()]& function rather
17498 than trying to read &_/etc/passwd_& directly. This means that other methods of
17499 holding password data (such as NIS) are supported. If the local part is a local
17500 user, &$home$& is set from the password data, and can be tested in other
17501 preconditions that are evaluated after this one (the order of evaluation is
17502 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17503 overridden by &%router_home_directory%&. If the local part is not a local user,
17504 the router is skipped.
17505
17506 If you want to check that the local part is either the name of a local user
17507 or matches something else, you cannot combine &%check_local_user%& with a
17508 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17509 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17510 setting to achieve this. For example:
17511 .code
17512 local_parts = passwd;$local_part : lsearch;/etc/other/users
17513 .endd
17514 Note, however, that the side effects of &%check_local_user%& (such as setting
17515 up a home directory) do not occur when a &(passwd)& lookup is used in a
17516 &%local_parts%& (or any other) precondition.
17517
17518
17519
17520 .option condition routers&!? string&!! unset
17521 .cindex "router" "customized precondition"
17522 This option specifies a general precondition test that has to succeed for the
17523 router to be called. The &%condition%& option is the last precondition to be
17524 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17525 result is a forced failure, or an empty string, or one of the strings &"0"& or
17526 &"no"& or &"false"& (checked without regard to the case of the letters), the
17527 router is skipped, and the address is offered to the next one.
17528
17529 If the result is any other value, the router is run (as this is the last
17530 precondition to be evaluated, all the other preconditions must be true).
17531
17532 This option is unusual in that multiple &%condition%& options may be present.
17533 All &%condition%& options must succeed.
17534
17535 The &%condition%& option provides a means of applying custom conditions to the
17536 running of routers. Note that in the case of a simple conditional expansion,
17537 the default expansion values are exactly what is wanted. For example:
17538 .code
17539 condition = ${if >{$message_age}{600}}
17540 .endd
17541 Because of the default behaviour of the string expansion, this is equivalent to
17542 .code
17543 condition = ${if >{$message_age}{600}{true}{}}
17544 .endd
17545
17546 A multiple condition example, which succeeds:
17547 .code
17548 condition = ${if >{$message_age}{600}}
17549 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17550 condition = foobar
17551 .endd
17552
17553 If the expansion fails (other than forced failure) delivery is deferred. Some
17554 of the other precondition options are common special cases that could in fact
17555 be specified using &%condition%&.
17556
17557 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17558 are far older, and use one set of semantics.  ACLs are newer and when
17559 they were created, the ACL &%condition%& process was given far stricter
17560 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17561 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17562 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17563 Router rules processing behavior.
17564
17565 This is best illustrated in an example:
17566 .code
17567 # If used in an ACL condition will fail with a syntax error, but
17568 # in a router condition any extra characters are treated as a string
17569
17570 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17571 true {yes} {no}}
17572
17573 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17574  {yes} {no}}
17575 .endd
17576 In each example above, the &%if%& statement actually ends after
17577 &"{google.com}}"&.  Since no true or false braces were defined, the
17578 default &%if%& behavior is to return a boolean true or a null answer
17579 (which evaluates to false). The rest of the line is then treated as a
17580 string. So the first example resulted in the boolean answer &"true"&
17581 with the string &" {yes} {no}}"& appended to it. The second example
17582 resulted in the null output (indicating false) with the string
17583 &" {yes} {no}}"& appended to it.
17584
17585 In fact you can put excess forward braces in too.  In the router
17586 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17587 mean something, like after a &"$"& or when required as part of a
17588 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17589 string characters.
17590
17591 Thus, in a Router, the above expansion strings will both always evaluate
17592 true, as the result of expansion is a non-empty string which doesn't
17593 match an explicit false value.  This can be tricky to debug.  By
17594 contrast, in an ACL either of those strings will always result in an
17595 expansion error because the result doesn't look sufficiently boolean.
17596
17597
17598 .option debug_print routers string&!! unset
17599 .cindex "testing" "variables in drivers"
17600 If this option is set and debugging is enabled (see the &%-d%& command line
17601 option) or in address-testing mode (see the &%-bt%& command line option),
17602 the string is expanded and included in the debugging output.
17603 If expansion of the string fails, the error message is written to the debugging
17604 output, and Exim carries on processing.
17605 This option is provided to help with checking out the values of variables and
17606 so on when debugging router configurations. For example, if a &%condition%&
17607 option appears not to be working, &%debug_print%& can be used to output the
17608 variables it references. The output happens after checks for &%domains%&,
17609 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17610 are tested. A newline is added to the text if it does not end with one.
17611 The variable &$router_name$& contains the name of the router.
17612
17613
17614
17615 .option disable_logging routers boolean false
17616 If this option is set true, nothing is logged for any routing errors
17617 or for any deliveries caused by this router. You should not set this option
17618 unless you really, really know what you are doing. See also the generic
17619 transport option of the same name.
17620
17621 .option dnssec_request_domains routers "domain list&!!" unset
17622 .cindex "MX record" "security"
17623 .cindex "DNSSEC" "MX lookup"
17624 .cindex "security" "MX lookup"
17625 .cindex "DNS" "DNSSEC"
17626 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17627 the dnssec request bit set.
17628 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17629
17630 .option dnssec_require_domains routers "domain list&!!" unset
17631 .cindex "MX record" "security"
17632 .cindex "DNSSEC" "MX lookup"
17633 .cindex "security" "MX lookup"
17634 .cindex "DNS" "DNSSEC"
17635 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17636 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17637 (AD bit) set will be ignored and logged as a host-lookup failure.
17638 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17639
17640
17641 .option domains routers&!? "domain list&!!" unset
17642 .cindex "router" "restricting to specific domains"
17643 .vindex "&$domain_data$&"
17644 If this option is set, the router is skipped unless the current domain matches
17645 the list. If the match is achieved by means of a file lookup, the data that the
17646 lookup returned for the domain is placed in &$domain_data$& for use in string
17647 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17648 a list of the order in which preconditions are evaluated.
17649
17650
17651
17652 .option driver routers string unset
17653 This option must always be set. It specifies which of the available routers is
17654 to be used.
17655
17656
17657 .option dsn_lasthop routers boolean false
17658 .cindex "DSN" "success"
17659 .cindex "Delivery Status Notification" "success"
17660 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17661 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17662 instead send a success DSN as if the next hop does not support DSN.
17663 Not effective on redirect routers.
17664
17665
17666
17667 .option errors_to routers string&!! unset
17668 .cindex "envelope sender"
17669 .cindex "router" "changing address for errors"
17670 If a router successfully handles an address, it may assign the address to a
17671 transport for delivery or it may generate child addresses. In both cases, if
17672 there is a delivery problem during later processing, the resulting bounce
17673 message is sent to the address that results from expanding this string,
17674 provided that the address verifies successfully. The &%errors_to%& option is
17675 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17676
17677 The &%errors_to%& setting associated with an address can be overridden if it
17678 subsequently passes through other routers that have their own &%errors_to%&
17679 settings, or if the message is delivered by a transport with a &%return_path%&
17680 setting.
17681
17682 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17683 the expansion fails to verify, the errors address associated with the incoming
17684 address is used. At top level, this is the envelope sender. A non-forced
17685 expansion failure causes delivery to be deferred.
17686
17687 If an address for which &%errors_to%& has been set ends up being delivered over
17688 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17689 any bounces that are generated by other MTAs on the delivery route are also
17690 sent there. You can set &%errors_to%& to the empty string by either of these
17691 settings:
17692 .code
17693 errors_to =
17694 errors_to = ""
17695 .endd
17696 An expansion item that yields an empty string has the same effect. If you do
17697 this, a locally detected delivery error for addresses processed by this router
17698 no longer gives rise to a bounce message; the error is discarded. If the
17699 address is delivered to a remote host, the return path is set to &`<>`&, unless
17700 overridden by the &%return_path%& option on the transport.
17701
17702 .vindex "&$address_data$&"
17703 If for some reason you want to discard local errors, but use a non-empty
17704 MAIL command for remote delivery, you can preserve the original return
17705 path in &$address_data$& in the router, and reinstate it in the transport by
17706 setting &%return_path%&.
17707
17708 The most common use of &%errors_to%& is to direct mailing list bounces to the
17709 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17710 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17711
17712
17713
17714 .option expn routers&!? boolean true
17715 .cindex "address" "testing"
17716 .cindex "testing" "addresses"
17717 .cindex "EXPN" "router skipping"
17718 .cindex "router" "skipping for EXPN"
17719 If this option is turned off, the router is skipped when testing an address
17720 as a result of processing an SMTP EXPN command. You might, for example,
17721 want to turn it off on a router for users' &_.forward_& files, while leaving it
17722 on for the system alias file.
17723 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17724 are evaluated.
17725
17726 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17727 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17728 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17729
17730
17731
17732 .option fail_verify routers boolean false
17733 .cindex "router" "forcing verification failure"
17734 Setting this option has the effect of setting both &%fail_verify_sender%& and
17735 &%fail_verify_recipient%& to the same value.
17736
17737
17738
17739 .option fail_verify_recipient routers boolean false
17740 If this option is true and an address is accepted by this router when
17741 verifying a recipient, verification fails.
17742
17743
17744
17745 .option fail_verify_sender routers boolean false
17746 If this option is true and an address is accepted by this router when
17747 verifying a sender, verification fails.
17748
17749
17750
17751 .option fallback_hosts routers "string list" unset
17752 .cindex "router" "fallback hosts"
17753 .cindex "fallback" "hosts specified on router"
17754 String expansion is not applied to this option. The argument must be a
17755 colon-separated list of host names or IP addresses. The list separator can be
17756 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17757 each name or address. In fact, the format of each item is exactly the same as
17758 defined for the list of hosts in a &(manualroute)& router (see section
17759 &<<SECTformatonehostitem>>&).
17760
17761 If a router queues an address for a remote transport, this host list is
17762 associated with the address, and used instead of the transport's fallback host
17763 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17764 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17765 transport for further details.
17766
17767
17768 .option group routers string&!! "see below"
17769 .cindex "gid (group id)" "local delivery"
17770 .cindex "local transports" "uid and gid"
17771 .cindex "transport" "local"
17772 .cindex "router" "setting group"
17773 When a router queues an address for a transport, and the transport does not
17774 specify a group, the group given here is used when running the delivery
17775 process.
17776 The group may be specified numerically or by name. If expansion fails, the
17777 error is logged and delivery is deferred.
17778 The default is unset, unless &%check_local_user%& is set, when the default
17779 is taken from the password information. See also &%initgroups%& and &%user%&
17780 and the discussion in chapter &<<CHAPenvironment>>&.
17781
17782
17783
17784 .option headers_add routers list&!! unset
17785 .cindex "header lines" "adding"
17786 .cindex "router" "adding header lines"
17787 This option specifies a list of text headers,
17788 newline-separated (by default, changeable in the usual way),
17789 that is associated with any addresses that are accepted by the router.
17790 Each item is separately expanded, at routing time.  However, this
17791 option has no effect when an address is just being verified. The way in which
17792 the text is used to add header lines at transport time is described in section
17793 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17794 message is in the process of being transported. This means that references to
17795 header lines in string expansions in the transport's configuration do not
17796 &"see"& the added header lines.
17797
17798 The &%headers_add%& option is expanded after &%errors_to%&, but before
17799 &%headers_remove%& and &%transport%&. If an item is empty, or if
17800 an item expansion is forced to fail, the item has no effect. Other expansion
17801 failures are treated as configuration errors.
17802
17803 Unlike most options, &%headers_add%& can be specified multiple times
17804 for a router; all listed headers are added.
17805
17806 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17807 router that has the &%one_time%& option set.
17808
17809 .cindex "duplicate addresses"
17810 .oindex "&%unseen%&"
17811 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17812 additions are deleted when the address is passed on to subsequent routers.
17813 For a &%redirect%& router, if a generated address is the same as the incoming
17814 address, this can lead to duplicate addresses with different header
17815 modifications. Exim does not do duplicate deliveries (except, in certain
17816 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17817 which of the duplicates is discarded, so this ambiguous situation should be
17818 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17819
17820
17821
17822 .option headers_remove routers list&!! unset
17823 .cindex "header lines" "removing"
17824 .cindex "router" "removing header lines"
17825 This option specifies a list of text headers,
17826 colon-separated (by default, changeable in the usual way),
17827 that is associated with any addresses that are accepted by the router.
17828 Each item is separately expanded, at routing time.  However, this
17829 option has no effect when an address is just being verified. The way in which
17830 the text is used to remove header lines at transport time is described in
17831 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17832 the message is in the process of being transported. This means that references
17833 to header lines in string expansions in the transport's configuration still
17834 &"see"& the original header lines.
17835
17836 The &%headers_remove%& option is expanded after &%errors_to%& and
17837 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17838 the item has no effect. Other expansion failures are treated as configuration
17839 errors.
17840
17841 Unlike most options, &%headers_remove%& can be specified multiple times
17842 for a router; all listed headers are removed.
17843
17844 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17845 router that has the &%one_time%& option set.
17846
17847 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17848 removal requests are deleted when the address is passed on to subsequent
17849 routers, and this can lead to problems with duplicates -- see the similar
17850 warning for &%headers_add%& above.
17851
17852 &*Warning 3*&: Because of the separate expansion of the list items,
17853 items that contain a list separator must have it doubled.
17854 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17855
17856
17857
17858 .option ignore_target_hosts routers "host list&!!" unset
17859 .cindex "IP address" "discarding"
17860 .cindex "router" "discarding IP addresses"
17861 Although this option is a host list, it should normally contain IP address
17862 entries rather than names. If any host that is looked up by the router has an
17863 IP address that matches an item in this list, Exim behaves as if that IP
17864 address did not exist. This option allows you to cope with rogue DNS entries
17865 like
17866 .code
17867 remote.domain.example.  A  127.0.0.1
17868 .endd
17869 by setting
17870 .code
17871 ignore_target_hosts = 127.0.0.1
17872 .endd
17873 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17874 discarded in this way, the router declines. In a conventional configuration, an
17875 attempt to mail to such a domain would normally provoke the &"unrouteable
17876 domain"& error, and an attempt to verify an address in the domain would fail.
17877 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17878 router declines if presented with one of the listed addresses.
17879
17880 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17881 means of the first or the second of the following settings, respectively:
17882 .code
17883 ignore_target_hosts = 0.0.0.0/0
17884 ignore_target_hosts = <; 0::0/0
17885 .endd
17886 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17887 in the second line matches all IPv6 addresses.
17888
17889 This option may also be useful for ignoring link-local and site-local IPv6
17890 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17891 is expanded before use as a list, it is possible to make it dependent on the
17892 domain that is being routed.
17893
17894 .vindex "&$host_address$&"
17895 During its expansion, &$host_address$& is set to the IP address that is being
17896 checked.
17897
17898 .option initgroups routers boolean false
17899 .cindex "additional groups"
17900 .cindex "groups" "additional"
17901 .cindex "local transports" "uid and gid"
17902 .cindex "transport" "local"
17903 If the router queues an address for a transport, and this option is true, and
17904 the uid supplied by the router is not overridden by the transport, the
17905 &[initgroups()]& function is called when running the transport to ensure that
17906 any additional groups associated with the uid are set up. See also &%group%&
17907 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17908
17909
17910
17911 .option local_part_prefix routers&!? "string list" unset
17912 .cindex "router" "prefix for local part"
17913 .cindex "prefix" "for local part, used in router"
17914 If this option is set, the router is skipped unless the local part starts with
17915 one of the given strings, or &%local_part_prefix_optional%& is true. See
17916 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17917 evaluated.
17918
17919 The list is scanned from left to right, and the first prefix that matches is
17920 used. A limited form of wildcard is available; if the prefix begins with an
17921 asterisk, it matches the longest possible sequence of arbitrary characters at
17922 the start of the local part. An asterisk should therefore always be followed by
17923 some character that does not occur in normal local parts.
17924 .cindex "multiple mailboxes"
17925 .cindex "mailbox" "multiple"
17926 Wildcarding can be used to set up multiple user mailboxes, as described in
17927 section &<<SECTmulbox>>&.
17928
17929 .vindex "&$local_part$&"
17930 .vindex "&$local_part_prefix$&"
17931 During the testing of the &%local_parts%& option, and while the router is
17932 running, the prefix is removed from the local part, and is available in the
17933 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17934 the router accepts the address, this remains true during subsequent delivery by
17935 a transport. In particular, the local part that is transmitted in the RCPT
17936 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17937 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17938 the relevant transport.
17939
17940 When an address is being verified, &%local_part_prefix%& affects only the
17941 behaviour of the router. If the callout feature of verification is in use, this
17942 means that the full address, including the prefix, will be used during the
17943 callout.
17944
17945 The prefix facility is commonly used to handle local parts of the form
17946 &%owner-something%&. Another common use is to support local parts of the form
17947 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17948 to tell a user their forwarding is broken &-- by placing a router like this one
17949 immediately before the router that handles &_.forward_& files:
17950 .code
17951 real_localuser:
17952   driver = accept
17953   local_part_prefix = real-
17954   check_local_user
17955   transport = local_delivery
17956 .endd
17957 For security, it would probably be a good idea to restrict the use of this
17958 router to locally-generated messages, using a condition such as this:
17959 .code
17960   condition = ${if match {$sender_host_address}\
17961                          {\N^(|127\.0\.0\.1)$\N}}
17962 .endd
17963
17964 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17965 both conditions must be met if not optional. Care must be taken if wildcards
17966 are used in both a prefix and a suffix on the same router. Different
17967 separator characters must be used to avoid ambiguity.
17968
17969
17970 .option local_part_prefix_optional routers boolean false
17971 See &%local_part_prefix%& above.
17972
17973
17974
17975 .option local_part_suffix routers&!? "string list" unset
17976 .cindex "router" "suffix for local part"
17977 .cindex "suffix for local part" "used in router"
17978 This option operates in the same way as &%local_part_prefix%&, except that the
17979 local part must end (rather than start) with the given string, the
17980 &%local_part_suffix_optional%& option determines whether the suffix is
17981 mandatory, and the wildcard * character, if present, must be the last
17982 character of the suffix. This option facility is commonly used to handle local
17983 parts of the form &%something-request%& and multiple user mailboxes of the form
17984 &%username-foo%&.
17985
17986
17987 .option local_part_suffix_optional routers boolean false
17988 See &%local_part_suffix%& above.
17989
17990
17991
17992 .option local_parts routers&!? "local part list&!!" unset
17993 .cindex "router" "restricting to specific local parts"
17994 .cindex "local part" "checking in router"
17995 The router is run only if the local part of the address matches the list.
17996 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17997 are evaluated, and
17998 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17999 string is expanded, it is possible to make it depend on the domain, for
18000 example:
18001 .code
18002 local_parts = dbm;/usr/local/specials/$domain
18003 .endd
18004 .vindex "&$local_part_data$&"
18005 If the match is achieved by a lookup, the data that the lookup returned
18006 for the local part is placed in the variable &$local_part_data$& for use in
18007 expansions of the router's private options. You might use this option, for
18008 example, if you have a large number of local virtual domains, and you want to
18009 send all postmaster mail to the same place without having to set up an alias in
18010 each virtual domain:
18011 .code
18012 postmaster:
18013   driver = redirect
18014   local_parts = postmaster
18015   data = postmaster@real.domain.example
18016 .endd
18017
18018
18019 .option log_as_local routers boolean "see below"
18020 .cindex "log" "delivery line"
18021 .cindex "delivery" "log line format"
18022 Exim has two logging styles for delivery, the idea being to make local
18023 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18024 recipient address is given just as the local part, without a domain. The use of
18025 this style is controlled by this option. It defaults to true for the &(accept)&
18026 router, and false for all the others. This option applies only when a
18027 router assigns an address to a transport. It has no effect on routers that
18028 redirect addresses.
18029
18030
18031
18032 .option more routers boolean&!! true
18033 The result of string expansion for this option must be a valid boolean value,
18034 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18035 result causes an error, and delivery is deferred. If the expansion is forced to
18036 fail, the default value for the option (true) is used. Other failures cause
18037 delivery to be deferred.
18038
18039 If this option is set false, and the router declines to handle the address, no
18040 further routers are tried, routing fails, and the address is bounced.
18041 .oindex "&%self%&"
18042 However, if the router explicitly passes an address to the following router by
18043 means of the setting
18044 .code
18045 self = pass
18046 .endd
18047 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18048 does not affect the behaviour if one of the precondition tests fails. In that
18049 case, the address is always passed to the next router.
18050
18051 Note that &%address_data%& is not considered to be a precondition. If its
18052 expansion is forced to fail, the router declines, and the value of &%more%&
18053 controls what happens next.
18054
18055
18056 .option pass_on_timeout routers boolean false
18057 .cindex "timeout" "of router"
18058 .cindex "router" "timeout"
18059 If a router times out during a host lookup, it normally causes deferral of the
18060 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18061 router, overriding &%no_more%&. This may be helpful for systems that are
18062 intermittently connected to the Internet, or those that want to pass to a smart
18063 host any messages that cannot immediately be delivered.
18064
18065 There are occasional other temporary errors that can occur while doing DNS
18066 lookups. They are treated in the same way as a timeout, and this option
18067 applies to all of them.
18068
18069
18070
18071 .option pass_router routers string unset
18072 .cindex "router" "go to after &""pass""&"
18073 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18074 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18075 routing to continue, and overriding a false setting of &%more%&. When one of
18076 these routers returns &"pass"&, the address is normally handed on to the next
18077 router in sequence. This can be changed by setting &%pass_router%& to the name
18078 of another router. However (unlike &%redirect_router%&) the named router must
18079 be below the current router, to avoid loops. Note that this option applies only
18080 to the special case of &"pass"&. It does not apply when a router returns
18081 &"decline"& because it cannot handle an address.
18082
18083
18084
18085 .option redirect_router routers string unset
18086 .cindex "router" "start at after redirection"
18087 Sometimes an administrator knows that it is pointless to reprocess addresses
18088 generated from alias or forward files with the same router again. For
18089 example, if an alias file translates real names into login ids there is no
18090 point searching the alias file a second time, especially if it is a large file.
18091
18092 The &%redirect_router%& option can be set to the name of any router instance.
18093 It causes the routing of any generated addresses to start at the named router
18094 instead of at the first router. This option has no effect if the router in
18095 which it is set does not generate new addresses.
18096
18097
18098
18099 .option require_files routers&!? "string list&!!" unset
18100 .cindex "file" "requiring for router"
18101 .cindex "router" "requiring file existence"
18102 This option provides a general mechanism for predicating the running of a
18103 router on the existence or non-existence of certain files or directories.
18104 Before running a router, as one of its precondition tests, Exim works its way
18105 through the &%require_files%& list, expanding each item separately.
18106
18107 Because the list is split before expansion, any colons in expansion items must
18108 be doubled, or the facility for using a different list separator must be used.
18109 If any expansion is forced to fail, the item is ignored. Other expansion
18110 failures cause routing of the address to be deferred.
18111
18112 If any expanded string is empty, it is ignored. Otherwise, except as described
18113 below, each string must be a fully qualified file path, optionally preceded by
18114 &"!"&. The paths are passed to the &[stat()]& function to test for the
18115 existence of the files or directories. The router is skipped if any paths not
18116 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18117
18118 .cindex "NFS"
18119 If &[stat()]& cannot determine whether a file exists or not, delivery of
18120 the message is deferred. This can happen when NFS-mounted filesystems are
18121 unavailable.
18122
18123 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18124 options, so you cannot use it to check for the existence of a file in which to
18125 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18126 full list of the order in which preconditions are evaluated.) However, as
18127 these options are all expanded, you can use the &%exists%& expansion condition
18128 to make such tests. The &%require_files%& option is intended for checking files
18129 that the router may be going to use internally, or which are needed by a
18130 transport (for example &_.procmailrc_&).
18131
18132 During delivery, the &[stat()]& function is run as root, but there is a
18133 facility for some checking of the accessibility of a file by another user.
18134 This is not a proper permissions check, but just a &"rough"& check that
18135 operates as follows:
18136
18137 If an item in a &%require_files%& list does not contain any forward slash
18138 characters, it is taken to be the user (and optional group, separated by a
18139 comma) to be checked for subsequent files in the list. If no group is specified
18140 but the user is specified symbolically, the gid associated with the uid is
18141 used. For example:
18142 .code
18143 require_files = mail:/some/file
18144 require_files = $local_part:$home/.procmailrc
18145 .endd
18146 If a user or group name in a &%require_files%& list does not exist, the
18147 &%require_files%& condition fails.
18148
18149 Exim performs the check by scanning along the components of the file path, and
18150 checking the access for the given uid and gid. It checks for &"x"& access on
18151 directories, and &"r"& access on the final file. Note that this means that file
18152 access control lists, if the operating system has them, are ignored.
18153
18154 &*Warning 1*&: When the router is being run to verify addresses for an
18155 incoming SMTP message, Exim is not running as root, but under its own uid. This
18156 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18157 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18158 user is not permitted to read one of the directories on the file's path.
18159
18160 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18161 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18162 without root access. In this case, if a check for access by a particular user
18163 is requested, Exim creates a subprocess that runs as that user, and tries the
18164 check again in that process.
18165
18166 The default action for handling an unresolved EACCES is to consider it to
18167 be caused by a configuration error, and routing is deferred because the
18168 existence or non-existence of the file cannot be determined. However, in some
18169 circumstances it may be desirable to treat this condition as if the file did
18170 not exist. If the file name (or the exclamation mark that precedes the file
18171 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18172 as if the file did not exist. For example:
18173 .code
18174 require_files = +/some/file
18175 .endd
18176 If the router is not an essential part of verification (for example, it
18177 handles users' &_.forward_& files), another solution is to set the &%verify%&
18178 option false so that the router is skipped when verifying.
18179
18180
18181
18182 .option retry_use_local_part routers boolean "see below"
18183 .cindex "hints database" "retry keys"
18184 .cindex "local part" "in retry keys"
18185 When a delivery suffers a temporary routing failure, a retry record is created
18186 in Exim's hints database. For addresses whose routing depends only on the
18187 domain, the key for the retry record should not involve the local part, but for
18188 other addresses, both the domain and the local part should be included.
18189 Usually, remote routing is of the former kind, and local routing is of the
18190 latter kind.
18191
18192 This option controls whether the local part is used to form the key for retry
18193 hints for addresses that suffer temporary errors while being handled by this
18194 router. The default value is true for any router that has &%check_local_user%&
18195 set, and false otherwise. Note that this option does not apply to hints keys
18196 for transport delays; they are controlled by a generic transport option of the
18197 same name.
18198
18199 The setting of &%retry_use_local_part%& applies only to the router on which it
18200 appears. If the router generates child addresses, they are routed
18201 independently; this setting does not become attached to them.
18202
18203
18204
18205 .option router_home_directory routers string&!! unset
18206 .cindex "router" "home directory for"
18207 .cindex "home directory" "for router"
18208 .vindex "&$home$&"
18209 This option sets a home directory for use while the router is running. (Compare
18210 &%transport_home_directory%&, which sets a home directory for later
18211 transporting.) In particular, if used on a &(redirect)& router, this option
18212 sets a value for &$home$& while a filter is running. The value is expanded;
18213 forced expansion failure causes the option to be ignored &-- other failures
18214 cause the router to defer.
18215
18216 Expansion of &%router_home_directory%& happens immediately after the
18217 &%check_local_user%& test (if configured), before any further expansions take
18218 place.
18219 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18220 are evaluated.)
18221 While the router is running, &%router_home_directory%& overrides the value of
18222 &$home$& that came from &%check_local_user%&.
18223
18224 When a router accepts an address and assigns it to a local transport (including
18225 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18226 delivery), the home directory setting for the transport is taken from the first
18227 of these values that is set:
18228
18229 .ilist
18230 The &%home_directory%& option on the transport;
18231 .next
18232 The &%transport_home_directory%& option on the router;
18233 .next
18234 The password data if &%check_local_user%& is set on the router;
18235 .next
18236 The &%router_home_directory%& option on the router.
18237 .endlist
18238
18239 In other words, &%router_home_directory%& overrides the password data for the
18240 router, but not for the transport.
18241
18242
18243
18244 .option self routers string freeze
18245 .cindex "MX record" "pointing to local host"
18246 .cindex "local host" "MX pointing to"
18247 This option applies to those routers that use a recipient address to find a
18248 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18249 and &(manualroute)& routers.
18250 Certain configurations of the &(queryprogram)& router can also specify a list
18251 of remote hosts.
18252 Usually such routers are configured to send the message to a remote host via an
18253 &(smtp)& transport. The &%self%& option specifies what happens when the first
18254 host on the list turns out to be the local host.
18255 The way in which Exim checks for the local host is described in section
18256 &<<SECTreclocipadd>>&.
18257
18258 Normally this situation indicates either an error in Exim's configuration (for
18259 example, the router should be configured not to process this domain), or an
18260 error in the DNS (for example, the MX should not point to this host). For this
18261 reason, the default action is to log the incident, defer the address, and
18262 freeze the message. The following alternatives are provided for use in special
18263 cases:
18264
18265 .vlist
18266 .vitem &%defer%&
18267 Delivery of the message is tried again later, but the message is not frozen.
18268
18269 .vitem "&%reroute%&: <&'domain'&>"
18270 The domain is changed to the given domain, and the address is passed back to
18271 be reprocessed by the routers. No rewriting of headers takes place. This
18272 behaviour is essentially a redirection.
18273
18274 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18275 The domain is changed to the given domain, and the address is passed back to be
18276 reprocessed by the routers. Any headers that contain the original domain are
18277 rewritten.
18278
18279 .vitem &%pass%&
18280 .oindex "&%more%&"
18281 .vindex "&$self_hostname$&"
18282 The router passes the address to the next router, or to the router named in the
18283 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18284 subsequent routing and delivery, the variable &$self_hostname$& contains the
18285 name of the local host that the router encountered. This can be used to
18286 distinguish between different cases for hosts with multiple names. The
18287 combination
18288 .code
18289 self = pass
18290 no_more
18291 .endd
18292 ensures that only those addresses that routed to the local host are passed on.
18293 Without &%no_more%&, addresses that were declined for other reasons would also
18294 be passed to the next router.
18295
18296 .vitem &%fail%&
18297 Delivery fails and an error report is generated.
18298
18299 .vitem &%send%&
18300 .cindex "local host" "sending to"
18301 The anomaly is ignored and the address is queued for the transport. This
18302 setting should be used with extreme caution. For an &(smtp)& transport, it
18303 makes sense only in cases where the program that is listening on the SMTP port
18304 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18305 different configuration file that handles the domain in another way.
18306 .endlist
18307
18308
18309
18310 .option senders routers&!? "address list&!!" unset
18311 .cindex "router" "checking senders"
18312 If this option is set, the router is skipped unless the message's sender
18313 address matches something on the list.
18314 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18315 are evaluated.
18316
18317 There are issues concerning verification when the running of routers is
18318 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18319 setting, it sets the sender to the null string. When using the &%-bt%& option
18320 to check a configuration file, it is necessary also to use the &%-f%& option to
18321 set an appropriate sender. For incoming mail, the sender is unset when
18322 verifying the sender, but is available when verifying any recipients. If the
18323 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18324 matters.
18325
18326
18327 .option translate_ip_address routers string&!! unset
18328 .cindex "IP address" "translating"
18329 .cindex "packet radio"
18330 .cindex "router" "IP address translation"
18331 There exist some rare networking situations (for example, packet radio) where
18332 it is helpful to be able to translate IP addresses generated by normal routing
18333 mechanisms into other IP addresses, thus performing a kind of manual IP
18334 routing. This should be done only if the normal IP routing of the TCP/IP stack
18335 is inadequate or broken. Because this is an extremely uncommon requirement, the
18336 code to support this option is not included in the Exim binary unless
18337 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18338
18339 .vindex "&$host_address$&"
18340 The &%translate_ip_address%& string is expanded for every IP address generated
18341 by the router, with the generated address set in &$host_address$&. If the
18342 expansion is forced to fail, no action is taken.
18343 For any other expansion error, delivery of the message is deferred.
18344 If the result of the expansion is an IP address, that replaces the original
18345 address; otherwise the result is assumed to be a host name &-- this is looked
18346 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18347 produce one or more replacement IP addresses. For example, to subvert all IP
18348 addresses in some specific networks, this could be added to a router:
18349 .code
18350 translate_ip_address = \
18351   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18352     {$value}fail}}
18353 .endd
18354 The file would contain lines like
18355 .code
18356 10.2.3.128/26    some.host
18357 10.8.4.34/26     10.44.8.15
18358 .endd
18359 You should not make use of this facility unless you really understand what you
18360 are doing.
18361
18362
18363
18364 .option transport routers string&!! unset
18365 This option specifies the transport to be used when a router accepts an address
18366 and sets it up for delivery. A transport is never needed if a router is used
18367 only for verification. The value of the option is expanded at routing time,
18368 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18369 and result must be the name of one of the configured transports. If it is not,
18370 delivery is deferred.
18371
18372 The &%transport%& option is not used by the &(redirect)& router, but it does
18373 have some private options that set up transports for pipe and file deliveries
18374 (see chapter &<<CHAPredirect>>&).
18375
18376
18377
18378 .option transport_current_directory routers string&!! unset
18379 .cindex "current directory for local transport"
18380 This option associates a current directory with any address that is routed
18381 to a local transport. This can happen either because a transport is
18382 explicitly configured for the router, or because it generates a delivery to a
18383 file or a pipe. During the delivery process (that is, at transport time), this
18384 option string is expanded and is set as the current directory, unless
18385 overridden by a setting on the transport.
18386 If the expansion fails for any reason, including forced failure, an error is
18387 logged, and delivery is deferred.
18388 See chapter &<<CHAPenvironment>>& for details of the local delivery
18389 environment.
18390
18391
18392
18393
18394 .option transport_home_directory routers string&!! "see below"
18395 .cindex "home directory" "for local transport"
18396 This option associates a home directory with any address that is routed to a
18397 local transport. This can happen either because a transport is explicitly
18398 configured for the router, or because it generates a delivery to a file or a
18399 pipe. During the delivery process (that is, at transport time), the option
18400 string is expanded and is set as the home directory, unless overridden by a
18401 setting of &%home_directory%& on the transport.
18402 If the expansion fails for any reason, including forced failure, an error is
18403 logged, and delivery is deferred.
18404
18405 If the transport does not specify a home directory, and
18406 &%transport_home_directory%& is not set for the router, the home directory for
18407 the transport is taken from the password data if &%check_local_user%& is set for
18408 the router. Otherwise it is taken from &%router_home_directory%& if that option
18409 is set; if not, no home directory is set for the transport.
18410
18411 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18412 environment.
18413
18414
18415
18416
18417 .option unseen routers boolean&!! false
18418 .cindex "router" "carrying on after success"
18419 The result of string expansion for this option must be a valid boolean value,
18420 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18421 result causes an error, and delivery is deferred. If the expansion is forced to
18422 fail, the default value for the option (false) is used. Other failures cause
18423 delivery to be deferred.
18424
18425 When this option is set true, routing does not cease if the router accepts the
18426 address. Instead, a copy of the incoming address is passed to the next router,
18427 overriding a false setting of &%more%&. There is little point in setting
18428 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18429 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18430 sometimes true and sometimes false).
18431
18432 .cindex "copy of message (&%unseen%& option)"
18433 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18434 qualifier in filter files. It can be used to cause copies of messages to be
18435 delivered to some other destination, while also carrying out a normal delivery.
18436 In effect, the current address is made into a &"parent"& that has two children
18437 &-- one that is delivered as specified by this router, and a clone that goes on
18438 to be routed further. For this reason, &%unseen%& may not be combined with the
18439 &%one_time%& option in a &(redirect)& router.
18440
18441 &*Warning*&: Header lines added to the address (or specified for removal) by
18442 this router or by previous routers affect the &"unseen"& copy of the message
18443 only. The clone that continues to be processed by further routers starts with
18444 no added headers and none specified for removal. For a &%redirect%& router, if
18445 a generated address is the same as the incoming address, this can lead to
18446 duplicate addresses with different header modifications. Exim does not do
18447 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18448 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18449 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18450 &%redirect%& router may be of help.
18451
18452 Unlike the handling of header modifications, any data that was set by the
18453 &%address_data%& option in the current or previous routers &'is'& passed on to
18454 subsequent routers.
18455
18456
18457 .option user routers string&!! "see below"
18458 .cindex "uid (user id)" "local delivery"
18459 .cindex "local transports" "uid and gid"
18460 .cindex "transport" "local"
18461 .cindex "router" "user for filter processing"
18462 .cindex "filter" "user for processing"
18463 When a router queues an address for a transport, and the transport does not
18464 specify a user, the user given here is used when running the delivery process.
18465 The user may be specified numerically or by name. If expansion fails, the
18466 error is logged and delivery is deferred.
18467 This user is also used by the &(redirect)& router when running a filter file.
18468 The default is unset, except when &%check_local_user%& is set. In this case,
18469 the default is taken from the password information. If the user is specified as
18470 a name, and &%group%& is not set, the group associated with the user is used.
18471 See also &%initgroups%& and &%group%& and the discussion in chapter
18472 &<<CHAPenvironment>>&.
18473
18474
18475
18476 .option verify routers&!? boolean true
18477 Setting this option has the effect of setting &%verify_sender%& and
18478 &%verify_recipient%& to the same value.
18479
18480
18481 .option verify_only routers&!? boolean false
18482 .cindex "EXPN" "with &%verify_only%&"
18483 .oindex "&%-bv%&"
18484 .cindex "router" "used only when verifying"
18485 If this option is set, the router is used only when verifying an address,
18486 delivering in cutthrough mode or
18487 testing with the &%-bv%& option, not when actually doing a delivery, testing
18488 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18489 restricted to verifying only senders or recipients by means of
18490 &%verify_sender%& and &%verify_recipient%&.
18491
18492 &*Warning*&: When the router is being run to verify addresses for an incoming
18493 SMTP message, Exim is not running as root, but under its own uid. If the router
18494 accesses any files, you need to make sure that they are accessible to the Exim
18495 user or group.
18496
18497
18498 .option verify_recipient routers&!? boolean true
18499 If this option is false, the router is skipped when verifying recipient
18500 addresses,
18501 delivering in cutthrough mode
18502 or testing recipient verification using &%-bv%&.
18503 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18504 are evaluated.
18505 See also the &$verify_mode$& variable.
18506
18507
18508 .option verify_sender routers&!? boolean true
18509 If this option is false, the router is skipped when verifying sender addresses
18510 or testing sender verification using &%-bvs%&.
18511 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18512 are evaluated.
18513 See also the &$verify_mode$& variable.
18514 .ecindex IIDgenoprou1
18515 .ecindex IIDgenoprou2
18516
18517
18518
18519
18520
18521
18522 . ////////////////////////////////////////////////////////////////////////////
18523 . ////////////////////////////////////////////////////////////////////////////
18524
18525 .chapter "The accept router" "CHID4"
18526 .cindex "&(accept)& router"
18527 .cindex "routers" "&(accept)&"
18528 The &(accept)& router has no private options of its own. Unless it is being
18529 used purely for verification (see &%verify_only%&) a transport is required to
18530 be defined by the generic &%transport%& option. If the preconditions that are
18531 specified by generic options are met, the router accepts the address and queues
18532 it for the given transport. The most common use of this router is for setting
18533 up deliveries to local mailboxes. For example:
18534 .code
18535 localusers:
18536   driver = accept
18537   domains = mydomain.example
18538   check_local_user
18539   transport = local_delivery
18540 .endd
18541 The &%domains%& condition in this example checks the domain of the address, and
18542 &%check_local_user%& checks that the local part is the login of a local user.
18543 When both preconditions are met, the &(accept)& router runs, and queues the
18544 address for the &(local_delivery)& transport.
18545
18546
18547
18548
18549
18550
18551 . ////////////////////////////////////////////////////////////////////////////
18552 . ////////////////////////////////////////////////////////////////////////////
18553
18554 .chapter "The dnslookup router" "CHAPdnslookup"
18555 .scindex IIDdnsrou1 "&(dnslookup)& router"
18556 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18557 The &(dnslookup)& router looks up the hosts that handle mail for the
18558 recipient's domain in the DNS. A transport must always be set for this router,
18559 unless &%verify_only%& is set.
18560
18561 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18562 SRV records. If none are found, or if SRV support is not configured,
18563 MX records are looked up. If no MX records exist, address records are sought.
18564 However, &%mx_domains%& can be set to disable the direct use of address
18565 records.
18566
18567 MX records of equal priority are sorted by Exim into a random order. Exim then
18568 looks for address records for the host names obtained from MX or SRV records.
18569 When a host has more than one IP address, they are sorted into a random order,
18570 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18571 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18572 generic option, the router declines.
18573
18574 Unless they have the highest priority (lowest MX value), MX records that point
18575 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18576 are discarded, together with any other MX records of equal or lower priority.
18577
18578 .cindex "MX record" "pointing to local host"
18579 .cindex "local host" "MX pointing to"
18580 .oindex "&%self%&" "in &(dnslookup)& router"
18581 If the host pointed to by the highest priority MX record, or looked up as an
18582 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18583 happens is controlled by the generic &%self%& option.
18584
18585
18586 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18587 There have been problems with DNS servers when SRV records are looked up.
18588 Some misbehaving servers return a DNS error or timeout when a non-existent
18589 SRV record is sought. Similar problems have in the past been reported for
18590 MX records. The global &%dns_again_means_nonexist%& option can help with this
18591 problem, but it is heavy-handed because it is a global option.
18592
18593 For this reason, there are two options, &%srv_fail_domains%& and
18594 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18595 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18596 an attempt to look up an SRV or MX record causes one of these results, and the
18597 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18598 such record"&. In the case of an SRV lookup, this means that the router
18599 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18600 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18601 case routing fails.
18602
18603
18604 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18605 .cindex "&(dnslookup)& router" "declines"
18606 There are a few cases where a &(dnslookup)& router will decline to accept
18607 an address; if such a router is expected to handle "all remaining non-local
18608 domains", then it is important to set &%no_more%&.
18609
18610 The router will defer rather than decline if the domain
18611 is found in the &%fail_defer_domains%& router option.
18612
18613 Reasons for a &(dnslookup)& router to decline currently include:
18614 .ilist
18615 The domain does not exist in DNS
18616 .next
18617 The domain exists but the MX record's host part is just "."; this is a common
18618 convention (borrowed from SRV) used to indicate that there is no such service
18619 for this domain and to not fall back to trying A/AAAA records.
18620 .next
18621 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18622 .next
18623 MX record points to a non-existent host.
18624 .next
18625 MX record points to an IP address and the main section option
18626 &%allow_mx_to_ip%& is not set.
18627 .next
18628 MX records exist and point to valid hosts, but all hosts resolve only to
18629 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18630 .next
18631 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18632 &%dns_check_names_pattern%& for handling one variant of this)
18633 .next
18634 &%check_secondary_mx%& is set on this router but the local host can
18635 not be found in the MX records (see below)
18636 .endlist
18637
18638
18639
18640
18641 .section "Private options for dnslookup" "SECID118"
18642 .cindex "options" "&(dnslookup)& router"
18643 The private options for the &(dnslookup)& router are as follows:
18644
18645 .option check_secondary_mx dnslookup boolean false
18646 .cindex "MX record" "checking for secondary"
18647 If this option is set, the router declines unless the local host is found in
18648 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18649 process domains for which the local host is a secondary mail exchanger
18650 differently to other domains. The way in which Exim decides whether a host is
18651 the local host is described in section &<<SECTreclocipadd>>&.
18652
18653
18654 .option check_srv dnslookup string&!! unset
18655 .cindex "SRV record" "enabling use of"
18656 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18657 addition to MX and address records. The support is disabled by default. To
18658 enable SRV support, set the &%check_srv%& option to the name of the service
18659 required. For example,
18660 .code
18661 check_srv = smtp
18662 .endd
18663 looks for SRV records that refer to the normal smtp service. The option is
18664 expanded, so the service name can vary from message to message or address
18665 to address. This might be helpful if SRV records are being used for a
18666 submission service. If the expansion is forced to fail, the &%check_srv%&
18667 option is ignored, and the router proceeds to look for MX records in the
18668 normal way.
18669
18670 When the expansion succeeds, the router searches first for SRV records for
18671 the given service (it assumes TCP protocol). A single SRV record with a
18672 host name that consists of just a single dot indicates &"no such service for
18673 this domain"&; if this is encountered, the router declines. If other kinds of
18674 SRV record are found, they are used to construct a host list for delivery
18675 according to the rules of RFC 2782. MX records are not sought in this case.
18676
18677 When no SRV records are found, MX records (and address records) are sought in
18678 the traditional way. In other words, SRV records take precedence over MX
18679 records, just as MX records take precedence over address records. Note that
18680 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18681 defined it. It is apparently believed that MX records are sufficient for email
18682 and that SRV records should not be used for this purpose. However, SRV records
18683 have an additional &"weight"& feature which some people might find useful when
18684 trying to split an SMTP load between hosts of different power.
18685
18686 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18687 when there is a DNS lookup error.
18688
18689
18690
18691
18692 .option fail_defer_domains dnslookup "domain list&!!" unset
18693 .cindex "MX record" "not found"
18694 DNS lookups for domains matching &%fail_defer_domains%&
18695 which find no matching record will cause the router to defer
18696 rather than the default behaviour of decline.
18697 This maybe be useful for queueing messages for a newly created
18698 domain while the DNS configuration is not ready.
18699 However, it will result in any message with mistyped domains
18700 also being queued.
18701
18702
18703 .option mx_domains dnslookup "domain list&!!" unset
18704 .cindex "MX record" "required to exist"
18705 .cindex "SRV record" "required to exist"
18706 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18707 record in order to be recognized. (The name of this option could be improved.)
18708 For example, if all the mail hosts in &'fict.example'& are known to have MX
18709 records, except for those in &'discworld.fict.example'&, you could use this
18710 setting:
18711 .code
18712 mx_domains = ! *.discworld.fict.example : *.fict.example
18713 .endd
18714 This specifies that messages addressed to a domain that matches the list but
18715 has no MX record should be bounced immediately instead of being routed using
18716 the address record.
18717
18718
18719 .option mx_fail_domains dnslookup "domain list&!!" unset
18720 If the DNS lookup for MX records for one of the domains in this list causes a
18721 DNS lookup error, Exim behaves as if no MX records were found. See section
18722 &<<SECTprowitdnsloo>>& for more discussion.
18723
18724
18725
18726
18727 .option qualify_single dnslookup boolean true
18728 .cindex "DNS" "resolver options"
18729 .cindex "DNS" "qualifying single-component names"
18730 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18731 lookups. Typically, but not standardly, this causes the resolver to qualify
18732 single-component names with the default domain. For example, on a machine
18733 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18734 &'thesaurus.ref.example'& inside the resolver. For details of what your
18735 resolver actually does, consult your man pages for &'resolver'& and
18736 &'resolv.conf'&.
18737
18738
18739
18740 .option rewrite_headers dnslookup boolean true
18741 .cindex "rewriting" "header lines"
18742 .cindex "header lines" "rewriting"
18743 If the domain name in the address that is being processed is not fully
18744 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18745 an address is specified as &'dormouse@teaparty'&, the domain might be
18746 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18747 occur as a result of setting the &%widen_domains%& option. If
18748 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18749 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18750 header lines of the message are rewritten with the full domain name.
18751
18752 This option should be turned off only when it is known that no message is
18753 ever going to be sent outside an environment where the abbreviation makes
18754 sense.
18755
18756 When an MX record is looked up in the DNS and matches a wildcard record, name
18757 servers normally return a record containing the name that has been looked up,
18758 making it impossible to detect whether a wildcard was present or not. However,
18759 some name servers have recently been seen to return the wildcard entry. If the
18760 name returned by a DNS lookup begins with an asterisk, it is not used for
18761 header rewriting.
18762
18763
18764 .option same_domain_copy_routing dnslookup boolean false
18765 .cindex "address" "copying routing"
18766 Addresses with the same domain are normally routed by the &(dnslookup)& router
18767 to the same list of hosts. However, this cannot be presumed, because the router
18768 options and preconditions may refer to the local part of the address. By
18769 default, therefore, Exim routes each address in a message independently. DNS
18770 servers run caches, so repeated DNS lookups are not normally expensive, and in
18771 any case, personal messages rarely have more than a few recipients.
18772
18773 If you are running mailing lists with large numbers of subscribers at the same
18774 domain, and you are using a &(dnslookup)& router which is independent of the
18775 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18776 lookups for identical domains in one message. In this case, when &(dnslookup)&
18777 routes an address to a remote transport, any other unrouted addresses in the
18778 message that have the same domain are automatically given the same routing
18779 without processing them independently,
18780 provided the following conditions are met:
18781
18782 .ilist
18783 No router that processed the address specified &%headers_add%& or
18784 &%headers_remove%&.
18785 .next
18786 The router did not change the address in any way, for example, by &"widening"&
18787 the domain.
18788 .endlist
18789
18790
18791
18792
18793 .option search_parents dnslookup boolean false
18794 .cindex "DNS" "resolver options"
18795 When this option is true, the resolver option RES_DNSRCH is set for DNS
18796 lookups. This is different from the &%qualify_single%& option in that it
18797 applies to domains containing dots. Typically, but not standardly, it causes
18798 the resolver to search for the name in the current domain and in parent
18799 domains. For example, on a machine in the &'fict.example'& domain, if looking
18800 up &'teaparty.wonderland'& failed, the resolver would try
18801 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18802 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18803
18804 Setting this option true can cause problems in domains that have a wildcard MX
18805 record, because any domain that does not have its own MX record matches the
18806 local wildcard.
18807
18808
18809
18810 .option srv_fail_domains dnslookup "domain list&!!" unset
18811 If the DNS lookup for SRV records for one of the domains in this list causes a
18812 DNS lookup error, Exim behaves as if no SRV records were found. See section
18813 &<<SECTprowitdnsloo>>& for more discussion.
18814
18815
18816
18817
18818 .option widen_domains dnslookup "string list" unset
18819 .cindex "domain" "partial; widening"
18820 If a DNS lookup fails and this option is set, each of its strings in turn is
18821 added onto the end of the domain, and the lookup is tried again. For example,
18822 if
18823 .code
18824 widen_domains = fict.example:ref.example
18825 .endd
18826 is set and a lookup of &'klingon.dictionary'& fails,
18827 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18828 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18829 and &%search_parents%& options can cause some widening to be undertaken inside
18830 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18831 when verifying, unless &%rewrite_headers%& is false (not the default).
18832
18833
18834 .section "Effect of qualify_single and search_parents" "SECID119"
18835 When a domain from an envelope recipient is changed by the resolver as a result
18836 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18837 corresponding address in the message's header lines unless &%rewrite_headers%&
18838 is set false. Exim then re-routes the address, using the full domain.
18839
18840 These two options affect only the DNS lookup that takes place inside the router
18841 for the domain of the address that is being routed. They do not affect lookups
18842 such as that implied by
18843 .code
18844 domains = @mx_any
18845 .endd
18846 that may happen while processing a router precondition before the router is
18847 entered. No widening ever takes place for these lookups.
18848 .ecindex IIDdnsrou1
18849 .ecindex IIDdnsrou2
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859 . ////////////////////////////////////////////////////////////////////////////
18860 . ////////////////////////////////////////////////////////////////////////////
18861
18862 .chapter "The ipliteral router" "CHID5"
18863 .cindex "&(ipliteral)& router"
18864 .cindex "domain literal" "routing"
18865 .cindex "routers" "&(ipliteral)&"
18866 This router has no private options. Unless it is being used purely for
18867 verification (see &%verify_only%&) a transport is required to be defined by the
18868 generic &%transport%& option. The router accepts the address if its domain part
18869 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18870 router handles the address
18871 .code
18872 root@[192.168.1.1]
18873 .endd
18874 by setting up delivery to the host with that IP address. IPv4 domain literals
18875 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18876 are similar, but the address is preceded by &`ipv6:`&. For example:
18877 .code
18878 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18879 .endd
18880 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18881 grounds that sooner or later somebody will try it.
18882
18883 .oindex "&%self%&" "in &(ipliteral)& router"
18884 If the IP address matches something in &%ignore_target_hosts%&, the router
18885 declines. If an IP literal turns out to refer to the local host, the generic
18886 &%self%& option determines what happens.
18887
18888 The RFCs require support for domain literals; however, their use is
18889 controversial in today's Internet. If you want to use this router, you must
18890 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18891 Exim will not recognize the domain literal syntax in addresses.
18892
18893
18894
18895 . ////////////////////////////////////////////////////////////////////////////
18896 . ////////////////////////////////////////////////////////////////////////////
18897
18898 .chapter "The iplookup router" "CHID6"
18899 .cindex "&(iplookup)& router"
18900 .cindex "routers" "&(iplookup)&"
18901 The &(iplookup)& router was written to fulfil a specific requirement in
18902 Cambridge University (which in fact no longer exists). For this reason, it is
18903 not included in the binary of Exim by default. If you want to include it, you
18904 must set
18905 .code
18906 ROUTER_IPLOOKUP=yes
18907 .endd
18908 in your &_Local/Makefile_& configuration file.
18909
18910 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18911 connection to one or more specific hosts. The host can then return the same or
18912 a different address &-- in effect rewriting the recipient address in the
18913 message's envelope. The new address is then passed on to subsequent routers. If
18914 this process fails, the address can be passed on to other routers, or delivery
18915 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18916 must not be specified for it.
18917
18918 .cindex "options" "&(iplookup)& router"
18919 .option hosts iplookup string unset
18920 This option must be supplied. Its value is a colon-separated list of host
18921 names. The hosts are looked up using &[gethostbyname()]&
18922 (or &[getipnodebyname()]& when available)
18923 and are tried in order until one responds to the query. If none respond, what
18924 happens is controlled by &%optional%&.
18925
18926
18927 .option optional iplookup boolean false
18928 If &%optional%& is true, if no response is obtained from any host, the address
18929 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18930 delivery to the address is deferred.
18931
18932
18933 .option port iplookup integer 0
18934 .cindex "port" "&(iplookup)& router"
18935 This option must be supplied. It specifies the port number for the TCP or UDP
18936 call.
18937
18938
18939 .option protocol iplookup string udp
18940 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18941 protocols is to be used.
18942
18943
18944 .option query iplookup string&!! "see below"
18945 This defines the content of the query that is sent to the remote hosts. The
18946 default value is:
18947 .code
18948 $local_part@$domain $local_part@$domain
18949 .endd
18950 The repetition serves as a way of checking that a response is to the correct
18951 query in the default case (see &%response_pattern%& below).
18952
18953
18954 .option reroute iplookup string&!! unset
18955 If this option is not set, the rerouted address is precisely the byte string
18956 returned by the remote host, up to the first white space, if any. If set, the
18957 string is expanded to form the rerouted address. It can include parts matched
18958 in the response by &%response_pattern%& by means of numeric variables such as
18959 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18960 whether or not a pattern is in use. In all cases, the rerouted address must end
18961 up in the form &'local_part@domain'&.
18962
18963
18964 .option response_pattern iplookup string unset
18965 This option can be set to a regular expression that is applied to the string
18966 returned from the remote host. If the pattern does not match the response, the
18967 router declines. If &%response_pattern%& is not set, no checking of the
18968 response is done, unless the query was defaulted, in which case there is a
18969 check that the text returned after the first white space is the original
18970 address. This checks that the answer that has been received is in response to
18971 the correct question. For example, if the response is just a new domain, the
18972 following could be used:
18973 .code
18974 response_pattern = ^([^@]+)$
18975 reroute = $local_part@$1
18976 .endd
18977
18978 .option timeout iplookup time 5s
18979 This specifies the amount of time to wait for a response from the remote
18980 machine. The same timeout is used for the &[connect()]& function for a TCP
18981 call. It does not apply to UDP.
18982
18983
18984
18985
18986 . ////////////////////////////////////////////////////////////////////////////
18987 . ////////////////////////////////////////////////////////////////////////////
18988
18989 .chapter "The manualroute router" "CHID7"
18990 .scindex IIDmanrou1 "&(manualroute)& router"
18991 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18992 .cindex "domain" "manually routing"
18993 The &(manualroute)& router is so-called because it provides a way of manually
18994 routing an address according to its domain. It is mainly used when you want to
18995 route addresses to remote hosts according to your own rules, bypassing the
18996 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18997 route to local transports, a facility that may be useful if you want to save
18998 messages for dial-in hosts in local files.
18999
19000 The &(manualroute)& router compares a list of domain patterns with the domain
19001 it is trying to route. If there is no match, the router declines. Each pattern
19002 has associated with it a list of hosts and some other optional data, which may
19003 include a transport. The combination of a pattern and its data is called a
19004 &"routing rule"&. For patterns that do not have an associated transport, the
19005 generic &%transport%& option must specify a transport, unless the router is
19006 being used purely for verification (see &%verify_only%&).
19007
19008 .vindex "&$host$&"
19009 In the case of verification, matching the domain pattern is sufficient for the
19010 router to accept the address. When actually routing an address for delivery,
19011 an address that matches a domain pattern is queued for the associated
19012 transport. If the transport is not a local one, a host list must be associated
19013 with the pattern; IP addresses are looked up for the hosts, and these are
19014 passed to the transport along with the mail address. For local transports, a
19015 host list is optional. If it is present, it is passed in &$host$& as a single
19016 text string.
19017
19018 The list of routing rules can be provided as an inline string in
19019 &%route_list%&, or the data can be obtained by looking up the domain in a file
19020 or database by setting &%route_data%&. Only one of these settings may appear in
19021 any one instance of &(manualroute)&. The format of routing rules is described
19022 below, following the list of private options.
19023
19024
19025 .section "Private options for manualroute" "SECTprioptman"
19026
19027 .cindex "options" "&(manualroute)& router"
19028 The private options for the &(manualroute)& router are as follows:
19029
19030 .option host_all_ignored manualroute string defer
19031 See &%host_find_failed%&.
19032
19033 .option host_find_failed manualroute string freeze
19034 This option controls what happens when &(manualroute)& tries to find an IP
19035 address for a host, and the host does not exist. The option can be set to one
19036 of the following values:
19037 .code
19038 decline
19039 defer
19040 fail
19041 freeze
19042 ignore
19043 pass
19044 .endd
19045 The default (&"freeze"&) assumes that this state is a serious configuration
19046 error. The difference between &"pass"& and &"decline"& is that the former
19047 forces the address to be passed to the next router (or the router defined by
19048 &%pass_router%&),
19049 .oindex "&%more%&"
19050 overriding &%no_more%&, whereas the latter passes the address to the next
19051 router only if &%more%& is true.
19052
19053 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19054 cannot be found. If all the hosts in the list are ignored, the behaviour is
19055 controlled by the &%host_all_ignored%& option. This takes the same values
19056 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19057
19058 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19059 state; if a host lookup gets a temporary error, delivery is deferred unless the
19060 generic &%pass_on_timeout%& option is set.
19061
19062
19063 .option hosts_randomize manualroute boolean false
19064 .cindex "randomized host list"
19065 .cindex "host" "list of; randomized"
19066 If this option is set, the order of the items in a host list in a routing rule
19067 is randomized each time the list is used, unless an option in the routing rule
19068 overrides (see below). Randomizing the order of a host list can be used to do
19069 crude load sharing. However, if more than one mail address is routed by the
19070 same router to the same host list, the host lists are considered to be the same
19071 (even though they may be randomized into different orders) for the purpose of
19072 deciding whether to batch the deliveries into a single SMTP transaction.
19073
19074 When &%hosts_randomize%& is true, a host list may be split
19075 into groups whose order is separately randomized. This makes it possible to
19076 set up MX-like behaviour. The boundaries between groups are indicated by an
19077 item that is just &`+`& in the host list. For example:
19078 .code
19079 route_list = * host1:host2:host3:+:host4:host5
19080 .endd
19081 The order of the first three hosts and the order of the last two hosts is
19082 randomized for each use, but the first three always end up before the last two.
19083 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19084 randomized host list is passed to an &(smtp)& transport that also has
19085 &%hosts_randomize set%&, the list is not re-randomized.
19086
19087
19088 .option route_data manualroute string&!! unset
19089 If this option is set, it must expand to yield the data part of a routing rule.
19090 Typically, the expansion string includes a lookup based on the domain. For
19091 example:
19092 .code
19093 route_data = ${lookup{$domain}dbm{/etc/routes}}
19094 .endd
19095 If the expansion is forced to fail, or the result is an empty string, the
19096 router declines. Other kinds of expansion failure cause delivery to be
19097 deferred.
19098
19099
19100 .option route_list manualroute "string list" unset
19101 This string is a list of routing rules, in the form defined below. Note that,
19102 unlike most string lists, the items are separated by semicolons. This is so
19103 that they may contain colon-separated host lists.
19104
19105
19106 .option same_domain_copy_routing manualroute boolean false
19107 .cindex "address" "copying routing"
19108 Addresses with the same domain are normally routed by the &(manualroute)&
19109 router to the same list of hosts. However, this cannot be presumed, because the
19110 router options and preconditions may refer to the local part of the address. By
19111 default, therefore, Exim routes each address in a message independently. DNS
19112 servers run caches, so repeated DNS lookups are not normally expensive, and in
19113 any case, personal messages rarely have more than a few recipients.
19114
19115 If you are running mailing lists with large numbers of subscribers at the same
19116 domain, and you are using a &(manualroute)& router which is independent of the
19117 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19118 lookups for identical domains in one message. In this case, when
19119 &(manualroute)& routes an address to a remote transport, any other unrouted
19120 addresses in the message that have the same domain are automatically given the
19121 same routing without processing them independently. However, this is only done
19122 if &%headers_add%& and &%headers_remove%& are unset.
19123
19124
19125
19126
19127 .section "Routing rules in route_list" "SECID120"
19128 The value of &%route_list%& is a string consisting of a sequence of routing
19129 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19130 entered as two semicolons. Alternatively, the list separator can be changed as
19131 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19132 Empty rules are ignored. The format of each rule is
19133 .display
19134 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19135 .endd
19136 The following example contains two rules, each with a simple domain pattern and
19137 no options:
19138 .code
19139 route_list = \
19140   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19141   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19142 .endd
19143 The three parts of a rule are separated by white space. The pattern and the
19144 list of hosts can be enclosed in quotes if necessary, and if they are, the
19145 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19146 single domain pattern, which is the only mandatory item in the rule. The
19147 pattern is in the same format as one item in a domain list (see section
19148 &<<SECTdomainlist>>&),
19149 except that it may not be the name of an interpolated file.
19150 That is, it may be wildcarded, or a regular expression, or a file or database
19151 lookup (with semicolons doubled, because of the use of semicolon as a separator
19152 in a &%route_list%&).
19153
19154 The rules in &%route_list%& are searched in order until one of the patterns
19155 matches the domain that is being routed. The list of hosts and then options are
19156 then used as described below. If there is no match, the router declines. When
19157 &%route_list%& is set, &%route_data%& must not be set.
19158
19159
19160
19161 .section "Routing rules in route_data" "SECID121"
19162 The use of &%route_list%& is convenient when there are only a small number of
19163 routing rules. For larger numbers, it is easier to use a file or database to
19164 hold the routing information, and use the &%route_data%& option instead.
19165 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19166 Most commonly, &%route_data%& is set as a string that contains an
19167 expansion lookup. For example, suppose we place two routing rules in a file
19168 like this:
19169 .code
19170 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19171 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19172 .endd
19173 This data can be accessed by setting
19174 .code
19175 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19176 .endd
19177 Failure of the lookup results in an empty string, causing the router to
19178 decline. However, you do not have to use a lookup in &%route_data%&. The only
19179 requirement is that the result of expanding the string is a list of hosts,
19180 possibly followed by options, separated by white space. The list of hosts must
19181 be enclosed in quotes if it contains white space.
19182
19183
19184
19185
19186 .section "Format of the list of hosts" "SECID122"
19187 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19188 always separately expanded before use. If the expansion fails, the router
19189 declines. The result of the expansion must be a colon-separated list of names
19190 and/or IP addresses, optionally also including ports. The format of each item
19191 in the list is described in the next section. The list separator can be changed
19192 as described in section &<<SECTlistconstruct>>&.
19193
19194 If the list of hosts was obtained from a &%route_list%& item, the following
19195 variables are set during its expansion:
19196
19197 .ilist
19198 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19199 If the domain was matched against a regular expression, the numeric variables
19200 &$1$&, &$2$&, etc. may be set. For example:
19201 .code
19202 route_list = ^domain(\d+)   host-$1.text.example
19203 .endd
19204 .next
19205 &$0$& is always set to the entire domain.
19206 .next
19207 &$1$& is also set when partial matching is done in a file lookup.
19208
19209 .next
19210 .vindex "&$value$&"
19211 If the pattern that matched the domain was a lookup item, the data that was
19212 looked up is available in the expansion variable &$value$&. For example:
19213 .code
19214 route_list = lsearch;;/some/file.routes  $value
19215 .endd
19216 .endlist
19217
19218 Note the doubling of the semicolon in the pattern that is necessary because
19219 semicolon is the default route list separator.
19220
19221
19222
19223 .section "Format of one host item" "SECTformatonehostitem"
19224 Each item in the list of hosts is either a host name or an IP address,
19225 optionally with an attached port number. When no port is given, an IP address
19226 is not enclosed in brackets. When a port is specified, it overrides the port
19227 specification on the transport. The port is separated from the name or address
19228 by a colon. This leads to some complications:
19229
19230 .ilist
19231 Because colon is the default separator for the list of hosts, either
19232 the colon that specifies a port must be doubled, or the list separator must
19233 be changed. The following two examples have the same effect:
19234 .code
19235 route_list = * "host1.tld::1225 : host2.tld::1226"
19236 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19237 .endd
19238 .next
19239 When IPv6 addresses are involved, it gets worse, because they contain
19240 colons of their own. To make this case easier, it is permitted to
19241 enclose an IP address (either v4 or v6) in square brackets if a port
19242 number follows. For example:
19243 .code
19244 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19245 .endd
19246 .endlist
19247
19248 .section "How the list of hosts is used" "SECThostshowused"
19249 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19250 the hosts is tried, in the order specified, when carrying out the SMTP
19251 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19252 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19253 transport.
19254
19255 Hosts may be listed by name or by IP address. An unadorned name in the list of
19256 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19257 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19258 records in the DNS. For example:
19259 .code
19260 route_list = *  x.y.z:p.q.r/MX:e.f.g
19261 .endd
19262 If this feature is used with a port specifier, the port must come last. For
19263 example:
19264 .code
19265 route_list = *  dom1.tld/mx::1225
19266 .endd
19267 If the &%hosts_randomize%& option is set, the order of the items in the list is
19268 randomized before any lookups are done. Exim then scans the list; for any name
19269 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19270 be an interface on the local host and the item is not the first in the list,
19271 Exim discards it and any subsequent items. If it is the first item, what
19272 happens is controlled by the
19273 .oindex "&%self%&" "in &(manualroute)& router"
19274 &%self%& option of the router.
19275
19276 A name on the list that is followed by &`/MX`& is replaced with the list of
19277 hosts obtained by looking up MX records for the name. This is always a DNS
19278 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19279 below) are not relevant here. The order of these hosts is determined by the
19280 preference values in the MX records, according to the usual rules. Because
19281 randomizing happens before the MX lookup, it does not affect the order that is
19282 defined by MX preferences.
19283
19284 If the local host is present in the sublist obtained from MX records, but is
19285 not the most preferred host in that list, it and any equally or less
19286 preferred hosts are removed before the sublist is inserted into the main list.
19287
19288 If the local host is the most preferred host in the MX list, what happens
19289 depends on where in the original list of hosts the &`/MX`& item appears. If it
19290 is not the first item (that is, there are previous hosts in the main list),
19291 Exim discards this name and any subsequent items in the main list.
19292
19293 If the MX item is first in the list of hosts, and the local host is the
19294 most preferred host, what happens is controlled by the &%self%& option of the
19295 router.
19296
19297 DNS failures when lookup up the MX records are treated in the same way as DNS
19298 failures when looking up IP addresses: &%pass_on_timeout%& and
19299 &%host_find_failed%& are used when relevant.
19300
19301 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19302 whether obtained from an MX lookup or not.
19303
19304
19305
19306 .section "How the options are used" "SECThowoptused"
19307 The options are a sequence of words; in practice no more than three are ever
19308 present. One of the words can be the name of a transport; this overrides the
19309 &%transport%& option on the router for this particular routing rule only. The
19310 other words (if present) control randomization of the list of hosts on a
19311 per-rule basis, and how the IP addresses of the hosts are to be found when
19312 routing to a remote transport. These options are as follows:
19313
19314 .ilist
19315 &%randomize%&: randomize the order of the hosts in this list, overriding the
19316 setting of &%hosts_randomize%& for this routing rule only.
19317 .next
19318 &%no_randomize%&: do not randomize the order of the hosts in this list,
19319 overriding the setting of &%hosts_randomize%& for this routing rule only.
19320 .next
19321 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19322 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19323 also look in &_/etc/hosts_& or other sources of information.
19324 .next
19325 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19326 no address records are found. If there is a temporary DNS error (such as a
19327 timeout), delivery is deferred.
19328 .endlist
19329
19330 For example:
19331 .code
19332 route_list = domain1  host1:host2:host3  randomize bydns;\
19333              domain2  host4:host5
19334 .endd
19335 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19336 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19337 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19338 or &[gethostbyname()]&, and the result of the lookup is the result of that
19339 call.
19340
19341 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19342 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19343 instead of TRY_AGAIN. That is why the default action is to try a DNS
19344 lookup first. Only if that gives a definite &"no such host"& is the local
19345 function called.
19346
19347
19348
19349 If no IP address for a host can be found, what happens is controlled by the
19350 &%host_find_failed%& option.
19351
19352 .vindex "&$host$&"
19353 When an address is routed to a local transport, IP addresses are not looked up.
19354 The host list is passed to the transport in the &$host$& variable.
19355
19356
19357
19358 .section "Manualroute examples" "SECID123"
19359 In some of the examples that follow, the presence of the &%remote_smtp%&
19360 transport, as defined in the default configuration file, is assumed:
19361
19362 .ilist
19363 .cindex "smart host" "example router"
19364 The &(manualroute)& router can be used to forward all external mail to a
19365 &'smart host'&. If you have set up, in the main part of the configuration, a
19366 named domain list that contains your local domains, for example:
19367 .code
19368 domainlist local_domains = my.domain.example
19369 .endd
19370 You can arrange for all other domains to be routed to a smart host by making
19371 your first router something like this:
19372 .code
19373 smart_route:
19374   driver = manualroute
19375   domains = !+local_domains
19376   transport = remote_smtp
19377   route_list = * smarthost.ref.example
19378 .endd
19379 This causes all non-local addresses to be sent to the single host
19380 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19381 they are tried in order
19382 (but you can use &%hosts_randomize%& to vary the order each time).
19383 Another way of configuring the same thing is this:
19384 .code
19385 smart_route:
19386   driver = manualroute
19387   transport = remote_smtp
19388   route_list = !+local_domains  smarthost.ref.example
19389 .endd
19390 There is no difference in behaviour between these two routers as they stand.
19391 However, they behave differently if &%no_more%& is added to them. In the first
19392 example, the router is skipped if the domain does not match the &%domains%&
19393 precondition; the following router is always tried. If the router runs, it
19394 always matches the domain and so can never decline. Therefore, &%no_more%&
19395 would have no effect. In the second case, the router is never skipped; it
19396 always runs. However, if it doesn't match the domain, it declines. In this case
19397 &%no_more%& would prevent subsequent routers from running.
19398
19399 .next
19400 .cindex "mail hub example"
19401 A &'mail hub'& is a host which receives mail for a number of domains via MX
19402 records in the DNS and delivers it via its own private routing mechanism. Often
19403 the final destinations are behind a firewall, with the mail hub being the one
19404 machine that can connect to machines both inside and outside the firewall. The
19405 &(manualroute)& router is usually used on a mail hub to route incoming messages
19406 to the correct hosts. For a small number of domains, the routing can be inline,
19407 using the &%route_list%& option, but for a larger number a file or database
19408 lookup is easier to manage.
19409
19410 If the domain names are in fact the names of the machines to which the mail is
19411 to be sent by the mail hub, the configuration can be quite simple. For
19412 example:
19413 .code
19414 hub_route:
19415   driver = manualroute
19416   transport = remote_smtp
19417   route_list = *.rhodes.tvs.example  $domain
19418 .endd
19419 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19420 whose names are the same as the mail domains. A similar approach can be taken
19421 if the host name can be obtained from the domain name by a string manipulation
19422 that the expansion facilities can handle. Otherwise, a lookup based on the
19423 domain can be used to find the host:
19424 .code
19425 through_firewall:
19426   driver = manualroute
19427   transport = remote_smtp
19428   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19429 .endd
19430 The result of the lookup must be the name or IP address of the host (or
19431 hosts) to which the address is to be routed. If the lookup fails, the route
19432 data is empty, causing the router to decline. The address then passes to the
19433 next router.
19434
19435 .next
19436 .cindex "batched SMTP output example"
19437 .cindex "SMTP" "batched outgoing; example"
19438 You can use &(manualroute)& to deliver messages to pipes or files in batched
19439 SMTP format for onward transportation by some other means. This is one way of
19440 storing mail for a dial-up host when it is not connected. The route list entry
19441 can be as simple as a single domain name in a configuration like this:
19442 .code
19443 save_in_file:
19444   driver = manualroute
19445   transport = batchsmtp_appendfile
19446   route_list = saved.domain.example
19447 .endd
19448 though often a pattern is used to pick up more than one domain. If there are
19449 several domains or groups of domains with different transport requirements,
19450 different transports can be listed in the routing information:
19451 .code
19452 save_in_file:
19453   driver = manualroute
19454   route_list = \
19455     *.saved.domain1.example  $domain  batch_appendfile; \
19456     *.saved.domain2.example  \
19457       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19458       batch_pipe
19459 .endd
19460 .vindex "&$domain$&"
19461 .vindex "&$host$&"
19462 The first of these just passes the domain in the &$host$& variable, which
19463 doesn't achieve much (since it is also in &$domain$&), but the second does a
19464 file lookup to find a value to pass, causing the router to decline to handle
19465 the address if the lookup fails.
19466
19467 .next
19468 .cindex "UUCP" "example of router for"
19469 Routing mail directly to UUCP software is a specific case of the use of
19470 &(manualroute)& in a gateway to another mail environment. This is an example of
19471 one way it can be done:
19472 .code
19473 # Transport
19474 uucp:
19475   driver = pipe
19476   user = nobody
19477   command = /usr/local/bin/uux -r - \
19478     ${substr_-5:$host}!rmail ${local_part}
19479   return_fail_output = true
19480
19481 # Router
19482 uucphost:
19483   transport = uucp
19484   driver = manualroute
19485   route_data = \
19486     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19487 .endd
19488 The file &_/usr/local/exim/uucphosts_& contains entries like
19489 .code
19490 darksite.ethereal.example:           darksite.UUCP
19491 .endd
19492 It can be set up more simply without adding and removing &".UUCP"& but this way
19493 makes clear the distinction between the domain name
19494 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19495 .endlist
19496 .ecindex IIDmanrou1
19497 .ecindex IIDmanrou2
19498
19499
19500
19501
19502
19503
19504
19505
19506 . ////////////////////////////////////////////////////////////////////////////
19507 . ////////////////////////////////////////////////////////////////////////////
19508
19509 .chapter "The queryprogram router" "CHAPdriverlast"
19510 .scindex IIDquerou1 "&(queryprogram)& router"
19511 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19512 .cindex "routing" "by external program"
19513 The &(queryprogram)& router routes an address by running an external command
19514 and acting on its output. This is an expensive way to route, and is intended
19515 mainly for use in lightly-loaded systems, or for performing experiments.
19516 However, if it is possible to use the precondition options (&%domains%&,
19517 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19518 be used in special cases, even on a busy host. There are the following private
19519 options:
19520 .cindex "options" "&(queryprogram)& router"
19521
19522 .option command queryprogram string&!! unset
19523 This option must be set. It specifies the command that is to be run. The
19524 command is split up into a command name and arguments, and then each is
19525 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19526 &<<CHAPpipetransport>>&).
19527
19528
19529 .option command_group queryprogram string unset
19530 .cindex "gid (group id)" "in &(queryprogram)& router"
19531 This option specifies a gid to be set when running the command while routing an
19532 address for deliver. It must be set if &%command_user%& specifies a numerical
19533 uid. If it begins with a digit, it is interpreted as the numerical value of the
19534 gid. Otherwise it is looked up using &[getgrnam()]&.
19535
19536
19537 .option command_user queryprogram string unset
19538 .cindex "uid (user id)" "for &(queryprogram)&"
19539 This option must be set. It specifies the uid which is set when running the
19540 command while routing an address for delivery. If the value begins with a digit,
19541 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19542 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19543 not set, a value for the gid also.
19544
19545 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19546 root, which it does during a normal delivery in a conventional configuration.
19547 However, when an address is being verified during message reception, Exim is
19548 usually running as the Exim user, not as root. If the &(queryprogram)& router
19549 is called from a non-root process, Exim cannot change uid or gid before running
19550 the command. In this circumstance the command runs under the current uid and
19551 gid.
19552
19553
19554 .option current_directory queryprogram string /
19555 This option specifies an absolute path which is made the current directory
19556 before running the command.
19557
19558
19559 .option timeout queryprogram time 1h
19560 If the command does not complete within the timeout period, its process group
19561 is killed and the message is frozen. A value of zero time specifies no
19562 timeout.
19563
19564
19565 The standard output of the command is connected to a pipe, which is read when
19566 the command terminates. It should consist of a single line of output,
19567 containing up to five fields, separated by white space. The maximum length of
19568 the line is 1023 characters. Longer lines are silently truncated. The first
19569 field is one of the following words (case-insensitive):
19570
19571 .ilist
19572 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19573 below).
19574 .next
19575 &'Decline'&: the router declines; pass the address to the next router, unless
19576 &%no_more%& is set.
19577 .next
19578 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19579 subsequent text on the line is an error message. If the router is run as part
19580 of address verification during an incoming SMTP message, the message is
19581 included in the SMTP response.
19582 .next
19583 &'Defer'&: routing could not be completed at this time; try again later. Any
19584 subsequent text on the line is an error message which is logged. It is not
19585 included in any SMTP response.
19586 .next
19587 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19588 .next
19589 &'Pass'&: pass the address to the next router (or the router specified by
19590 &%pass_router%&), overriding &%no_more%&.
19591 .next
19592 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19593 new addresses, which are routed independently, starting with the first router,
19594 or the router specified by &%redirect_router%&, if set.
19595 .endlist
19596
19597 When the first word is &'accept'&, the remainder of the line consists of a
19598 number of keyed data values, as follows (split into two lines here, to fit on
19599 the page):
19600 .code
19601 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19602 LOOKUP=byname|bydns DATA=<text>
19603 .endd
19604 The data items can be given in any order, and all are optional. If no transport
19605 is included, the transport specified by the generic &%transport%& option is
19606 used. The list of hosts and the lookup type are needed only if the transport is
19607 an &(smtp)& transport that does not itself supply a list of hosts.
19608
19609 The format of the list of hosts is the same as for the &(manualroute)& router.
19610 As well as host names and IP addresses with optional port numbers, as described
19611 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19612 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19613 (see section &<<SECThostshowused>>&).
19614
19615 If the lookup type is not specified, Exim behaves as follows when trying to
19616 find an IP address for each host: First, a DNS lookup is done. If this yields
19617 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19618 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19619 result of the lookup is the result of that call.
19620
19621 .vindex "&$address_data$&"
19622 If the DATA field is set, its value is placed in the &$address_data$&
19623 variable. For example, this return line
19624 .code
19625 accept hosts=x1.y.example:x2.y.example data="rule1"
19626 .endd
19627 routes the address to the default transport, passing a list of two hosts. When
19628 the transport runs, the string &"rule1"& is in &$address_data$&.
19629 .ecindex IIDquerou1
19630 .ecindex IIDquerou2
19631
19632
19633
19634
19635 . ////////////////////////////////////////////////////////////////////////////
19636 . ////////////////////////////////////////////////////////////////////////////
19637
19638 .chapter "The redirect router" "CHAPredirect"
19639 .scindex IIDredrou1 "&(redirect)& router"
19640 .scindex IIDredrou2 "routers" "&(redirect)&"
19641 .cindex "alias file" "in a &(redirect)& router"
19642 .cindex "address redirection" "&(redirect)& router"
19643 The &(redirect)& router handles several kinds of address redirection. Its most
19644 common uses are for resolving local part aliases from a central alias file
19645 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19646 files, but it has many other potential uses. The incoming address can be
19647 redirected in several different ways:
19648
19649 .ilist
19650 It can be replaced by one or more new addresses which are themselves routed
19651 independently.
19652 .next
19653 It can be routed to be delivered to a given file or directory.
19654 .next
19655 It can be routed to be delivered to a specified pipe command.
19656 .next
19657 It can cause an automatic reply to be generated.
19658 .next
19659 It can be forced to fail, optionally with a custom error message.
19660 .next
19661 It can be temporarily deferred, optionally with a custom message.
19662 .next
19663 It can be discarded.
19664 .endlist
19665
19666 The generic &%transport%& option must not be set for &(redirect)& routers.
19667 However, there are some private options which define transports for delivery to
19668 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19669 &%pipe_transport%& and &%reply_transport%& descriptions below.
19670
19671 If success DSNs have been requested
19672 .cindex "DSN" "success"
19673 .cindex "Delivery Status Notification" "success"
19674 redirection triggers one and the DSN options are not passed any further.
19675
19676
19677
19678 .section "Redirection data" "SECID124"
19679 The router operates by interpreting a text string which it obtains either by
19680 expanding the contents of the &%data%& option, or by reading the entire
19681 contents of a file whose name is given in the &%file%& option. These two
19682 options are mutually exclusive. The first is commonly used for handling system
19683 aliases, in a configuration like this:
19684 .code
19685 system_aliases:
19686   driver = redirect
19687   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19688 .endd
19689 If the lookup fails, the expanded string in this example is empty. When the
19690 expansion of &%data%& results in an empty string, the router declines. A forced
19691 expansion failure also causes the router to decline; other expansion failures
19692 cause delivery to be deferred.
19693
19694 A configuration using &%file%& is commonly used for handling users'
19695 &_.forward_& files, like this:
19696 .code
19697 userforward:
19698   driver = redirect
19699   check_local_user
19700   file = $home/.forward
19701   no_verify
19702 .endd
19703 If the file does not exist, or causes no action to be taken (for example, it is
19704 empty or consists only of comments), the router declines. &*Warning*&: This
19705 is not the case when the file contains syntactically valid items that happen to
19706 yield empty addresses, for example, items containing only RFC 2822 address
19707 comments.
19708
19709
19710
19711 .section "Forward files and address verification" "SECID125"
19712 .cindex "address redirection" "while verifying"
19713 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19714 &_.forward_& files, as in the example above. There are two reasons for this:
19715
19716 .ilist
19717 When Exim is receiving an incoming SMTP message from a remote host, it is
19718 running under the Exim uid, not as root. Exim is unable to change uid to read
19719 the file as the user, and it may not be able to read it as the Exim user. So in
19720 practice the router may not be able to operate.
19721 .next
19722 However, even when the router can operate, the existence of a &_.forward_& file
19723 is unimportant when verifying an address. What should be checked is whether the
19724 local part is a valid user name or not. Cutting out the redirection processing
19725 saves some resources.
19726 .endlist
19727
19728
19729
19730
19731
19732
19733 .section "Interpreting redirection data" "SECID126"
19734 .cindex "Sieve filter" "specifying in redirection data"
19735 .cindex "filter" "specifying in redirection data"
19736 The contents of the data string, whether obtained from &%data%& or &%file%&,
19737 can be interpreted in two different ways:
19738
19739 .ilist
19740 If the &%allow_filter%& option is set true, and the data begins with the text
19741 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19742 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19743 respectively. Details of the syntax and semantics of filter files are described
19744 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19745 document is intended for use by end users.
19746 .next
19747 Otherwise, the data must be a comma-separated list of redirection items, as
19748 described in the next section.
19749 .endlist
19750
19751 When a message is redirected to a file (a &"mail folder"&), the file name given
19752 in a non-filter redirection list must always be an absolute path. A filter may
19753 generate a relative path &-- how this is handled depends on the transport's
19754 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19755 for the &(appendfile)& transport.
19756
19757
19758
19759 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19760 .cindex "address redirection" "non-filter list items"
19761 When the redirection data is not an Exim or Sieve filter, for example, if it
19762 comes from a conventional alias or forward file, it consists of a list of
19763 addresses, file names, pipe commands, or certain special items (see section
19764 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19765 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19766 depending on their default values. The items in the list are separated by
19767 commas or newlines.
19768 If a comma is required in an item, the entire item must be enclosed in double
19769 quotes.
19770
19771 Lines starting with a # character are comments, and are ignored, and # may
19772 also appear following a comma, in which case everything between the # and the
19773 next newline character is ignored.
19774
19775 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19776 double quotes are retained because some forms of mail address require their use
19777 (but never to enclose the entire address). In the following description,
19778 &"item"& refers to what remains after any surrounding double quotes have been
19779 removed.
19780
19781 .vindex "&$local_part$&"
19782 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19783 and the expansion contains a reference to &$local_part$&, you should make use
19784 of the &%quote_local_part%& expansion operator, in case the local part contains
19785 special characters. For example, to redirect all mail for the domain
19786 &'obsolete.example'&, retaining the existing local part, you could use this
19787 setting:
19788 .code
19789 data = ${quote_local_part:$local_part}@newdomain.example
19790 .endd
19791
19792
19793 .section "Redirecting to a local mailbox" "SECTredlocmai"
19794 .cindex "routing" "loops in"
19795 .cindex "loop" "while routing, avoidance of"
19796 .cindex "address redirection" "to local mailbox"
19797 A redirection item may safely be the same as the address currently under
19798 consideration. This does not cause a routing loop, because a router is
19799 automatically skipped if any ancestor of the address that is being processed
19800 is the same as the current address and was processed by the current router.
19801 Such an address is therefore passed to the following routers, so it is handled
19802 as if there were no redirection. When making this loop-avoidance test, the
19803 complete local part, including any prefix or suffix, is used.
19804
19805 .cindex "address redirection" "local part without domain"
19806 Specifying the same local part without a domain is a common usage in personal
19807 filter files when the user wants to have messages delivered to the local
19808 mailbox and also forwarded elsewhere. For example, the user whose login is
19809 &'cleo'& might have a &_.forward_& file containing this:
19810 .code
19811 cleo, cleopatra@egypt.example
19812 .endd
19813 .cindex "backslash in alias file"
19814 .cindex "alias file" "backslash in"
19815 For compatibility with other MTAs, such unqualified local parts may be
19816 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19817 it does make a difference if more than one domain is being handled
19818 synonymously.
19819
19820 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19821 2822 address that does not include a domain, the item is qualified using the
19822 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19823 addresses are qualified using the value in &%qualify_recipient%&, but you can
19824 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19825
19826 Care must be taken if there are alias names for local users.
19827 Consider an MTA handling a single local domain where the system alias file
19828 contains:
19829 .code
19830 Sam.Reman: spqr
19831 .endd
19832 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19833 messages in the local mailbox, and also forward copies elsewhere. He creates
19834 this forward file:
19835 .code
19836 Sam.Reman, spqr@reme.elsewhere.example
19837 .endd
19838 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19839 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19840 second time round, because it has previously routed it,
19841 and the following routers presumably cannot handle the alias. The forward file
19842 should really contain
19843 .code
19844 spqr, spqr@reme.elsewhere.example
19845 .endd
19846 but because this is such a common error, the &%check_ancestor%& option (see
19847 below) exists to provide a way to get round it. This is normally set on a
19848 &(redirect)& router that is handling users' &_.forward_& files.
19849
19850
19851
19852 .section "Special items in redirection lists" "SECTspecitredli"
19853 In addition to addresses, the following types of item may appear in redirection
19854 lists (that is, in non-filter redirection data):
19855
19856 .ilist
19857 .cindex "pipe" "in redirection list"
19858 .cindex "address redirection" "to pipe"
19859 An item is treated as a pipe command if it begins with &"|"& and does not parse
19860 as a valid RFC 2822 address that includes a domain. A transport for running the
19861 command must be specified by the &%pipe_transport%& option.
19862 Normally, either the router or the transport specifies a user and a group under
19863 which to run the delivery. The default is to use the Exim user and group.
19864
19865 Single or double quotes can be used for enclosing the individual arguments of
19866 the pipe command; no interpretation of escapes is done for single quotes. If
19867 the command contains a comma character, it is necessary to put the whole item
19868 in double quotes, for example:
19869 .code
19870 "|/some/command ready,steady,go"
19871 .endd
19872 since items in redirection lists are terminated by commas. Do not, however,
19873 quote just the command. An item such as
19874 .code
19875 |"/some/command ready,steady,go"
19876 .endd
19877 is interpreted as a pipe with a rather strange command name, and no arguments.
19878
19879 Note that the above example assumes that the text comes from a lookup source
19880 of some sort, so that the quotes are part of the data.  If composing a
19881 redirect router with a &%data%& option directly specifying this command, the
19882 quotes will be used by the configuration parser to define the extent of one
19883 string, but will not be passed down into the redirect router itself.  There
19884 are two main approaches to get around this: escape quotes to be part of the
19885 data itself, or avoid using this mechanism and instead create a custom
19886 transport with the &%command%& option set and reference that transport from
19887 an &%accept%& router.
19888
19889 .next
19890 .cindex "file" "in redirection list"
19891 .cindex "address redirection" "to file"
19892 An item is interpreted as a path name if it begins with &"/"& and does not
19893 parse as a valid RFC 2822 address that includes a domain. For example,
19894 .code
19895 /home/world/minbari
19896 .endd
19897 is treated as a file name, but
19898 .code
19899 /s=molari/o=babylon/@x400gate.way
19900 .endd
19901 is treated as an address. For a file name, a transport must be specified using
19902 the &%file_transport%& option. However, if the generated path name ends with a
19903 forward slash character, it is interpreted as a directory name rather than a
19904 file name, and &%directory_transport%& is used instead.
19905
19906 Normally, either the router or the transport specifies a user and a group under
19907 which to run the delivery. The default is to use the Exim user and group.
19908
19909 .cindex "&_/dev/null_&"
19910 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19911 bypassed at a high level, and the log entry shows &"**bypassed**"&
19912 instead of a transport name. In this case the user and group are not used.
19913
19914 .next
19915 .cindex "included address list"
19916 .cindex "address redirection" "included external list"
19917 If an item is of the form
19918 .code
19919 :include:<path name>
19920 .endd
19921 a list of further items is taken from the given file and included at that
19922 point. &*Note*&: Such a file can not be a filter file; it is just an
19923 out-of-line addition to the list. The items in the included list are separated
19924 by commas or newlines and are not subject to expansion. If this is the first
19925 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19926 the alias name. This example is incorrect:
19927 .code
19928 list1    :include:/opt/lists/list1
19929 .endd
19930 It must be given as
19931 .code
19932 list1:   :include:/opt/lists/list1
19933 .endd
19934 .next
19935 .cindex "address redirection" "to black hole"
19936 .cindex "delivery" "discard"
19937 .cindex "delivery" "blackhole"
19938 .cindex "black hole"
19939 .cindex "abandoning mail"
19940 Sometimes you want to throw away mail to a particular local part.  Making the
19941 &%data%& option expand to an empty string does not work, because that causes
19942 the router to decline. Instead, the alias item
19943 .code
19944 :blackhole:
19945 .endd
19946 can be used. It does what its name implies. No delivery is
19947 done, and no error message is generated. This has the same effect as specifying
19948 &_/dev/null_& as a destination, but it can be independently disabled.
19949
19950 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19951 delivery is done for the original local part, even if other redirection items
19952 are present. If you are generating a multi-item list (for example, by reading a
19953 database) and need the ability to provide a no-op item, you must use
19954 &_/dev/null_&.
19955
19956 .next
19957 .cindex "delivery" "forcing failure"
19958 .cindex "delivery" "forcing deferral"
19959 .cindex "failing delivery" "forcing"
19960 .cindex "deferred delivery, forcing"
19961 .cindex "customizing" "failure message"
19962 An attempt to deliver a particular address can be deferred or forced to fail by
19963 redirection items of the form
19964 .code
19965 :defer:
19966 :fail:
19967 .endd
19968 respectively. When a redirection list contains such an item, it applies
19969 to the entire redirection; any other items in the list are ignored. Any
19970 text following &':fail:'& or &':defer:'& is placed in the error text
19971 associated with the failure. For example, an alias file might contain:
19972 .code
19973 X.Employee:  :fail: Gone away, no forwarding address
19974 .endd
19975 In the case of an address that is being verified from an ACL or as the subject
19976 of a
19977 .cindex "VRFY" "error text, display of"
19978 VRFY command, the text is included in the SMTP error response by
19979 default.
19980 .cindex "EXPN" "error text, display of"
19981 The text is not included in the response to an EXPN command. In non-SMTP cases
19982 the text is included in the error message that Exim generates.
19983
19984 .cindex "SMTP" "error codes"
19985 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19986 &':fail:'&. However, if the message starts with three digits followed by a
19987 space, optionally followed by an extended code of the form &'n.n.n'&, also
19988 followed by a space, and the very first digit is the same as the default error
19989 code, the code from the message is used instead. If the very first digit is
19990 incorrect, a panic error is logged, and the default code is used. You can
19991 suppress the use of the supplied code in a redirect router by setting the
19992 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19993 ignored.
19994
19995 .vindex "&$acl_verify_message$&"
19996 In an ACL, an explicitly provided message overrides the default, but the
19997 default message is available in the variable &$acl_verify_message$& and can
19998 therefore be included in a custom message if this is desired.
19999
20000 Normally the error text is the rest of the redirection list &-- a comma does
20001 not terminate it &-- but a newline does act as a terminator. Newlines are not
20002 normally present in alias expansions. In &(lsearch)& lookups they are removed
20003 as part of the continuation process, but they may exist in other kinds of
20004 lookup and in &':include:'& files.
20005
20006 During routing for message delivery (as opposed to verification), a redirection
20007 containing &':fail:'& causes an immediate failure of the incoming address,
20008 whereas &':defer:'& causes the message to remain on the queue so that a
20009 subsequent delivery attempt can happen at a later time. If an address is
20010 deferred for too long, it will ultimately fail, because the normal retry
20011 rules still apply.
20012
20013 .next
20014 .cindex "alias file" "exception to default"
20015 Sometimes it is useful to use a single-key search type with a default (see
20016 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20017 for exceptions to the default. These can be handled by aliasing them to
20018 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20019 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20020 results in an empty redirection list has the same effect.
20021 .endlist
20022
20023
20024 .section "Duplicate addresses" "SECTdupaddr"
20025 .cindex "duplicate addresses"
20026 .cindex "address duplicate, discarding"
20027 .cindex "pipe" "duplicated"
20028 Exim removes duplicate addresses from the list to which it is delivering, so as
20029 to deliver just one copy to each address. This does not apply to deliveries
20030 routed to pipes by different immediate parent addresses, but an indirect
20031 aliasing scheme of the type
20032 .code
20033 pipe:       |/some/command $local_part
20034 localpart1: pipe
20035 localpart2: pipe
20036 .endd
20037 does not work with a message that is addressed to both local parts, because
20038 when the second is aliased to the intermediate local part &"pipe"& it gets
20039 discarded as being the same as a previously handled address. However, a scheme
20040 such as
20041 .code
20042 localpart1: |/some/command $local_part
20043 localpart2: |/some/command $local_part
20044 .endd
20045 does result in two different pipe deliveries, because the immediate parents of
20046 the pipes are distinct.
20047
20048
20049
20050 .section "Repeated redirection expansion" "SECID128"
20051 .cindex "repeated redirection expansion"
20052 .cindex "address redirection" "repeated for each delivery attempt"
20053 When a message cannot be delivered to all of its recipients immediately,
20054 leading to two or more delivery attempts, redirection expansion is carried out
20055 afresh each time for those addresses whose children were not all previously
20056 delivered. If redirection is being used as a mailing list, this can lead to new
20057 members of the list receiving copies of old messages. The &%one_time%& option
20058 can be used to avoid this.
20059
20060
20061 .section "Errors in redirection lists" "SECID129"
20062 .cindex "address redirection" "errors"
20063 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20064 error is skipped, and an entry is written to the main log. This may be useful
20065 for mailing lists that are automatically managed. Otherwise, if an error is
20066 detected while generating the list of new addresses, the original address is
20067 deferred. See also &%syntax_errors_to%&.
20068
20069
20070
20071 .section "Private options for the redirect router" "SECID130"
20072
20073 .cindex "options" "&(redirect)& router"
20074 The private options for the &(redirect)& router are as follows:
20075
20076
20077 .option allow_defer redirect boolean false
20078 Setting this option allows the use of &':defer:'& in non-filter redirection
20079 data, or the &%defer%& command in an Exim filter file.
20080
20081
20082 .option allow_fail redirect boolean false
20083 .cindex "failing delivery" "from filter"
20084 If this option is true, the &':fail:'& item can be used in a redirection list,
20085 and the &%fail%& command may be used in an Exim filter file.
20086
20087
20088 .option allow_filter redirect boolean false
20089 .cindex "filter" "enabling use of"
20090 .cindex "Sieve filter" "enabling use of"
20091 Setting this option allows Exim to interpret redirection data that starts with
20092 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20093 are some features of Exim filter files that some administrators may wish to
20094 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20095
20096 It is also possible to lock out Exim filters or Sieve filters while allowing
20097 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20098
20099
20100 The filter is run using the uid and gid set by the generic &%user%& and
20101 &%group%& options. These take their defaults from the password data if
20102 &%check_local_user%& is set, so in the normal case of users' personal filter
20103 files, the filter is run as the relevant user. When &%allow_filter%& is set
20104 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20105
20106
20107
20108 .option allow_freeze redirect boolean false
20109 .cindex "freezing messages" "allowing in filter"
20110 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20111 This command is more normally encountered in system filters, and is disabled by
20112 default for redirection filters because it isn't something you usually want to
20113 let ordinary users do.
20114
20115
20116
20117 .option check_ancestor redirect boolean false
20118 This option is concerned with handling generated addresses that are the same
20119 as some address in the list of redirection ancestors of the current address.
20120 Although it is turned off by default in the code, it is set in the default
20121 configuration file for handling users' &_.forward_& files. It is recommended
20122 for this use of the &(redirect)& router.
20123
20124 When &%check_ancestor%& is set, if a generated address (including the domain)
20125 is the same as any ancestor of the current address, it is replaced by a copy of
20126 the current address. This helps in the case where local part A is aliased to B,
20127 and B has a &_.forward_& file pointing back to A. For example, within a single
20128 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20129 &_&~jb/.forward_& contains:
20130 .code
20131 \Joe.Bloggs, <other item(s)>
20132 .endd
20133 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20134 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20135 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20136 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20137 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20138 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20139 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20140 original address. See also the &%repeat_use%& option below.
20141
20142
20143 .option check_group redirect boolean "see below"
20144 When the &%file%& option is used, the group owner of the file is checked only
20145 when this option is set. The permitted groups are those listed in the
20146 &%owngroups%& option, together with the user's default group if
20147 &%check_local_user%& is set. If the file has the wrong group, routing is
20148 deferred. The default setting for this option is true if &%check_local_user%&
20149 is set and the &%modemask%& option permits the group write bit, or if the
20150 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20151
20152
20153
20154 .option check_owner redirect boolean "see below"
20155 When the &%file%& option is used, the owner of the file is checked only when
20156 this option is set. If &%check_local_user%& is set, the local user is
20157 permitted; otherwise the owner must be one of those listed in the &%owners%&
20158 option. The default value for this option is true if &%check_local_user%& or
20159 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20160
20161
20162 .option data redirect string&!! unset
20163 This option is mutually exclusive with &%file%&. One or other of them must be
20164 set, but not both. The contents of &%data%& are expanded, and then used as the
20165 list of forwarding items, or as a set of filtering instructions. If the
20166 expansion is forced to fail, or the result is an empty string or a string that
20167 has no effect (consists entirely of comments), the router declines.
20168
20169 When filtering instructions are used, the string must begin with &"#Exim
20170 filter"&, and all comments in the string, including this initial one, must be
20171 terminated with newline characters. For example:
20172 .code
20173 data = #Exim filter\n\
20174        if $h_to: contains Exim then save $home/mail/exim endif
20175 .endd
20176 If you are reading the data from a database where newlines cannot be included,
20177 you can use the &${sg}$& expansion item to turn the escape string of your
20178 choice into a newline.
20179
20180
20181 .option directory_transport redirect string&!! unset
20182 A &(redirect)& router sets up a direct delivery to a directory when a path name
20183 ending with a slash is specified as a new &"address"&. The transport used is
20184 specified by this option, which, after expansion, must be the name of a
20185 configured transport. This should normally be an &(appendfile)& transport.
20186
20187
20188 .option file redirect string&!! unset
20189 This option specifies the name of a file that contains the redirection data. It
20190 is mutually exclusive with the &%data%& option. The string is expanded before
20191 use; if the expansion is forced to fail, the router declines. Other expansion
20192 failures cause delivery to be deferred. The result of a successful expansion
20193 must be an absolute path. The entire file is read and used as the redirection
20194 data. If the data is an empty string or a string that has no effect (consists
20195 entirely of comments), the router declines.
20196
20197 .cindex "NFS" "checking for file existence"
20198 If the attempt to open the file fails with a &"does not exist"& error, Exim
20199 runs a check on the containing directory,
20200 unless &%ignore_enotdir%& is true (see below).
20201 If the directory does not appear to exist, delivery is deferred. This can
20202 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20203 is a mount problem. If the containing directory does exist, but the file does
20204 not, the router declines.
20205
20206
20207 .option file_transport redirect string&!! unset
20208 .vindex "&$address_file$&"
20209 A &(redirect)& router sets up a direct delivery to a file when a path name not
20210 ending in a slash is specified as a new &"address"&. The transport used is
20211 specified by this option, which, after expansion, must be the name of a
20212 configured transport. This should normally be an &(appendfile)& transport. When
20213 it is running, the file name is in &$address_file$&.
20214
20215
20216 .option filter_prepend_home redirect boolean true
20217 When this option is true, if a &(save)& command in an Exim filter specifies a
20218 relative path, and &$home$& is defined, it is automatically prepended to the
20219 relative path. If this option is set false, this action does not happen. The
20220 relative path is then passed to the transport unmodified.
20221
20222
20223 .option forbid_blackhole redirect boolean false
20224 If this option is true, the &':blackhole:'& item may not appear in a
20225 redirection list.
20226
20227
20228 .option forbid_exim_filter redirect boolean false
20229 If this option is set true, only Sieve filters are permitted when
20230 &%allow_filter%& is true.
20231
20232
20233
20234
20235 .option forbid_file redirect boolean false
20236 .cindex "delivery" "to file; forbidding"
20237 .cindex "Sieve filter" "forbidding delivery to a file"
20238 .cindex "Sieve filter" "&""keep""& facility; disabling"
20239 If this option is true, this router may not generate a new address that
20240 specifies delivery to a local file or directory, either from a filter or from a
20241 conventional forward file. This option is forced to be true if &%one_time%& is
20242 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20243 locks out the Sieve's &"keep"& facility.
20244
20245
20246 .option forbid_filter_dlfunc redirect boolean false
20247 .cindex "filter" "locking out certain features"
20248 If this option is true, string expansions in Exim filters are not allowed to
20249 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20250 functions.
20251
20252 .option forbid_filter_existstest redirect boolean false
20253 .cindex "expansion" "statting a file"
20254 If this option is true, string expansions in Exim filters are not allowed to
20255 make use of the &%exists%& condition or the &%stat%& expansion item.
20256
20257 .option forbid_filter_logwrite redirect boolean false
20258 If this option is true, use of the logging facility in Exim filters is not
20259 permitted. Logging is in any case available only if the filter is being run
20260 under some unprivileged uid (which is normally the case for ordinary users'
20261 &_.forward_& files).
20262
20263
20264 .option forbid_filter_lookup redirect boolean false
20265 If this option is true, string expansions in Exim filter files are not allowed
20266 to make use of &%lookup%& items.
20267
20268
20269 .option forbid_filter_perl redirect boolean false
20270 This option has an effect only if Exim is built with embedded Perl support. If
20271 it is true, string expansions in Exim filter files are not allowed to make use
20272 of the embedded Perl support.
20273
20274
20275 .option forbid_filter_readfile redirect boolean false
20276 If this option is true, string expansions in Exim filter files are not allowed
20277 to make use of &%readfile%& items.
20278
20279
20280 .option forbid_filter_readsocket redirect boolean false
20281 If this option is true, string expansions in Exim filter files are not allowed
20282 to make use of &%readsocket%& items.
20283
20284
20285 .option forbid_filter_reply redirect boolean false
20286 If this option is true, this router may not generate an automatic reply
20287 message. Automatic replies can be generated only from Exim or Sieve filter
20288 files, not from traditional forward files. This option is forced to be true if
20289 &%one_time%& is set.
20290
20291
20292 .option forbid_filter_run redirect boolean false
20293 If this option is true, string expansions in Exim filter files are not allowed
20294 to make use of &%run%& items.
20295
20296
20297 .option forbid_include redirect boolean false
20298 If this option is true, items of the form
20299 .code
20300 :include:<path name>
20301 .endd
20302 are not permitted in non-filter redirection lists.
20303
20304
20305 .option forbid_pipe redirect boolean false
20306 .cindex "delivery" "to pipe; forbidding"
20307 If this option is true, this router may not generate a new address which
20308 specifies delivery to a pipe, either from an Exim filter or from a conventional
20309 forward file. This option is forced to be true if &%one_time%& is set.
20310
20311
20312 .option forbid_sieve_filter redirect boolean false
20313 If this option is set true, only Exim filters are permitted when
20314 &%allow_filter%& is true.
20315
20316
20317 .cindex "SMTP" "error codes"
20318 .option forbid_smtp_code redirect boolean false
20319 If this option is set true, any SMTP error codes that are present at the start
20320 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20321 the default codes (451 and 550, respectively) are always used.
20322
20323
20324
20325
20326 .option hide_child_in_errmsg redirect boolean false
20327 .cindex "bounce message" "redirection details; suppressing"
20328 If this option is true, it prevents Exim from quoting a child address if it
20329 generates a bounce or delay message for it. Instead it says &"an address
20330 generated from <&'the top level address'&>"&. Of course, this applies only to
20331 bounces generated locally. If a message is forwarded to another host, &'its'&
20332 bounce may well quote the generated address.
20333
20334
20335 .option ignore_eacces redirect boolean false
20336 .cindex "EACCES"
20337 If this option is set and an attempt to open a redirection file yields the
20338 EACCES error (permission denied), the &(redirect)& router behaves as if the
20339 file did not exist.
20340
20341
20342 .option ignore_enotdir redirect boolean false
20343 .cindex "ENOTDIR"
20344 If this option is set and an attempt to open a redirection file yields the
20345 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20346 router behaves as if the file did not exist.
20347
20348 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20349 router that has the &%file%& option set discovers that the file does not exist
20350 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20351 against unmounted NFS directories. If the parent can not be statted, delivery
20352 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20353 is set, because that option tells Exim to ignore &"something on the path is not
20354 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20355 that some operating systems give ENOENT where others give ENOTDIR.
20356
20357
20358
20359 .option include_directory redirect string unset
20360 If this option is set, the path names of any &':include:'& items in a
20361 redirection list must start with this directory.
20362
20363
20364 .option modemask redirect "octal integer" 022
20365 This specifies mode bits which must not be set for a file specified by the
20366 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20367
20368
20369 .option one_time redirect boolean false
20370 .cindex "one-time aliasing/forwarding expansion"
20371 .cindex "alias file" "one-time expansion"
20372 .cindex "forward file" "one-time expansion"
20373 .cindex "mailing lists" "one-time expansion"
20374 .cindex "address redirection" "one-time expansion"
20375 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20376 files each time it tries to deliver a message causes a problem when one or more
20377 of the generated addresses fails be delivered at the first attempt. The problem
20378 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20379 but of what happens when the redirection list changes during the time that the
20380 message is on Exim's queue. This is particularly true in the case of mailing
20381 lists, where new subscribers might receive copies of messages that were posted
20382 before they subscribed.
20383
20384 If &%one_time%& is set and any addresses generated by the router fail to
20385 deliver at the first attempt, the failing addresses are added to the message as
20386 &"top level"& addresses, and the parent address that generated them is marked
20387 &"delivered"&. Thus, redirection does not happen again at the next delivery
20388 attempt.
20389
20390 &*Warning 1*&: Any header line addition or removal that is specified by this
20391 router would be lost if delivery did not succeed at the first attempt. For this
20392 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20393 permitted when &%one_time%& is set.
20394
20395 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20396 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20397 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20398
20399 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20400 &%one_time%&.
20401
20402 The original top-level address is remembered with each of the generated
20403 addresses, and is output in any log messages. However, any intermediate parent
20404 addresses are not recorded. This makes a difference to the log only if
20405 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20406 typically be used for mailing lists, where there is normally just one level of
20407 expansion.
20408
20409
20410 .option owners redirect "string list" unset
20411 .cindex "ownership" "alias file"
20412 .cindex "ownership" "forward file"
20413 .cindex "alias file" "ownership"
20414 .cindex "forward file" "ownership"
20415 This specifies a list of permitted owners for the file specified by &%file%&.
20416 This list is in addition to the local user when &%check_local_user%& is set.
20417 See &%check_owner%& above.
20418
20419
20420 .option owngroups redirect "string list" unset
20421 This specifies a list of permitted groups for the file specified by &%file%&.
20422 The list is in addition to the local user's primary group when
20423 &%check_local_user%& is set. See &%check_group%& above.
20424
20425
20426 .option pipe_transport redirect string&!! unset
20427 .vindex "&$address_pipe$&"
20428 A &(redirect)& router sets up a direct delivery to a pipe when a string
20429 starting with a vertical bar character is specified as a new &"address"&. The
20430 transport used is specified by this option, which, after expansion, must be the
20431 name of a configured transport. This should normally be a &(pipe)& transport.
20432 When the transport is run, the pipe command is in &$address_pipe$&.
20433
20434
20435 .option qualify_domain redirect string&!! unset
20436 .vindex "&$qualify_recipient$&"
20437 If this option is set, and an unqualified address (one without a domain) is
20438 generated, and that address would normally be qualified by the global setting
20439 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20440 expanding this string. If the expansion fails, the router declines. If you want
20441 to revert to the default, you can have the expansion generate
20442 &$qualify_recipient$&.
20443
20444 This option applies to all unqualified addresses generated by Exim filters,
20445 but for traditional &_.forward_& files, it applies only to addresses that are
20446 not preceded by a backslash. Sieve filters cannot generate unqualified
20447 addresses.
20448
20449 .option qualify_preserve_domain redirect boolean false
20450 .cindex "domain" "in redirection; preserving"
20451 .cindex "preserving domain in redirection"
20452 .cindex "address redirection" "domain; preserving"
20453 If this option is set, the router's local &%qualify_domain%& option must not be
20454 set (a configuration error occurs if it is). If an unqualified address (one
20455 without a domain) is generated, it is qualified with the domain of the parent
20456 address (the immediately preceding ancestor) instead of the global
20457 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20458 this applies whether or not the address is preceded by a backslash.
20459
20460
20461 .option repeat_use redirect boolean true
20462 If this option is set false, the router is skipped for a child address that has
20463 any ancestor that was routed by this router. This test happens before any of
20464 the other preconditions are tested. Exim's default anti-looping rules skip
20465 only when the ancestor is the same as the current address. See also
20466 &%check_ancestor%& above and the generic &%redirect_router%& option.
20467
20468
20469 .option reply_transport redirect string&!! unset
20470 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20471 &%vacation%& command is used in a filter file. The transport used is specified
20472 by this option, which, after expansion, must be the name of a configured
20473 transport. This should normally be an &(autoreply)& transport. Other transports
20474 are unlikely to do anything sensible or useful.
20475
20476
20477 .option rewrite redirect boolean true
20478 .cindex "address redirection" "disabling rewriting"
20479 If this option is set false, addresses generated by the router are not
20480 subject to address rewriting. Otherwise, they are treated like new addresses
20481 and are rewritten according to the global rewriting rules.
20482
20483
20484 .option sieve_subaddress redirect string&!! unset
20485 The value of this option is passed to a Sieve filter to specify the
20486 :subaddress part of an address.
20487
20488 .option sieve_useraddress redirect string&!! unset
20489 The value of this option is passed to a Sieve filter to specify the :user part
20490 of an address. However, if it is unset, the entire original local part
20491 (including any prefix or suffix) is used for :user.
20492
20493
20494 .option sieve_vacation_directory redirect string&!! unset
20495 .cindex "Sieve filter" "vacation directory"
20496 To enable the &"vacation"& extension for Sieve filters, you must set
20497 &%sieve_vacation_directory%& to the directory where vacation databases are held
20498 (do not put anything else in that directory), and ensure that the
20499 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20500 needs their own directory; Exim will create it if necessary.
20501
20502
20503
20504 .option skip_syntax_errors redirect boolean false
20505 .cindex "forward file" "broken"
20506 .cindex "address redirection" "broken files"
20507 .cindex "alias file" "broken"
20508 .cindex "broken alias or forward files"
20509 .cindex "ignoring faulty addresses"
20510 .cindex "skipping faulty addresses"
20511 .cindex "error" "skipping bad syntax"
20512 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20513 non-filter redirection data are skipped, and each failing address is logged. If
20514 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20515 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20516 are expanded and placed at the head of the error message generated by
20517 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20518 be the same address as the generic &%errors_to%& option. The
20519 &%skip_syntax_errors%& option is often used when handling mailing lists.
20520
20521 If all the addresses in a redirection list are skipped because of syntax
20522 errors, the router declines to handle the original address, and it is passed to
20523 the following routers.
20524
20525 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20526 error in the filter causes filtering to be abandoned without any action being
20527 taken. The incident is logged, and the router declines to handle the address,
20528 so it is passed to the following routers.
20529
20530 .cindex "Sieve filter" "syntax errors in"
20531 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20532 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20533 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20534
20535 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20536 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20537 option, used with an address that does not get redirected, can be used to
20538 notify users of these errors, by means of a router like this:
20539 .code
20540 userforward:
20541   driver = redirect
20542   allow_filter
20543   check_local_user
20544   file = $home/.forward
20545   file_transport = address_file
20546   pipe_transport = address_pipe
20547   reply_transport = address_reply
20548   no_verify
20549   skip_syntax_errors
20550   syntax_errors_to = real-$local_part@$domain
20551   syntax_errors_text = \
20552    This is an automatically generated message. An error has\n\
20553    been found in your .forward file. Details of the error are\n\
20554    reported below. While this error persists, you will receive\n\
20555    a copy of this message for every message that is addressed\n\
20556    to you. If your .forward file is a filter file, or if it is\n\
20557    a non-filter file containing no valid forwarding addresses,\n\
20558    a copy of each incoming message will be put in your normal\n\
20559    mailbox. If a non-filter file contains at least one valid\n\
20560    forwarding address, forwarding to the valid addresses will\n\
20561    happen, and those will be the only deliveries that occur.
20562 .endd
20563 You also need a router to ensure that local addresses that are prefixed by
20564 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20565 put this immediately before the &(userforward)& router:
20566 .code
20567 real_localuser:
20568   driver = accept
20569   check_local_user
20570   local_part_prefix = real-
20571   transport = local_delivery
20572 .endd
20573 For security, it would probably be a good idea to restrict the use of this
20574 router to locally-generated messages, using a condition such as this:
20575 .code
20576   condition = ${if match {$sender_host_address}\
20577                          {\N^(|127\.0\.0\.1)$\N}}
20578 .endd
20579
20580
20581 .option syntax_errors_text redirect string&!! unset
20582 See &%skip_syntax_errors%& above.
20583
20584
20585 .option syntax_errors_to redirect string unset
20586 See &%skip_syntax_errors%& above.
20587 .ecindex IIDredrou1
20588 .ecindex IIDredrou2
20589
20590
20591
20592
20593
20594
20595 . ////////////////////////////////////////////////////////////////////////////
20596 . ////////////////////////////////////////////////////////////////////////////
20597
20598 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20599          "Environment for local transports"
20600 .scindex IIDenvlotra1 "local transports" "environment for"
20601 .scindex IIDenvlotra2 "environment" "local transports"
20602 .scindex IIDenvlotra3 "transport" "local; environment for"
20603 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20604 transport can be thought of as similar to a pipe.) Exim always runs transports
20605 in subprocesses, under specified uids and gids. Typical deliveries to local
20606 mailboxes run under the uid and gid of the local user.
20607
20608 Exim also sets a specific current directory while running the transport; for
20609 some transports a home directory setting is also relevant. The &(pipe)&
20610 transport is the only one that sets up environment variables; see section
20611 &<<SECTpipeenv>>& for details.
20612
20613 The values used for the uid, gid, and the directories may come from several
20614 different places. In many cases, the router that handles the address associates
20615 settings with that address as a result of its &%check_local_user%&, &%group%&,
20616 or &%user%& options. However, values may also be given in the transport's own
20617 configuration, and these override anything that comes from the router.
20618
20619
20620
20621 .section "Concurrent deliveries" "SECID131"
20622 .cindex "concurrent deliveries"
20623 .cindex "simultaneous deliveries"
20624 If two different messages for the same local recipient arrive more or less
20625 simultaneously, the two delivery processes are likely to run concurrently. When
20626 the &(appendfile)& transport is used to write to a file, Exim applies locking
20627 rules to stop concurrent processes from writing to the same file at the same
20628 time.
20629
20630 However, when you use a &(pipe)& transport, it is up to you to arrange any
20631 locking that is needed. Here is a silly example:
20632 .code
20633 my_transport:
20634   driver = pipe
20635   command = /bin/sh -c 'cat >>/some/file'
20636 .endd
20637 This is supposed to write the message at the end of the file. However, if two
20638 messages arrive at the same time, the file will be scrambled. You can use the
20639 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20640 file using the same algorithm that Exim itself uses.
20641
20642
20643
20644
20645 .section "Uids and gids" "SECTenvuidgid"
20646 .cindex "local transports" "uid and gid"
20647 .cindex "transport" "local; uid and gid"
20648 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20649 overrides any group that the router set in the address, even if &%user%& is not
20650 set for the transport. This makes it possible, for example, to run local mail
20651 delivery under the uid of the recipient (set by the router), but in a special
20652 group (set by the transport). For example:
20653 .code
20654 # Routers ...
20655 # User/group are set by check_local_user in this router
20656 local_users:
20657   driver = accept
20658   check_local_user
20659   transport = group_delivery
20660
20661 # Transports ...
20662 # This transport overrides the group
20663 group_delivery:
20664   driver = appendfile
20665   file = /var/spool/mail/$local_part
20666   group = mail
20667 .endd
20668 If &%user%& is set for a transport, its value overrides what is set in the
20669 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20670 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20671 set.
20672
20673 .oindex "&%initgroups%&"
20674 When the uid is taken from the transport's configuration, the &[initgroups()]&
20675 function is called for the groups associated with that uid if the
20676 &%initgroups%& option is set for the transport. When the uid is not specified
20677 by the transport, but is associated with the address by a router, the option
20678 for calling &[initgroups()]& is taken from the router configuration.
20679
20680 .cindex "&(pipe)& transport" "uid for"
20681 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20682 is set and &%user%& is not set, the uid of the process that called Exim to
20683 receive the message is used, and if &%group%& is not set, the corresponding
20684 original gid is also used.
20685
20686 This is the detailed preference order for obtaining a gid; the first of the
20687 following that is set is used:
20688
20689 .ilist
20690 A &%group%& setting of the transport;
20691 .next
20692 A &%group%& setting of the router;
20693 .next
20694 A gid associated with a user setting of the router, either as a result of
20695 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20696 .next
20697 The group associated with a non-numeric &%user%& setting of the transport;
20698 .next
20699 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20700 the uid is the creator's uid;
20701 .next
20702 The Exim gid if the Exim uid is being used as a default.
20703 .endlist
20704
20705 If, for example, the user is specified numerically on the router and there are
20706 no group settings, no gid is available. In this situation, an error occurs.
20707 This is different for the uid, for which there always is an ultimate default.
20708 The first of the following that is set is used:
20709
20710 .ilist
20711 A &%user%& setting of the transport;
20712 .next
20713 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20714 .next
20715 A &%user%& setting of the router;
20716 .next
20717 A &%check_local_user%& setting of the router;
20718 .next
20719 The Exim uid.
20720 .endlist
20721
20722 Of course, an error will still occur if the uid that is chosen is on the
20723 &%never_users%& list.
20724
20725
20726
20727
20728
20729 .section "Current and home directories" "SECID132"
20730 .cindex "current directory for local transport"
20731 .cindex "home directory" "for local transport"
20732 .cindex "transport" "local; home directory for"
20733 .cindex "transport" "local; current directory for"
20734 Routers may set current and home directories for local transports by means of
20735 the &%transport_current_directory%& and &%transport_home_directory%& options.
20736 However, if the transport's &%current_directory%& or &%home_directory%& options
20737 are set, they override the router's values. In detail, the home directory
20738 for a local transport is taken from the first of these values that is set:
20739
20740 .ilist
20741 The &%home_directory%& option on the transport;
20742 .next
20743 The &%transport_home_directory%& option on the router;
20744 .next
20745 The password data if &%check_local_user%& is set on the router;
20746 .next
20747 The &%router_home_directory%& option on the router.
20748 .endlist
20749
20750 The current directory is taken from the first of these values that is set:
20751
20752 .ilist
20753 The &%current_directory%& option on the transport;
20754 .next
20755 The &%transport_current_directory%& option on the router.
20756 .endlist
20757
20758
20759 If neither the router nor the transport sets a current directory, Exim uses the
20760 value of the home directory, if it is set. Otherwise it sets the current
20761 directory to &_/_& before running a local transport.
20762
20763
20764
20765 .section "Expansion variables derived from the address" "SECID133"
20766 .vindex "&$domain$&"
20767 .vindex "&$local_part$&"
20768 .vindex "&$original_domain$&"
20769 Normally a local delivery is handling a single address, and in that case the
20770 variables such as &$domain$& and &$local_part$& are set during local
20771 deliveries. However, in some circumstances more than one address may be handled
20772 at once (for example, while writing batch SMTP for onward transmission by some
20773 other means). In this case, the variables associated with the local part are
20774 never set, &$domain$& is set only if all the addresses have the same domain,
20775 and &$original_domain$& is never set.
20776 .ecindex IIDenvlotra1
20777 .ecindex IIDenvlotra2
20778 .ecindex IIDenvlotra3
20779
20780
20781
20782
20783
20784
20785
20786 . ////////////////////////////////////////////////////////////////////////////
20787 . ////////////////////////////////////////////////////////////////////////////
20788
20789 .chapter "Generic options for transports" "CHAPtransportgeneric"
20790 .scindex IIDgenoptra1 "generic options" "transport"
20791 .scindex IIDgenoptra2 "options" "generic; for transports"
20792 .scindex IIDgenoptra3 "transport" "generic options for"
20793 The following generic options apply to all transports:
20794
20795
20796 .option body_only transports boolean false
20797 .cindex "transport" "body only"
20798 .cindex "message" "transporting body only"
20799 .cindex "body of message" "transporting"
20800 If this option is set, the message's headers are not transported. It is
20801 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20802 or &(pipe)& transports, the settings of &%message_prefix%& and
20803 &%message_suffix%& should be checked, because this option does not
20804 automatically suppress them.
20805
20806
20807 .option current_directory transports string&!! unset
20808 .cindex "transport" "current directory for"
20809 This specifies the current directory that is to be set while running the
20810 transport, overriding any value that may have been set by the router.
20811 If the expansion fails for any reason, including forced failure, an error is
20812 logged, and delivery is deferred.
20813
20814
20815 .option disable_logging transports boolean false
20816 If this option is set true, nothing is logged for any
20817 deliveries by the transport or for any
20818 transport errors. You should not set this option unless you really, really know
20819 what you are doing.
20820
20821
20822 .option debug_print transports string&!! unset
20823 .cindex "testing" "variables in drivers"
20824 If this option is set and debugging is enabled (see the &%-d%& command line
20825 option), the string is expanded and included in the debugging output when the
20826 transport is run.
20827 If expansion of the string fails, the error message is written to the debugging
20828 output, and Exim carries on processing.
20829 This facility is provided to help with checking out the values of variables and
20830 so on when debugging driver configurations. For example, if a &%headers_add%&
20831 option is not working properly, &%debug_print%& could be used to output the
20832 variables it references. A newline is added to the text if it does not end with
20833 one.
20834 The variables &$transport_name$& and &$router_name$& contain the name of the
20835 transport and the router that called it.
20836
20837 .option delivery_date_add transports boolean false
20838 .cindex "&'Delivery-date:'& header line"
20839 If this option is true, a &'Delivery-date:'& header is added to the message.
20840 This gives the actual time the delivery was made. As this is not a standard
20841 header, Exim has a configuration option (&%delivery_date_remove%&) which
20842 requests its removal from incoming messages, so that delivered messages can
20843 safely be resent to other recipients.
20844
20845
20846 .option driver transports string unset
20847 This specifies which of the available transport drivers is to be used.
20848 There is no default, and this option must be set for every transport.
20849
20850
20851 .option envelope_to_add transports boolean false
20852 .cindex "&'Envelope-to:'& header line"
20853 If this option is true, an &'Envelope-to:'& header is added to the message.
20854 This gives the original address(es) in the incoming envelope that caused this
20855 delivery to happen. More than one address may be present if the transport is
20856 configured to handle several addresses at once, or if more than one original
20857 address was redirected to the same final address. As this is not a standard
20858 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20859 its removal from incoming messages, so that delivered messages can safely be
20860 resent to other recipients.
20861
20862
20863 .option event_action transports string&!! unset
20864 .cindex events
20865 This option declares a string to be expanded for Exim's events mechanism.
20866 For details see &<<CHAPevents>>&.
20867
20868
20869 .option group transports string&!! "Exim group"
20870 .cindex "transport" "group; specifying"
20871 This option specifies a gid for running the transport process, overriding any
20872 value that the router supplies, and also overriding any value associated with
20873 &%user%& (see below).
20874
20875
20876 .option headers_add transports list&!! unset
20877 .cindex "header lines" "adding in transport"
20878 .cindex "transport" "header lines; adding"
20879 This option specifies a list of text headers,
20880 newline-separated (by default, changeable in the usual way),
20881 which are (separately) expanded and added to the header
20882 portion of a message as it is transported, as described in section
20883 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20884 routers. If the result of the expansion is an empty string, or if the expansion
20885 is forced to fail, no action is taken. Other expansion failures are treated as
20886 errors and cause the delivery to be deferred.
20887
20888 Unlike most options, &%headers_add%& can be specified multiple times
20889 for a transport; all listed headers are added.
20890
20891
20892 .option headers_only transports boolean false
20893 .cindex "transport" "header lines only"
20894 .cindex "message" "transporting headers only"
20895 .cindex "header lines" "transporting"
20896 If this option is set, the message's body is not transported. It is mutually
20897 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20898 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20899 checked, since this option does not automatically suppress them.
20900
20901
20902 .option headers_remove transports list&!! unset
20903 .cindex "header lines" "removing"
20904 .cindex "transport" "header lines; removing"
20905 This option specifies a list of header names,
20906 colon-separated (by default, changeable in the usual way);
20907 these headers are omitted from the message as it is transported, as described
20908 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20909 routers.
20910 Each list item is separately expanded.
20911 If the result of the expansion is an empty string, or if the expansion
20912 is forced to fail, no action is taken. Other expansion failures are treated as
20913 errors and cause the delivery to be deferred.
20914
20915 Unlike most options, &%headers_remove%& can be specified multiple times
20916 for a transport; all listed headers are removed.
20917
20918 &*Warning*&: Because of the separate expansion of the list items,
20919 items that contain a list separator must have it doubled.
20920 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20921
20922
20923
20924 .option headers_rewrite transports string unset
20925 .cindex "transport" "header lines; rewriting"
20926 .cindex "rewriting" "at transport time"
20927 This option allows addresses in header lines to be rewritten at transport time,
20928 that is, as the message is being copied to its destination. The contents of the
20929 option are a colon-separated list of rewriting rules. Each rule is in exactly
20930 the same form as one of the general rewriting rules that are applied when a
20931 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20932 example,
20933 .code
20934 headers_rewrite = a@b c@d f : \
20935                   x@y w@z
20936 .endd
20937 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20938 &'w@z'& in all address-bearing header lines. The rules are applied to the
20939 header lines just before they are written out at transport time, so they affect
20940 only those copies of the message that pass through the transport. However, only
20941 the message's original header lines, and any that were added by a system
20942 filter, are rewritten. If a router or transport adds header lines, they are not
20943 affected by this option. These rewriting rules are &'not'& applied to the
20944 envelope. You can change the return path using &%return_path%&, but you cannot
20945 change envelope recipients at this time.
20946
20947
20948 .option home_directory transports string&!! unset
20949 .cindex "transport" "home directory for"
20950 .vindex "&$home$&"
20951 This option specifies a home directory setting for a local transport,
20952 overriding any value that may be set by the router. The home directory is
20953 placed in &$home$& while expanding the transport's private options. It is also
20954 used as the current directory if no current directory is set by the
20955 &%current_directory%& option on the transport or the
20956 &%transport_current_directory%& option on the router. If the expansion fails
20957 for any reason, including forced failure, an error is logged, and delivery is
20958 deferred.
20959
20960
20961 .option initgroups transports boolean false
20962 .cindex "additional groups"
20963 .cindex "groups" "additional"
20964 .cindex "transport" "group; additional"
20965 If this option is true and the uid for the delivery process is provided by the
20966 transport, the &[initgroups()]& function is called when running the transport
20967 to ensure that any additional groups associated with the uid are set up.
20968
20969
20970 .option max_parallel transports integer&!! unset
20971 .cindex limit "transport parallelism"
20972 .cindex transport "parallel processes"
20973 .cindex transport "concurrency limit"
20974 .cindex "delivery" "parallelism for transport"
20975 If this option is set and expands to an integer greater than zero
20976 it limits the number of concurrent runs of the transport.
20977 The control does not apply to shadow transports.
20978
20979 .cindex "hints database" "transport concurrency control"
20980 Exim implements this control by means of a hints database in which a record is
20981 incremented whenever a transport process is beaing created. The record
20982 is decremented and possibly removed when the process terminates.
20983 Obviously there is scope for
20984 records to get left lying around if there is a system or program crash. To
20985 guard against this, Exim ignores any records that are more than six hours old.
20986
20987 If you use this option, you should also arrange to delete the
20988 relevant hints database whenever your system reboots. The names of the files
20989 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20990 may be one or two files, depending on the type of DBM in use. The same files
20991 are used for ETRN and smtp transport serialization.
20992
20993
20994 .option message_size_limit transports string&!! 0
20995 .cindex "limit" "message size per transport"
20996 .cindex "size" "of message, limit"
20997 .cindex "transport" "message size; limiting"
20998 This option controls the size of messages passed through the transport. It is
20999 expanded before use; the result of the expansion must be a sequence of decimal
21000 digits, optionally followed by K or M. If the expansion fails for any reason,
21001 including forced failure, or if the result is not of the required form,
21002 delivery is deferred. If the value is greater than zero and the size of a
21003 message exceeds this limit, the address is failed. If there is any chance that
21004 the resulting bounce message could be routed to the same transport, you should
21005 ensure that &%return_size_limit%& is less than the transport's
21006 &%message_size_limit%&, as otherwise the bounce message will fail to get
21007 delivered.
21008
21009
21010
21011 .option rcpt_include_affixes transports boolean false
21012 .cindex "prefix" "for local part, including in envelope"
21013 .cindex "suffix for local part" "including in envelope"
21014 .cindex "local part" "prefix"
21015 .cindex "local part" "suffix"
21016 When this option is false (the default), and an address that has had any
21017 affixes (prefixes or suffixes) removed from the local part is delivered by any
21018 form of SMTP or LMTP, the affixes are not included. For example, if a router
21019 that contains
21020 .code
21021 local_part_prefix = *-
21022 .endd
21023 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21024 is delivered with
21025 .code
21026 RCPT TO:<xyz@some.domain>
21027 .endd
21028 This is also the case when an ACL-time callout is being used to verify a
21029 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21030 whole local part is included in the RCPT command. This option applies to BSMTP
21031 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21032 &(lmtp)& and &(smtp)& transports.
21033
21034
21035 .option retry_use_local_part transports boolean "see below"
21036 .cindex "hints database" "retry keys"
21037 When a delivery suffers a temporary failure, a retry record is created
21038 in Exim's hints database. For remote deliveries, the key for the retry record
21039 is based on the name and/or IP address of the failing remote host. For local
21040 deliveries, the key is normally the entire address, including both the local
21041 part and the domain. This is suitable for most common cases of local delivery
21042 temporary failure &-- for example, exceeding a mailbox quota should delay only
21043 deliveries to that mailbox, not to the whole domain.
21044
21045 However, in some special cases you may want to treat a temporary local delivery
21046 as a failure associated with the domain, and not with a particular local part.
21047 (For example, if you are storing all mail for some domain in files.) You can do
21048 this by setting &%retry_use_local_part%& false.
21049
21050 For all the local transports, its default value is true. For remote transports,
21051 the default value is false for tidiness, but changing the value has no effect
21052 on a remote transport in the current implementation.
21053
21054
21055 .option return_path transports string&!! unset
21056 .cindex "envelope sender"
21057 .cindex "transport" "return path; changing"
21058 .cindex "return path" "changing in transport"
21059 If this option is set, the string is expanded at transport time and replaces
21060 the existing return path (envelope sender) value in the copy of the message
21061 that is being delivered. An empty return path is permitted. This feature is
21062 designed for remote deliveries, where the value of this option is used in the
21063 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21064 only effect is to change the address that is placed in the &'Return-path:'&
21065 header line, if one is added to the message (see the next option).
21066
21067 &*Note:*& A changed return path is not logged unless you add
21068 &%return_path_on_delivery%& to the log selector.
21069
21070 .vindex "&$return_path$&"
21071 The expansion can refer to the existing value via &$return_path$&. This is
21072 either the message's envelope sender, or an address set by the
21073 &%errors_to%& option on a router. If the expansion is forced to fail, no
21074 replacement occurs; if it fails for another reason, delivery is deferred. This
21075 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21076 section &<<SECTverp>>&.
21077
21078 &*Note*&: If a delivery error is detected locally, including the case when a
21079 remote server rejects a message at SMTP time, the bounce message is not sent to
21080 the value of this option. It is sent to the previously set errors address.
21081 This defaults to the incoming sender address, but can be changed by setting
21082 &%errors_to%& in a router.
21083
21084
21085
21086 .option return_path_add transports boolean false
21087 .cindex "&'Return-path:'& header line"
21088 If this option is true, a &'Return-path:'& header is added to the message.
21089 Although the return path is normally available in the prefix line of BSD
21090 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21091 have easy access to it.
21092
21093 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21094 the delivery SMTP server makes the final delivery"&. This implies that this
21095 header should not be present in incoming messages. Exim has a configuration
21096 option, &%return_path_remove%&, which requests removal of this header from
21097 incoming messages, so that delivered messages can safely be resent to other
21098 recipients.
21099
21100
21101 .option shadow_condition transports string&!! unset
21102 See &%shadow_transport%& below.
21103
21104
21105 .option shadow_transport transports string unset
21106 .cindex "shadow transport"
21107 .cindex "transport" "shadow"
21108 A local transport may set the &%shadow_transport%& option to the name of
21109 another local transport. Shadow remote transports are not supported.
21110
21111 Whenever a delivery to the main transport succeeds, and either
21112 &%shadow_condition%& is unset, or its expansion does not result in the empty
21113 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21114 passed to the shadow transport, with the same delivery address or addresses. If
21115 expansion fails, no action is taken except that non-forced expansion failures
21116 cause a log line to be written.
21117
21118 The result of the shadow transport is discarded and does not affect the
21119 subsequent processing of the message. Only a single level of shadowing is
21120 provided; the &%shadow_transport%& option is ignored on any transport when it
21121 is running as a shadow. Options concerned with output from pipes are also
21122 ignored. The log line for the successful delivery has an item added on the end,
21123 of the form
21124 .code
21125 ST=<shadow transport name>
21126 .endd
21127 If the shadow transport did not succeed, the error message is put in
21128 parentheses afterwards. Shadow transports can be used for a number of different
21129 purposes, including keeping more detailed log information than Exim normally
21130 provides, and implementing automatic acknowledgment policies based on message
21131 headers that some sites insist on.
21132
21133
21134 .option transport_filter transports string&!! unset
21135 .cindex "transport" "filter"
21136 .cindex "filter" "transport filter"
21137 This option sets up a filtering (in the Unix shell sense) process for messages
21138 at transport time. It should not be confused with mail filtering as set up by
21139 individual users or via a system filter.
21140 If unset, or expanding to an empty string, no filtering is done.
21141
21142 When the message is about to be written out, the command specified by
21143 &%transport_filter%& is started up in a separate, parallel process, and
21144 the entire message, including the header lines, is passed to it on its standard
21145 input (this in fact is done from a third process, to avoid deadlock). The
21146 command must be specified as an absolute path.
21147
21148 The lines of the message that are written to the transport filter are
21149 terminated by newline (&"\n"&). The message is passed to the filter before any
21150 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21151 lines beginning with a dot, and also before any processing implied by the
21152 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21153 &(pipe)& transports.
21154
21155 The standard error for the filter process is set to the same destination as its
21156 standard output; this is read and written to the message's ultimate
21157 destination. The process that writes the message to the filter, the
21158 filter itself, and the original process that reads the result and delivers it
21159 are all run in parallel, like a shell pipeline.
21160
21161 The filter can perform any transformations it likes, but of course should take
21162 care not to break RFC 2822 syntax. Exim does not check the result, except to
21163 test for a final newline when SMTP is in use. All messages transmitted over
21164 SMTP must end with a newline, so Exim supplies one if it is missing.
21165
21166 .cindex "content scanning" "per user"
21167 A transport filter can be used to provide content-scanning on a per-user basis
21168 at delivery time if the only required effect of the scan is to modify the
21169 message. For example, a content scan could insert a new header line containing
21170 a spam score. This could be interpreted by a filter in the user's MUA. It is
21171 not possible to discard a message at this stage.
21172
21173 .cindex "SMTP" "SIZE"
21174 A problem might arise if the filter increases the size of a message that is
21175 being sent down an SMTP connection. If the receiving SMTP server has indicated
21176 support for the SIZE parameter, Exim will have sent the size of the message
21177 at the start of the SMTP session. If what is actually sent is substantially
21178 more, the server might reject the message. This can be worked round by setting
21179 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21180 additions to the message, or to disable the use of SIZE altogether.
21181
21182 .vindex "&$pipe_addresses$&"
21183 The value of the &%transport_filter%& option is the command string for starting
21184 the filter, which is run directly from Exim, not under a shell. The string is
21185 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21186 Exim breaks it up into arguments and then expands each argument separately (see
21187 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21188 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21189 of arguments, one for each address that applies to this delivery. (This isn't
21190 an ideal name for this feature here, but as it was already implemented for the
21191 &(pipe)& transport, it seemed sensible not to change it.)
21192
21193 .vindex "&$host$&"
21194 .vindex "&$host_address$&"
21195 The expansion variables &$host$& and &$host_address$& are available when the
21196 transport is a remote one. They contain the name and IP address of the host to
21197 which the message is being sent. For example:
21198 .code
21199 transport_filter = /some/directory/transport-filter.pl \
21200   $host $host_address $sender_address $pipe_addresses
21201 .endd
21202
21203 Two problems arise if you want to use more complicated expansion items to
21204 generate transport filter commands, both of which due to the fact that the
21205 command is split up &'before'& expansion.
21206 .ilist
21207 If an expansion item contains white space, you must quote it, so that it is all
21208 part of the same command item. If the entire option setting is one such
21209 expansion item, you have to take care what kind of quoting you use. For
21210 example:
21211 .code
21212 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21213 .endd
21214 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21215 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21216 stripped by Exim when it read the option's value. When the value is used, if
21217 the single quotes were missing, the line would be split into two items,
21218 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21219 Exim tried to expand the first one.
21220 .next
21221 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21222 expansion cannot generate multiple arguments, or a command name followed by
21223 arguments. Consider this example:
21224 .code
21225 transport_filter = ${lookup{$host}lsearch{/a/file}\
21226                     {$value}{/bin/cat}}
21227 .endd
21228 The result of the lookup is interpreted as the name of the command, even
21229 if it contains white space. The simplest way round this is to use a shell:
21230 .code
21231 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21232                                {$value}{/bin/cat}}
21233 .endd
21234 .endlist
21235
21236 The filter process is run under the same uid and gid as the normal delivery.
21237 For remote deliveries this is the Exim uid/gid by default. The command should
21238 normally yield a zero return code. Transport filters are not supposed to fail.
21239 A non-zero code is taken to mean that the transport filter encountered some
21240 serious problem. Delivery of the message is deferred; the message remains on
21241 the queue and is tried again later. It is not possible to cause a message to be
21242 bounced from a transport filter.
21243
21244 If a transport filter is set on an autoreply transport, the original message is
21245 passed through the filter as it is being copied into the newly generated
21246 message, which happens if the &%return_message%& option is set.
21247
21248
21249 .option transport_filter_timeout transports time 5m
21250 .cindex "transport" "filter, timeout"
21251 When Exim is reading the output of a transport filter, it applies a timeout
21252 that can be set by this option. Exceeding the timeout is normally treated as a
21253 temporary delivery failure. However, if a transport filter is used with a
21254 &(pipe)& transport, a timeout in the transport filter is treated in the same
21255 way as a timeout in the pipe command itself. By default, a timeout is a hard
21256 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21257 becomes a temporary error.
21258
21259
21260 .option user transports string&!! "Exim user"
21261 .cindex "uid (user id)" "local delivery"
21262 .cindex "transport" "user, specifying"
21263 This option specifies the user under whose uid the delivery process is to be
21264 run, overriding any uid that may have been set by the router. If the user is
21265 given as a name, the uid is looked up from the password data, and the
21266 associated group is taken as the value of the gid to be used if the &%group%&
21267 option is not set.
21268
21269 For deliveries that use local transports, a user and group are normally
21270 specified explicitly or implicitly (for example, as a result of
21271 &%check_local_user%&) by the router or transport.
21272
21273 .cindex "hints database" "access by remote transport"
21274 For remote transports, you should leave this option unset unless you really are
21275 sure you know what you are doing. When a remote transport is running, it needs
21276 to be able to access Exim's hints databases, because each host may have its own
21277 retry data.
21278 .ecindex IIDgenoptra1
21279 .ecindex IIDgenoptra2
21280 .ecindex IIDgenoptra3
21281
21282
21283
21284
21285
21286
21287 . ////////////////////////////////////////////////////////////////////////////
21288 . ////////////////////////////////////////////////////////////////////////////
21289
21290 .chapter "Address batching in local transports" "CHAPbatching" &&&
21291          "Address batching"
21292 .cindex "transport" "local; address batching in"
21293 The only remote transport (&(smtp)&) is normally configured to handle more than
21294 one address at a time, so that when several addresses are routed to the same
21295 remote host, just one copy of the message is sent. Local transports, however,
21296 normally handle one address at a time. That is, a separate instance of the
21297 transport is run for each address that is routed to the transport. A separate
21298 copy of the message is delivered each time.
21299
21300 .cindex "batched local delivery"
21301 .oindex "&%batch_max%&"
21302 .oindex "&%batch_id%&"
21303 In special cases, it may be desirable to handle several addresses at once in a
21304 local transport, for example:
21305
21306 .ilist
21307 In an &(appendfile)& transport, when storing messages in files for later
21308 delivery by some other means, a single copy of the message with multiple
21309 recipients saves space.
21310 .next
21311 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21312 a single copy saves time, and is the normal way LMTP is expected to work.
21313 .next
21314 In a &(pipe)& transport, when passing the message
21315 to a scanner program or
21316 to some other delivery mechanism such as UUCP, multiple recipients may be
21317 acceptable.
21318 .endlist
21319
21320 These three local transports all have the same options for controlling multiple
21321 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21322 repeating the information for each transport, these options are described here.
21323
21324 The &%batch_max%& option specifies the maximum number of addresses that can be
21325 delivered together in a single run of the transport. Its default value is one
21326 (no batching). When more than one address is routed to a transport that has a
21327 &%batch_max%& value greater than one, the addresses are delivered in a batch
21328 (that is, in a single run of the transport with multiple recipients), subject
21329 to certain conditions:
21330
21331 .ilist
21332 .vindex "&$local_part$&"
21333 If any of the transport's options contain a reference to &$local_part$&, no
21334 batching is possible.
21335 .next
21336 .vindex "&$domain$&"
21337 If any of the transport's options contain a reference to &$domain$&, only
21338 addresses with the same domain are batched.
21339 .next
21340 .cindex "customizing" "batching condition"
21341 If &%batch_id%& is set, it is expanded for each address, and only those
21342 addresses with the same expanded value are batched. This allows you to specify
21343 customized batching conditions. Failure of the expansion for any reason,
21344 including forced failure, disables batching, but it does not stop the delivery
21345 from taking place.
21346 .next
21347 Batched addresses must also have the same errors address (where to send
21348 delivery errors), the same header additions and removals, the same user and
21349 group for the transport, and if a host list is present, the first host must
21350 be the same.
21351 .endlist
21352
21353 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21354 both when the file or pipe command is specified in the transport, and when it
21355 is specified by a &(redirect)& router, but all the batched addresses must of
21356 course be routed to the same file or pipe command. These two transports have an
21357 option called &%use_bsmtp%&, which causes them to deliver the message in
21358 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21359 &%check_string%& and &%escape_string%& options are forced to the values
21360 .code
21361 check_string = "."
21362 escape_string = ".."
21363 .endd
21364 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21365 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21366 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21367
21368 .cindex "&'Envelope-to:'& header line"
21369 If the generic &%envelope_to_add%& option is set for a batching transport, the
21370 &'Envelope-to:'& header that is added to the message contains all the addresses
21371 that are being processed together. If you are using a batching &(appendfile)&
21372 transport without &%use_bsmtp%&, the only way to preserve the recipient
21373 addresses is to set the &%envelope_to_add%& option.
21374
21375 .cindex "&(pipe)& transport" "with multiple addresses"
21376 .vindex "&$pipe_addresses$&"
21377 If you are using a &(pipe)& transport without BSMTP, and setting the
21378 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21379 the command. This is not a true variable; it is a bit of magic that causes each
21380 of the recipient addresses to be inserted into the command as a separate
21381 argument. This provides a way of accessing all the addresses that are being
21382 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21383 are specified by a &(redirect)& router.
21384
21385
21386
21387
21388 . ////////////////////////////////////////////////////////////////////////////
21389 . ////////////////////////////////////////////////////////////////////////////
21390
21391 .chapter "The appendfile transport" "CHAPappendfile"
21392 .scindex IIDapptra1 "&(appendfile)& transport"
21393 .scindex IIDapptra2 "transports" "&(appendfile)&"
21394 .cindex "directory creation"
21395 .cindex "creating directories"
21396 The &(appendfile)& transport delivers a message by appending it to an existing
21397 file, or by creating an entirely new file in a specified directory. Single
21398 files to which messages are appended can be in the traditional Unix mailbox
21399 format, or optionally in the MBX format supported by the Pine MUA and
21400 University of Washington IMAP daemon, &'inter alia'&. When each message is
21401 being delivered as a separate file, &"maildir"& format can optionally be used
21402 to give added protection against failures that happen part-way through the
21403 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21404 supported. For all file formats, Exim attempts to create as many levels of
21405 directory as necessary, provided that &%create_directory%& is set.
21406
21407 The code for the optional formats is not included in the Exim binary by
21408 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21409 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21410 included.
21411
21412 .cindex "quota" "system"
21413 Exim recognizes system quota errors, and generates an appropriate message. Exim
21414 also supports its own quota control within the transport, for use when the
21415 system facility is unavailable or cannot be used for some reason.
21416
21417 If there is an error while appending to a file (for example, quota exceeded or
21418 partition filled), Exim attempts to reset the file's length and last
21419 modification time back to what they were before. If there is an error while
21420 creating an entirely new file, the new file is removed.
21421
21422 Before appending to a file, a number of security checks are made, and the
21423 file is locked. A detailed description is given below, after the list of
21424 private options.
21425
21426 The &(appendfile)& transport is most commonly used for local deliveries to
21427 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21428 putting messages into files for remote delivery by some means other than Exim.
21429 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21430 option).
21431
21432
21433
21434 .section "The file and directory options" "SECTfildiropt"
21435 The &%file%& option specifies a single file, to which the message is appended;
21436 the &%directory%& option specifies a directory, in which a new file containing
21437 the message is created. Only one of these two options can be set, and for
21438 normal deliveries to mailboxes, one of them &'must'& be set.
21439
21440 .vindex "&$address_file$&"
21441 .vindex "&$local_part$&"
21442 However, &(appendfile)& is also used for delivering messages to files or
21443 directories whose names (or parts of names) are obtained from alias,
21444 forwarding, or filtering operations (for example, a &%save%& command in a
21445 user's Exim filter). When such a transport is running, &$local_part$& contains
21446 the local part that was aliased or forwarded, and &$address_file$& contains the
21447 name (or partial name) of the file or directory generated by the redirection
21448 operation. There are two cases:
21449
21450 .ilist
21451 If neither &%file%& nor &%directory%& is set, the redirection operation
21452 must specify an absolute path (one that begins with &`/`&). This is the most
21453 common case when users with local accounts use filtering to sort mail into
21454 different folders. See for example, the &(address_file)& transport in the
21455 default configuration. If the path ends with a slash, it is assumed to be the
21456 name of a directory. A delivery to a directory can also be forced by setting
21457 &%maildir_format%& or &%mailstore_format%&.
21458 .next
21459 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21460 used to determine the file or directory name for the delivery. Normally, the
21461 contents of &$address_file$& are used in some way in the string expansion.
21462 .endlist
21463
21464
21465 .cindex "Sieve filter" "configuring &(appendfile)&"
21466 .cindex "Sieve filter" "relative mailbox path handling"
21467 As an example of the second case, consider an environment where users do not
21468 have home directories. They may be permitted to use Exim filter commands of the
21469 form:
21470 .code
21471 save folder23
21472 .endd
21473 or Sieve filter commands of the form:
21474 .code
21475 require "fileinto";
21476 fileinto "folder23";
21477 .endd
21478 In this situation, the expansion of &%file%& or &%directory%& in the transport
21479 must transform the relative path into an appropriate absolute file name. In the
21480 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21481 is used as a result of a &"keep"& action in the filter. This example shows one
21482 way of handling this requirement:
21483 .code
21484 file = ${if eq{$address_file}{inbox} \
21485             {/var/mail/$local_part} \
21486             {${if eq{${substr_0_1:$address_file}}{/} \
21487                   {$address_file} \
21488                   {$home/mail/$address_file} \
21489             }} \
21490        }
21491 .endd
21492 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21493 location, absolute paths are used without change, and other folders are in the
21494 &_mail_& directory within the home directory.
21495
21496 &*Note 1*&: While processing an Exim filter, a relative path such as
21497 &_folder23_& is turned into an absolute path if a home directory is known to
21498 the router. In particular, this is the case if &%check_local_user%& is set. If
21499 you want to prevent this happening at routing time, you can set
21500 &%router_home_directory%& empty. This forces the router to pass the relative
21501 path to the transport.
21502
21503 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21504 the &%file%& or &%directory%& option is still used if it is set.
21505
21506
21507
21508
21509 .section "Private options for appendfile" "SECID134"
21510 .cindex "options" "&(appendfile)& transport"
21511
21512
21513
21514 .option allow_fifo appendfile boolean false
21515 .cindex "fifo (named pipe)"
21516 .cindex "named pipe (fifo)"
21517 .cindex "pipe" "named (fifo)"
21518 Setting this option permits delivery to named pipes (FIFOs) as well as to
21519 regular files. If no process is reading the named pipe at delivery time, the
21520 delivery is deferred.
21521
21522
21523 .option allow_symlink appendfile boolean false
21524 .cindex "symbolic link" "to mailbox"
21525 .cindex "mailbox" "symbolic link"
21526 By default, &(appendfile)& will not deliver if the path name for the file is
21527 that of a symbolic link. Setting this option relaxes that constraint, but there
21528 are security issues involved in the use of symbolic links. Be sure you know
21529 what you are doing if you set this. Details of exactly what this option affects
21530 are included in the discussion which follows this list of options.
21531
21532
21533 .option batch_id appendfile string&!! unset
21534 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21535 However, batching is automatically disabled for &(appendfile)& deliveries that
21536 happen as a result of forwarding or aliasing or other redirection directly to a
21537 file.
21538
21539
21540 .option batch_max appendfile integer 1
21541 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21542
21543
21544 .option check_group appendfile boolean false
21545 When this option is set, the group owner of the file defined by the &%file%&
21546 option is checked to see that it is the same as the group under which the
21547 delivery process is running. The default setting is false because the default
21548 file mode is 0600, which means that the group is irrelevant.
21549
21550
21551 .option check_owner appendfile boolean true
21552 When this option is set, the owner of the file defined by the &%file%& option
21553 is checked to ensure that it is the same as the user under which the delivery
21554 process is running.
21555
21556
21557 .option check_string appendfile string "see below"
21558 .cindex "&""From""& line"
21559 As &(appendfile)& writes the message, the start of each line is tested for
21560 matching &%check_string%&, and if it does, the initial matching characters are
21561 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21562 a literal string, not a regular expression, and the case of any letters it
21563 contains is significant.
21564
21565 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21566 are forced to &"."& and &".."& respectively, and any settings in the
21567 configuration are ignored. Otherwise, they default to &"From&~"& and
21568 &">From&~"& when the &%file%& option is set, and unset when any of the
21569 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21570
21571 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21572 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21573 &"From&~"& indicates the start of a new message. All four options need changing
21574 if another format is used. For example, to deliver to mailboxes in MMDF format:
21575 .cindex "MMDF format mailbox"
21576 .cindex "mailbox" "MMDF format"
21577 .code
21578 check_string = "\1\1\1\1\n"
21579 escape_string = "\1\1\1\1 \n"
21580 message_prefix = "\1\1\1\1\n"
21581 message_suffix = "\1\1\1\1\n"
21582 .endd
21583 .option create_directory appendfile boolean true
21584 .cindex "directory creation"
21585 When this option is true, Exim attempts to create any missing superior
21586 directories for the file that it is about to write. A created directory's mode
21587 is given by the &%directory_mode%& option.
21588
21589 The group ownership of a newly created directory is highly dependent on the
21590 operating system (and possibly the file system) that is being used. For
21591 example, in Solaris, if the parent directory has the setgid bit set, its group
21592 is propagated to the child; if not, the currently set group is used. However,
21593 in FreeBSD, the parent's group is always used.
21594
21595
21596
21597 .option create_file appendfile string anywhere
21598 This option constrains the location of files and directories that are created
21599 by this transport. It applies to files defined by the &%file%& option and
21600 directories defined by the &%directory%& option. In the case of maildir
21601 delivery, it applies to the top level directory, not the maildir directories
21602 beneath.
21603
21604 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21605 &"belowhome"&. In the second and third cases, a home directory must have been
21606 set for the transport. This option is not useful when an explicit file name is
21607 given for normal mailbox deliveries. It is intended for the case when file
21608 names are generated from users' &_.forward_& files. These are usually handled
21609 by an &(appendfile)& transport called &%address_file%&. See also
21610 &%file_must_exist%&.
21611
21612
21613 .option directory appendfile string&!! unset
21614 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21615 or &%directory%& must be set, unless the delivery is the direct result of a
21616 redirection (see section &<<SECTfildiropt>>&).
21617
21618 When &%directory%& is set, the string is expanded, and the message is delivered
21619 into a new file or files in or below the given directory, instead of being
21620 appended to a single mailbox file. A number of different formats are provided
21621 (see &%maildir_format%& and &%mailstore_format%&), and see section
21622 &<<SECTopdir>>& for further details of this form of delivery.
21623
21624
21625 .option directory_file appendfile string&!! "see below"
21626 .cindex "base62"
21627 .vindex "&$inode$&"
21628 When &%directory%& is set, but neither &%maildir_format%& nor
21629 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21630 whose name is obtained by expanding this string. The default value is:
21631 .code
21632 q${base62:$tod_epoch}-$inode
21633 .endd
21634 This generates a unique name from the current time, in base 62 form, and the
21635 inode of the file. The variable &$inode$& is available only when expanding this
21636 option.
21637
21638
21639 .option directory_mode appendfile "octal integer" 0700
21640 If &(appendfile)& creates any directories as a result of the
21641 &%create_directory%& option, their mode is specified by this option.
21642
21643
21644 .option escape_string appendfile string "see description"
21645 See &%check_string%& above.
21646
21647
21648 .option file appendfile string&!! unset
21649 This option is mutually exclusive with the &%directory%& option, but one of
21650 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21651 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21652 specifies a single file, to which the message is appended. One or more of
21653 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21654 &%file%&.
21655
21656 .cindex "NFS" "lock file"
21657 .cindex "locking files"
21658 .cindex "lock files"
21659 If you are using more than one host to deliver over NFS into the same
21660 mailboxes, you should always use lock files.
21661
21662 The string value is expanded for each delivery, and must yield an absolute
21663 path. The most common settings of this option are variations on one of these
21664 examples:
21665 .code
21666 file = /var/spool/mail/$local_part
21667 file = /home/$local_part/inbox
21668 file = $home/inbox
21669 .endd
21670 .cindex "&""sticky""& bit"
21671 In the first example, all deliveries are done into the same directory. If Exim
21672 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21673 create a file in the directory, so the &"sticky"& bit must be turned on for
21674 deliveries to be possible, or alternatively the &%group%& option can be used to
21675 run the delivery under a group id which has write access to the directory.
21676
21677
21678
21679 .option file_format appendfile string unset
21680 .cindex "file" "mailbox; checking existing format"
21681 This option requests the transport to check the format of an existing file
21682 before adding to it. The check consists of matching a specific string at the
21683 start of the file. The value of the option consists of an even number of
21684 colon-separated strings. The first of each pair is the test string, and the
21685 second is the name of a transport. If the transport associated with a matched
21686 string is not the current transport, control is passed over to the other
21687 transport. For example, suppose the standard &(local_delivery)& transport has
21688 this added to it:
21689 .code
21690 file_format = "From       : local_delivery :\
21691                \1\1\1\1\n : local_mmdf_delivery"
21692 .endd
21693 Mailboxes that begin with &"From"& are still handled by this transport, but if
21694 a mailbox begins with four binary ones followed by a newline, control is passed
21695 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21696 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21697 is assumed to match the current transport. If the start of a mailbox doesn't
21698 match any string, or if the transport named for a given string is not defined,
21699 delivery is deferred.
21700
21701
21702 .option file_must_exist appendfile boolean false
21703 If this option is true, the file specified by the &%file%& option must exist.
21704 A temporary error occurs if it does not, causing delivery to be deferred.
21705 If this option is false, the file is created if it does not exist.
21706
21707
21708 .option lock_fcntl_timeout appendfile time 0s
21709 .cindex "timeout" "mailbox locking"
21710 .cindex "mailbox" "locking, blocking and non-blocking"
21711 .cindex "locking files"
21712 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21713 when locking an open mailbox file. If the call fails, the delivery process
21714 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21715 Non-blocking calls are used so that the file is not kept open during the wait
21716 for the lock; the reason for this is to make it as safe as possible for
21717 deliveries over NFS in the case when processes might be accessing an NFS
21718 mailbox without using a lock file. This should not be done, but
21719 misunderstandings and hence misconfigurations are not unknown.
21720
21721 On a busy system, however, the performance of a non-blocking lock approach is
21722 not as good as using a blocking lock with a timeout. In this case, the waiting
21723 is done inside the system call, and Exim's delivery process acquires the lock
21724 and can proceed as soon as the previous lock holder releases it.
21725
21726 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21727 timeout, are used. There may still be some retrying: the maximum number of
21728 retries is
21729 .code
21730 (lock_retries * lock_interval) / lock_fcntl_timeout
21731 .endd
21732 rounded up to the next whole number. In other words, the total time during
21733 which &(appendfile)& is trying to get a lock is roughly the same, unless
21734 &%lock_fcntl_timeout%& is set very large.
21735
21736 You should consider setting this option if you are getting a lot of delayed
21737 local deliveries because of errors of the form
21738 .code
21739 failed to lock mailbox /some/file (fcntl)
21740 .endd
21741
21742 .option lock_flock_timeout appendfile time 0s
21743 This timeout applies to file locking when using &[flock()]& (see
21744 &%use_flock%&); the timeout operates in a similar manner to
21745 &%lock_fcntl_timeout%&.
21746
21747
21748 .option lock_interval appendfile time 3s
21749 This specifies the time to wait between attempts to lock the file. See below
21750 for details of locking.
21751
21752
21753 .option lock_retries appendfile integer 10
21754 This specifies the maximum number of attempts to lock the file. A value of zero
21755 is treated as 1. See below for details of locking.
21756
21757
21758 .option lockfile_mode appendfile "octal integer" 0600
21759 This specifies the mode of the created lock file, when a lock file is being
21760 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21761
21762
21763 .option lockfile_timeout appendfile time 30m
21764 .cindex "timeout" "mailbox locking"
21765 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21766 exists and is older than this value, it is assumed to have been left behind by
21767 accident, and Exim attempts to remove it.
21768
21769
21770 .option mailbox_filecount appendfile string&!! unset
21771 .cindex "mailbox" "specifying size of"
21772 .cindex "size" "of mailbox"
21773 If this option is set, it is expanded, and the result is taken as the current
21774 number of files in the mailbox. It must be a decimal number, optionally
21775 followed by K or M. This provides a way of obtaining this information from an
21776 external source that maintains the data.
21777
21778
21779 .option mailbox_size appendfile string&!! unset
21780 .cindex "mailbox" "specifying size of"
21781 .cindex "size" "of mailbox"
21782 If this option is set, it is expanded, and the result is taken as the current
21783 size the mailbox. It must be a decimal number, optionally followed by K or M.
21784 This provides a way of obtaining this information from an external source that
21785 maintains the data. This is likely to be helpful for maildir deliveries where
21786 it is computationally expensive to compute the size of a mailbox.
21787
21788
21789
21790 .option maildir_format appendfile boolean false
21791 .cindex "maildir format" "specifying"
21792 If this option is set with the &%directory%& option, the delivery is into a new
21793 file, in the &"maildir"& format that is used by other mail software. When the
21794 transport is activated directly from a &(redirect)& router (for example, the
21795 &(address_file)& transport in the default configuration), setting
21796 &%maildir_format%& causes the path received from the router to be treated as a
21797 directory, whether or not it ends with &`/`&. This option is available only if
21798 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21799 &<<SECTmaildirdelivery>>& below for further details.
21800
21801
21802 .option maildir_quota_directory_regex appendfile string "See below"
21803 .cindex "maildir format" "quota; directories included in"
21804 .cindex "quota" "maildir; directories included in"
21805 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21806 a regular expression for specifying directories, relative to the quota
21807 directory (see &%quota_directory%&), that should be included in the quota
21808 calculation. The default value is:
21809 .code
21810 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21811 .endd
21812 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21813 (directories whose names begin with a dot). If you want to exclude the
21814 &_Trash_&
21815 folder from the count (as some sites do), you need to change this setting to
21816 .code
21817 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21818 .endd
21819 This uses a negative lookahead in the regular expression to exclude the
21820 directory whose name is &_.Trash_&. When a directory is excluded from quota
21821 calculations, quota processing is bypassed for any messages that are delivered
21822 directly into that directory.
21823
21824
21825 .option maildir_retries appendfile integer 10
21826 This option specifies the number of times to retry when writing a file in
21827 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21828
21829
21830 .option maildir_tag appendfile string&!! unset
21831 This option applies only to deliveries in maildir format, and is described in
21832 section &<<SECTmaildirdelivery>>& below.
21833
21834
21835 .option maildir_use_size_file appendfile&!! boolean false
21836 .cindex "maildir format" "&_maildirsize_& file"
21837 The result of string expansion for this option must be a valid boolean value.
21838 If it is true, it enables support for &_maildirsize_& files. Exim
21839 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21840 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21841 value is zero. See &%maildir_quota_directory_regex%& above and section
21842 &<<SECTmaildirdelivery>>& below for further details.
21843
21844 .option maildirfolder_create_regex appendfile string unset
21845 .cindex "maildir format" "&_maildirfolder_& file"
21846 .cindex "&_maildirfolder_&, creating"
21847 The value of this option is a regular expression. If it is unset, it has no
21848 effect. Otherwise, before a maildir delivery takes place, the pattern is
21849 matched against the name of the maildir directory, that is, the directory
21850 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21851 delivery. If there is a match, Exim checks for the existence of a file called
21852 &_maildirfolder_& in the directory, and creates it if it does not exist.
21853 See section &<<SECTmaildirdelivery>>& for more details.
21854
21855
21856 .option mailstore_format appendfile boolean false
21857 .cindex "mailstore format" "specifying"
21858 If this option is set with the &%directory%& option, the delivery is into two
21859 new files in  &"mailstore"& format. The option is available only if
21860 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21861 below for further details.
21862
21863
21864 .option mailstore_prefix appendfile string&!! unset
21865 This option applies only to deliveries in mailstore format, and is described in
21866 section &<<SECTopdir>>& below.
21867
21868
21869 .option mailstore_suffix appendfile string&!! unset
21870 This option applies only to deliveries in mailstore format, and is described in
21871 section &<<SECTopdir>>& below.
21872
21873
21874 .option mbx_format appendfile boolean false
21875 .cindex "locking files"
21876 .cindex "file" "locking"
21877 .cindex "file" "MBX format"
21878 .cindex "MBX format, specifying"
21879 This option is available only if Exim has been compiled with SUPPORT_MBX
21880 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21881 the message is appended to the mailbox file in MBX format instead of
21882 traditional Unix format. This format is supported by Pine4 and its associated
21883 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21884
21885 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21886 automatically changed by the use of &%mbx_format%&. They should normally be set
21887 empty when using MBX format, so this option almost always appears in this
21888 combination:
21889 .code
21890 mbx_format = true
21891 message_prefix =
21892 message_suffix =
21893 .endd
21894 If none of the locking options are mentioned in the configuration,
21895 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21896 is possible to specify the other kinds of locking with &%mbx_format%&, but
21897 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21898 interworks with &'c-client'&, providing for shared access to the mailbox. It
21899 should not be used if any program that does not use this form of locking is
21900 going to access the mailbox, nor should it be used if the mailbox file is NFS
21901 mounted, because it works only when the mailbox is accessed from a single host.
21902
21903 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21904 the standard version of &'c-client'&, because as long as it has a mailbox open
21905 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21906 append messages to it.
21907
21908
21909 .option message_prefix appendfile string&!! "see below"
21910 .cindex "&""From""& line"
21911 The string specified here is expanded and output at the start of every message.
21912 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21913 in which case it is:
21914 .code
21915 message_prefix = "From ${if def:return_path{$return_path}\
21916   {MAILER-DAEMON}} $tod_bsdinbox\n"
21917 .endd
21918 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21919 &`\n`& to &`\r\n`& in &%message_prefix%&.
21920
21921 .option message_suffix appendfile string&!! "see below"
21922 The string specified here is expanded and output at the end of every message.
21923 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21924 in which case it is a single newline character. The suffix can be suppressed by
21925 setting
21926 .code
21927 message_suffix =
21928 .endd
21929 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21930 &`\n`& to &`\r\n`& in &%message_suffix%&.
21931
21932 .option mode appendfile "octal integer" 0600
21933 If the output file is created, it is given this mode. If it already exists and
21934 has wider permissions, they are reduced to this mode. If it has narrower
21935 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21936 if the delivery is the result of a &%save%& command in a filter file specifying
21937 a particular mode, the mode of the output file is always forced to take that
21938 value, and this option is ignored.
21939
21940
21941 .option mode_fail_narrower appendfile boolean true
21942 This option applies in the case when an existing mailbox file has a narrower
21943 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21944 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21945 continues with the delivery attempt, using the existing mode of the file.
21946
21947
21948 .option notify_comsat appendfile boolean false
21949 If this option is true, the &'comsat'& daemon is notified after every
21950 successful delivery to a user mailbox. This is the daemon that notifies logged
21951 on users about incoming mail.
21952
21953
21954 .option quota appendfile string&!! unset
21955 .cindex "quota" "imposed by Exim"
21956 This option imposes a limit on the size of the file to which Exim is appending,
21957 or to the total space used in the directory tree when the &%directory%& option
21958 is set. In the latter case, computation of the space used is expensive, because
21959 all the files in the directory (and any sub-directories) have to be
21960 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21961 &%maildir_use_size_file%& for ways to avoid this in environments where users
21962 have no shell access to their mailboxes).
21963
21964 As there is no interlock against two simultaneous deliveries into a
21965 multi-file mailbox, it is possible for the quota to be overrun in this case.
21966 For single-file mailboxes, of course, an interlock is a necessity.
21967
21968 A file's size is taken as its &'used'& value. Because of blocking effects, this
21969 may be a lot less than the actual amount of disk space allocated to the file.
21970 If the sizes of a number of files are being added up, the rounding effect can
21971 become quite noticeable, especially on systems that have large block sizes.
21972 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21973 the obvious value which users understand most easily.
21974
21975 The value of the option is expanded, and must then be a numerical value
21976 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21977 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21978 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21979 be handled.
21980
21981 &*Note*&: A value of zero is interpreted as &"no quota"&.
21982
21983 The expansion happens while Exim is running as root, before it changes uid for
21984 the delivery. This means that files that are inaccessible to the end user can
21985 be used to hold quota values that are looked up in the expansion. When delivery
21986 fails because this quota is exceeded, the handling of the error is as for
21987 system quota failures.
21988
21989 By default, Exim's quota checking mimics system quotas, and restricts the
21990 mailbox to the specified maximum size, though the value is not accurate to the
21991 last byte, owing to separator lines and additional headers that may get added
21992 during message delivery. When a mailbox is nearly full, large messages may get
21993 refused even though small ones are accepted, because the size of the current
21994 message is added to the quota when the check is made. This behaviour can be
21995 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21996 for exceeding the quota does not include the current message. Thus, deliveries
21997 continue until the quota has been exceeded; thereafter, no further messages are
21998 delivered. See also &%quota_warn_threshold%&.
21999
22000
22001 .option quota_directory appendfile string&!! unset
22002 This option defines the directory to check for quota purposes when delivering
22003 into individual files. The default is the delivery directory, or, if a file
22004 called &_maildirfolder_& exists in a maildir directory, the parent of the
22005 delivery directory.
22006
22007
22008 .option quota_filecount appendfile string&!! 0
22009 This option applies when the &%directory%& option is set. It limits the total
22010 number of files in the directory (compare the inode limit in system quotas). It
22011 can only be used if &%quota%& is also set. The value is expanded; an expansion
22012 failure causes delivery to be deferred. A value of zero is interpreted as
22013 &"no quota"&.
22014
22015
22016 .option quota_is_inclusive appendfile boolean true
22017 See &%quota%& above.
22018
22019
22020 .option quota_size_regex appendfile string unset
22021 This option applies when one of the delivery modes that writes a separate file
22022 for each message is being used. When Exim wants to find the size of one of
22023 these files in order to test the quota, it first checks &%quota_size_regex%&.
22024 If this is set to a regular expression that matches the file name, and it
22025 captures one string, that string is interpreted as a representation of the
22026 file's size. The value of &%quota_size_regex%& is not expanded.
22027
22028 This feature is useful only when users have no shell access to their mailboxes
22029 &-- otherwise they could defeat the quota simply by renaming the files. This
22030 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22031 the file length to the file name. For example:
22032 .code
22033 maildir_tag = ,S=$message_size
22034 quota_size_regex = ,S=(\d+)
22035 .endd
22036 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22037 number of lines in the message.
22038
22039 The regular expression should not assume that the length is at the end of the
22040 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22041 sometimes add other information onto the ends of message file names.
22042
22043 Section &<<SECID136>>& contains further information.
22044
22045
22046 .option quota_warn_message appendfile string&!! "see below"
22047 See below for the use of this option. If it is not set when
22048 &%quota_warn_threshold%& is set, it defaults to
22049 .code
22050 quota_warn_message = "\
22051   To: $local_part@$domain\n\
22052   Subject: Your mailbox\n\n\
22053   This message is automatically created \
22054   by mail delivery software.\n\n\
22055   The size of your mailbox has exceeded \
22056   a warning threshold that is\n\
22057   set by the system administrator.\n"
22058 .endd
22059
22060
22061 .option quota_warn_threshold appendfile string&!! 0
22062 .cindex "quota" "warning threshold"
22063 .cindex "mailbox" "size warning"
22064 .cindex "size" "of mailbox"
22065 This option is expanded in the same way as &%quota%& (see above). If the
22066 resulting value is greater than zero, and delivery of the message causes the
22067 size of the file or total space in the directory tree to cross the given
22068 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22069 may be specified as a percentage of it by following the value with a percent
22070 sign. For example:
22071 .code
22072 quota = 10M
22073 quota_warn_threshold = 75%
22074 .endd
22075 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22076 percent sign is ignored.
22077
22078 The warning message itself is specified by the &%quota_warn_message%& option,
22079 and it must start with a &'To:'& header line containing the recipient(s) of the
22080 warning message. These do not necessarily have to include the recipient(s) of
22081 the original message. A &'Subject:'& line should also normally be supplied. You
22082 can include any other header lines that you want. If you do not include a
22083 &'From:'& line, the default is:
22084 .code
22085 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22086 .endd
22087 .oindex &%errors_reply_to%&
22088 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22089 option.
22090
22091 The &%quota%& option does not have to be set in order to use this option; they
22092 are independent of one another except when the threshold is specified as a
22093 percentage.
22094
22095
22096 .option use_bsmtp appendfile boolean false
22097 .cindex "envelope sender"
22098 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22099 format, with the envelope sender and recipient(s) included as SMTP commands. If
22100 you want to include a leading HELO command with such messages, you can do
22101 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22102 for details of batch SMTP.
22103
22104
22105 .option use_crlf appendfile boolean false
22106 .cindex "carriage return"
22107 .cindex "linefeed"
22108 This option causes lines to be terminated with the two-character CRLF sequence
22109 (carriage return, linefeed) instead of just a linefeed character. In the case
22110 of batched SMTP, the byte sequence written to the file is then an exact image
22111 of what would be sent down a real SMTP connection.
22112
22113 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22114 (which are used to supply the traditional &"From&~"& and blank line separators
22115 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22116 carriage return characters if these are needed. In cases where these options
22117 have non-empty defaults, the values end with a single linefeed, so they must be
22118 changed to end with &`\r\n`& if &%use_crlf%& is set.
22119
22120
22121 .option use_fcntl_lock appendfile boolean "see below"
22122 This option controls the use of the &[fcntl()]& function to lock a file for
22123 exclusive use when a message is being appended. It is set by default unless
22124 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22125 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22126 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22127
22128
22129 .option use_flock_lock appendfile boolean false
22130 This option is provided to support the use of &[flock()]& for file locking, for
22131 the few situations where it is needed. Most modern operating systems support
22132 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22133 each other. Exim uses &[fcntl()]& locking by default.
22134
22135 This option is required only if you are using an operating system where
22136 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22137 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22138 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22139
22140 .cindex "Solaris" "&[flock()]& support"
22141 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22142 have it (and some, I think, provide a not quite right version built on top of
22143 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22144 the ability to use it, and any attempt to do so will cause a configuration
22145 error.
22146
22147 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22148 is just being mapped onto &[fcntl()]& by the OS).
22149
22150
22151 .option use_lockfile appendfile boolean "see below"
22152 If this option is turned off, Exim does not attempt to create a lock file when
22153 appending to a mailbox file. In this situation, the only locking is by
22154 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22155 sure that every MUA that is ever going to look at your users' mailboxes uses
22156 &[fcntl()]& rather than a lock file, and even then only when you are not
22157 delivering over NFS from more than one host.
22158
22159 .cindex "NFS" "lock file"
22160 In order to append to an NFS file safely from more than one host, it is
22161 necessary to take out a lock &'before'& opening the file, and the lock file
22162 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22163 file corruption.
22164
22165 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22166 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22167 except when &%mbx_format%& is set.
22168
22169
22170 .option use_mbx_lock appendfile boolean "see below"
22171 This option is available only if Exim has been compiled with SUPPORT_MBX
22172 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22173 locking rules be used. It is set by default if &%mbx_format%& is set and none
22174 of the locking options are mentioned in the configuration. The locking rules
22175 are the same as are used by the &'c-client'& library that underlies Pine and
22176 the IMAP4 and POP daemons that come with it (see the discussion below). The
22177 rules allow for shared access to the mailbox. However, this kind of locking
22178 does not work when the mailbox is NFS mounted.
22179
22180 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22181 &%use_flock_lock%& to control what kind of locking is used in implementing the
22182 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22183 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22184
22185
22186
22187
22188 .section "Operational details for appending" "SECTopappend"
22189 .cindex "appending to a file"
22190 .cindex "file" "appending"
22191 Before appending to a file, the following preparations are made:
22192
22193 .ilist
22194 If the name of the file is &_/dev/null_&, no action is taken, and a success
22195 return is given.
22196
22197 .next
22198 .cindex "directory creation"
22199 If any directories on the file's path are missing, Exim creates them if the
22200 &%create_directory%& option is set. A created directory's mode is given by the
22201 &%directory_mode%& option.
22202
22203 .next
22204 If &%file_format%& is set, the format of an existing file is checked. If this
22205 indicates that a different transport should be used, control is passed to that
22206 transport.
22207
22208 .next
22209 .cindex "file" "locking"
22210 .cindex "locking files"
22211 .cindex "NFS" "lock file"
22212 If &%use_lockfile%& is set, a lock file is built in a way that will work
22213 reliably over NFS, as follows:
22214
22215 .olist
22216 Create a &"hitching post"& file whose name is that of the lock file with the
22217 current time, primary host name, and process id added, by opening for writing
22218 as a new file. If this fails with an access error, delivery is deferred.
22219 .next
22220 Close the hitching post file, and hard link it to the lock file name.
22221 .next
22222 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22223 Unlink the hitching post name.
22224 .next
22225 Otherwise, use &[stat()]& to get information about the hitching post file, and
22226 then unlink hitching post name. If the number of links is exactly two, creation
22227 of the lock file succeeded but something (for example, an NFS server crash and
22228 restart) caused this fact not to be communicated to the &[link()]& call.
22229 .next
22230 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22231 up to &%lock_retries%& times. However, since any program that writes to a
22232 mailbox should complete its task very quickly, it is reasonable to time out old
22233 lock files that are normally the result of user agent and system crashes. If an
22234 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22235 it before trying again.
22236 .endlist olist
22237
22238 .next
22239 A call is made to &[lstat()]& to discover whether the main file exists, and if
22240 so, what its characteristics are. If &[lstat()]& fails for any reason other
22241 than non-existence, delivery is deferred.
22242
22243 .next
22244 .cindex "symbolic link" "to mailbox"
22245 .cindex "mailbox" "symbolic link"
22246 If the file does exist and is a symbolic link, delivery is deferred, unless the
22247 &%allow_symlink%& option is set, in which case the ownership of the link is
22248 checked, and then &[stat()]& is called to find out about the real file, which
22249 is then subjected to the checks below. The check on the top-level link
22250 ownership prevents one user creating a link for another's mailbox in a sticky
22251 directory, though allowing symbolic links in this case is definitely not a good
22252 idea. If there is a chain of symbolic links, the intermediate ones are not
22253 checked.
22254
22255 .next
22256 If the file already exists but is not a regular file, or if the file's owner
22257 and group (if the group is being checked &-- see &%check_group%& above) are
22258 different from the user and group under which the delivery is running,
22259 delivery is deferred.
22260
22261 .next
22262 If the file's permissions are more generous than specified, they are reduced.
22263 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22264 is set false, in which case the delivery is tried using the existing
22265 permissions.
22266
22267 .next
22268 The file's inode number is saved, and the file is then opened for appending.
22269 If this fails because the file has vanished, &(appendfile)& behaves as if it
22270 hadn't existed (see below). For any other failures, delivery is deferred.
22271
22272 .next
22273 If the file is opened successfully, check that the inode number hasn't
22274 changed, that it is still a regular file, and that the owner and permissions
22275 have not changed. If anything is wrong, defer delivery and freeze the message.
22276
22277 .next
22278 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22279 option is set. Otherwise, check that the file is being created in a permitted
22280 directory if the &%create_file%& option is set (deferring on failure), and then
22281 open for writing as a new file, with the O_EXCL and O_CREAT options,
22282 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22283 set). In this case, which can happen if the link points to a non-existent file,
22284 the file is opened for writing using O_CREAT but not O_EXCL, because
22285 that prevents link following.
22286
22287 .next
22288 .cindex "loop" "while file testing"
22289 If opening fails because the file exists, obey the tests given above for
22290 existing files. However, to avoid looping in a situation where the file is
22291 being continuously created and destroyed, the exists/not-exists loop is broken
22292 after 10 repetitions, and the message is then frozen.
22293
22294 .next
22295 If opening fails with any other error, defer delivery.
22296
22297 .next
22298 .cindex "file" "locking"
22299 .cindex "locking files"
22300 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22301 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22302 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22303 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22304 file, and an exclusive lock on the file whose name is
22305 .code
22306 /tmp/.<device-number>.<inode-number>
22307 .endd
22308 using the device and inode numbers of the open mailbox file, in accordance with
22309 the MBX locking rules. This file is created with a mode that is specified by
22310 the &%lockfile_mode%& option.
22311
22312 If Exim fails to lock the file, there are two possible courses of action,
22313 depending on the value of the locking timeout. This is obtained from
22314 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22315
22316 If the timeout value is zero, the file is closed, Exim waits for
22317 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22318 to lock it again. This happens up to &%lock_retries%& times, after which the
22319 delivery is deferred.
22320
22321 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22322 &[flock()]& are used (with the given timeout), so there has already been some
22323 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22324 immediately. It retries up to
22325 .code
22326 (lock_retries * lock_interval) / <timeout>
22327 .endd
22328 times (rounded up).
22329 .endlist
22330
22331 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22332 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22333
22334
22335 .section "Operational details for delivery to a new file" "SECTopdir"
22336 .cindex "delivery" "to single file"
22337 .cindex "&""From""& line"
22338 When the &%directory%& option is set instead of &%file%&, each message is
22339 delivered into a newly-created file or set of files. When &(appendfile)& is
22340 activated directly from a &(redirect)& router, neither &%file%& nor
22341 &%directory%& is normally set, because the path for delivery is supplied by the
22342 router. (See for example, the &(address_file)& transport in the default
22343 configuration.) In this case, delivery is to a new file if either the path name
22344 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22345
22346 No locking is required while writing the message to a new file, so the various
22347 locking options of the transport are ignored. The &"From"& line that by default
22348 separates messages in a single file is not normally needed, nor is the escaping
22349 of message lines that start with &"From"&, and there is no need to ensure a
22350 newline at the end of each message. Consequently, the default values for
22351 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22352 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22353
22354 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22355 the files in the delivery directory by default. However, you can specify a
22356 different directory by setting &%quota_directory%&. Also, for maildir
22357 deliveries (see below) the &_maildirfolder_& convention is honoured.
22358
22359
22360 .cindex "maildir format"
22361 .cindex "mailstore format"
22362 There are three different ways in which delivery to individual files can be
22363 done, controlled by the settings of the &%maildir_format%& and
22364 &%mailstore_format%& options. Note that code to support maildir or mailstore
22365 formats is not included in the binary unless SUPPORT_MAILDIR or
22366 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22367
22368 .cindex "directory creation"
22369 In all three cases an attempt is made to create the directory and any necessary
22370 sub-directories if they do not exist, provided that the &%create_directory%&
22371 option is set (the default). The location of a created directory can be
22372 constrained by setting &%create_file%&. A created directory's mode is given by
22373 the &%directory_mode%& option. If creation fails, or if the
22374 &%create_directory%& option is not set when creation is required, delivery is
22375 deferred.
22376
22377
22378
22379 .section "Maildir delivery" "SECTmaildirdelivery"
22380 .cindex "maildir format" "description of"
22381 If the &%maildir_format%& option is true, Exim delivers each message by writing
22382 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22383 directory that is defined by the &%directory%& option (the &"delivery
22384 directory"&). If the delivery is successful, the file is renamed into the
22385 &_new_& subdirectory.
22386
22387 In the file name, <&'stime'&> is the current time of day in seconds, and
22388 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22389 Exim checks that the time-of-day clock has moved on by at least one microsecond
22390 before terminating the delivery process. This guarantees uniqueness for the
22391 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22392 opening it. If any response other than ENOENT (does not exist) is given,
22393 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22394
22395 Before Exim carries out a maildir delivery, it ensures that subdirectories
22396 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22397 do not exist, Exim tries to create them and any superior directories in their
22398 path, subject to the &%create_directory%& and &%create_file%& options. If the
22399 &%maildirfolder_create_regex%& option is set, and the regular expression it
22400 contains matches the delivery directory, Exim also ensures that a file called
22401 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22402 &_maildirfolder_& file cannot be created, delivery is deferred.
22403
22404 These features make it possible to use Exim to create all the necessary files
22405 and directories in a maildir mailbox, including subdirectories for maildir++
22406 folders. Consider this example:
22407 .code
22408 maildir_format = true
22409 directory = /var/mail/$local_part\
22410            ${if eq{$local_part_suffix}{}{}\
22411            {/.${substr_1:$local_part_suffix}}}
22412 maildirfolder_create_regex = /\.[^/]+$
22413 .endd
22414 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22415 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22416 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22417 not match this name, so Exim will not look for or create the file
22418 &_/var/mail/pimbo/maildirfolder_&, though it will create
22419 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22420
22421 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22422 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22423 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22424 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22425 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22426
22427 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22428 not inadvertently match the toplevel maildir directory, because a
22429 &_maildirfolder_& file at top level would completely break quota calculations.
22430
22431 .cindex "quota" "in maildir delivery"
22432 .cindex "maildir++"
22433 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22434 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22435 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22436 Exim assumes the directory is a maildir++ folder directory, which is one level
22437 down from the user's top level mailbox directory. This causes it to start at
22438 the parent directory instead of the current directory when calculating the
22439 amount of space used.
22440
22441 One problem with delivering into a multi-file mailbox is that it is
22442 computationally expensive to compute the size of the mailbox for quota
22443 checking. Various approaches have been taken to reduce the amount of work
22444 needed. The next two sections describe two of them. A third alternative is to
22445 use some external process for maintaining the size data, and use the expansion
22446 of the &%mailbox_size%& option as a way of importing it into Exim.
22447
22448
22449
22450
22451 .section "Using tags to record message sizes" "SECID135"
22452 If &%maildir_tag%& is set, the string is expanded for each delivery.
22453 When the maildir file is renamed into the &_new_& sub-directory, the
22454 tag is added to its name. However, if adding the tag takes the length of the
22455 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22456 the tag is dropped and the maildir file is created with no tag.
22457
22458
22459 .vindex "&$message_size$&"
22460 Tags can be used to encode the size of files in their names; see
22461 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22462 happens after the message has been written. The value of the &$message_size$&
22463 variable is set to the number of bytes actually written. If the expansion is
22464 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22465 be deferred. The expanded tag may contain any printing characters except &"/"&.
22466 Non-printing characters in the string are ignored; if the resulting string is
22467 empty, it is ignored. If it starts with an alphanumeric character, a leading
22468 colon is inserted; this default has not proven to be the path that popular
22469 maildir implementations have chosen (but changing it in Exim would break
22470 backwards compatibility).
22471
22472 For one common implementation, you might set:
22473 .code
22474 maildir_tag = ,S=${message_size}
22475 .endd
22476 but you should check the documentation of the other software to be sure.
22477
22478 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22479 as this allows Exim to extract the size from your tag, instead of having to
22480 &[stat()]& each message file.
22481
22482
22483 .section "Using a maildirsize file" "SECID136"
22484 .cindex "quota" "in maildir delivery"
22485 .cindex "maildir format" "&_maildirsize_& file"
22486 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22487 storing quota and message size information in a file called &_maildirsize_&
22488 within the toplevel maildir directory. If this file does not exist, Exim
22489 creates it, setting the quota from the &%quota%& option of the transport. If
22490 the maildir directory itself does not exist, it is created before any attempt
22491 to write a &_maildirsize_& file.
22492
22493 The &_maildirsize_& file is used to hold information about the sizes of
22494 messages in the maildir, thus speeding up quota calculations. The quota value
22495 in the file is just a cache; if the quota is changed in the transport, the new
22496 value overrides the cached value when the next message is delivered. The cache
22497 is maintained for the benefit of other programs that access the maildir and
22498 need to know the quota.
22499
22500 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22501 file is maintained (with a zero quota setting), but no quota is imposed.
22502
22503 A regular expression is available for controlling which directories in the
22504 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22505 See the description of the &%maildir_quota_directory_regex%& option above for
22506 details.
22507
22508
22509 .section "Mailstore delivery" "SECID137"
22510 .cindex "mailstore format" "description of"
22511 If the &%mailstore_format%& option is true, each message is written as two
22512 files in the given directory. A unique base name is constructed from the
22513 message id and the current delivery process, and the files that are written use
22514 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22515 contains the message's envelope, and the &_.msg_& file contains the message
22516 itself. The base name is placed in the variable &$mailstore_basename$&.
22517
22518 During delivery, the envelope is first written to a file with the suffix
22519 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22520 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22521 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22522 file before accessing either of them. An alternative approach is to wait for
22523 the absence of a &_.tmp_& file.
22524
22525 The envelope file starts with any text defined by the &%mailstore_prefix%&
22526 option, expanded and terminated by a newline if there isn't one. Then follows
22527 the sender address on one line, then all the recipient addresses, one per line.
22528 There can be more than one recipient only if the &%batch_max%& option is set
22529 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22530 appended to the file, followed by a newline if it does not end with one.
22531
22532 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22533 failure, it is ignored. Other expansion errors are treated as serious
22534 configuration errors, and delivery is deferred. The variable
22535 &$mailstore_basename$& is available for use during these expansions.
22536
22537
22538 .section "Non-special new file delivery" "SECID138"
22539 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22540 file is created directly in the named directory. For example, when delivering
22541 messages into files in batched SMTP format for later delivery to some host (see
22542 section &<<SECTbatchSMTP>>&), a setting such as
22543 .code
22544 directory = /var/bsmtp/$host
22545 .endd
22546 might be used. A message is written to a file with a temporary name, which is
22547 then renamed when the delivery is complete. The final name is obtained by
22548 expanding the contents of the &%directory_file%& option.
22549 .ecindex IIDapptra1
22550 .ecindex IIDapptra2
22551
22552
22553
22554
22555
22556
22557 . ////////////////////////////////////////////////////////////////////////////
22558 . ////////////////////////////////////////////////////////////////////////////
22559
22560 .chapter "The autoreply transport" "CHID8"
22561 .scindex IIDauttra1 "transports" "&(autoreply)&"
22562 .scindex IIDauttra2 "&(autoreply)& transport"
22563 The &(autoreply)& transport is not a true transport in that it does not cause
22564 the message to be transmitted. Instead, it generates a new mail message as an
22565 automatic reply to the incoming message. &'References:'& and
22566 &'Auto-Submitted:'& header lines are included. These are constructed according
22567 to the rules in RFCs 2822 and 3834, respectively.
22568
22569 If the router that passes the message to this transport does not have the
22570 &%unseen%& option set, the original message (for the current recipient) is not
22571 delivered anywhere. However, when the &%unseen%& option is set on the router
22572 that passes the message to this transport, routing of the address continues, so
22573 another router can set up a normal message delivery.
22574
22575
22576 The &(autoreply)& transport is usually run as the result of mail filtering, a
22577 &"vacation"& message being the standard example. However, it can also be run
22578 directly from a router like any other transport. To reduce the possibility of
22579 message cascades, messages created by the &(autoreply)& transport always have
22580 empty envelope sender addresses, like bounce messages.
22581
22582 The parameters of the message to be sent can be specified in the configuration
22583 by options described below. However, these are used only when the address
22584 passed to the transport does not contain its own reply information. When the
22585 transport is run as a consequence of a
22586 &%mail%&
22587 or &%vacation%& command in a filter file, the parameters of the message are
22588 supplied by the filter, and passed with the address. The transport's options
22589 that define the message are then ignored (so they are not usually set in this
22590 case). The message is specified entirely by the filter or by the transport; it
22591 is never built from a mixture of options. However, the &%file_optional%&,
22592 &%mode%&, and &%return_message%& options apply in all cases.
22593
22594 &(Autoreply)& is implemented as a local transport. When used as a result of a
22595 command in a user's filter file, &(autoreply)& normally runs under the uid and
22596 gid of the user, and with appropriate current and home directories (see chapter
22597 &<<CHAPenvironment>>&).
22598
22599 There is a subtle difference between routing a message to a &(pipe)& transport
22600 that generates some text to be returned to the sender, and routing it to an
22601 &(autoreply)& transport. This difference is noticeable only if more than one
22602 address from the same message is so handled. In the case of a pipe, the
22603 separate outputs from the different addresses are gathered up and returned to
22604 the sender in a single message, whereas if &(autoreply)& is used, a separate
22605 message is generated for each address that is passed to it.
22606
22607 Non-printing characters are not permitted in the header lines generated for the
22608 message that &(autoreply)& creates, with the exception of newlines that are
22609 immediately followed by white space. If any non-printing characters are found,
22610 the transport defers.
22611 Whether characters with the top bit set count as printing characters or not is
22612 controlled by the &%print_topbitchars%& global option.
22613
22614 If any of the generic options for manipulating headers (for example,
22615 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22616 of the original message that is included in the generated message when
22617 &%return_message%& is set. They do not apply to the generated message itself.
22618
22619 .vindex "&$sender_address$&"
22620 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22621 the message, indicating that there were no recipients, it does not treat this
22622 as an error. This means that autoreplies sent to &$sender_address$& when this
22623 is empty (because the incoming message is a bounce message) do not cause
22624 problems. They are just discarded.
22625
22626
22627
22628 .section "Private options for autoreply" "SECID139"
22629 .cindex "options" "&(autoreply)& transport"
22630
22631 .option bcc autoreply string&!! unset
22632 This specifies the addresses that are to receive &"blind carbon copies"& of the
22633 message when the message is specified by the transport.
22634
22635
22636 .option cc autoreply string&!! unset
22637 This specifies recipients of the message and the contents of the &'Cc:'& header
22638 when the message is specified by the transport.
22639
22640
22641 .option file autoreply string&!! unset
22642 The contents of the file are sent as the body of the message when the message
22643 is specified by the transport. If both &%file%& and &%text%& are set, the text
22644 string comes first.
22645
22646
22647 .option file_expand autoreply boolean false
22648 If this is set, the contents of the file named by the &%file%& option are
22649 subjected to string expansion as they are added to the message.
22650
22651
22652 .option file_optional autoreply boolean false
22653 If this option is true, no error is generated if the file named by the &%file%&
22654 option or passed with the address does not exist or cannot be read.
22655
22656
22657 .option from autoreply string&!! unset
22658 This specifies the contents of the &'From:'& header when the message is
22659 specified by the transport.
22660
22661
22662 .option headers autoreply string&!! unset
22663 This specifies additional RFC 2822 headers that are to be added to the message
22664 when the message is specified by the transport. Several can be given by using
22665 &"\n"& to separate them. There is no check on the format.
22666
22667
22668 .option log autoreply string&!! unset
22669 This option names a file in which a record of every message sent is logged when
22670 the message is specified by the transport.
22671
22672
22673 .option mode autoreply "octal integer" 0600
22674 If either the log file or the &"once"& file has to be created, this mode is
22675 used.
22676
22677
22678 .option never_mail autoreply "address list&!!" unset
22679 If any run of the transport creates a message with a recipient that matches any
22680 item in the list, that recipient is quietly discarded. If all recipients are
22681 discarded, no message is created. This applies both when the recipients are
22682 generated by a filter and when they are specified in the transport.
22683
22684
22685
22686 .option once autoreply string&!! unset
22687 This option names a file or DBM database in which a record of each &'To:'&
22688 recipient is kept when the message is specified by the transport. &*Note*&:
22689 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22690
22691 If &%once%& is unset, or is set to an empty string, the message is always sent.
22692 By default, if &%once%& is set to a non-empty file name, the message
22693 is not sent if a potential recipient is already listed in the database.
22694 However, if the &%once_repeat%& option specifies a time greater than zero, the
22695 message is sent if that much time has elapsed since a message was last sent to
22696 this recipient. A setting of zero time for &%once_repeat%& (the default)
22697 prevents a message from being sent a second time &-- in this case, zero means
22698 infinity.
22699
22700 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22701 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22702 greater than zero, it changes the way Exim implements the &%once%& option.
22703 Instead of using a DBM file to record every recipient it sends to, it uses a
22704 regular file, whose size will never get larger than the given value.
22705
22706 In the file, Exim keeps a linear list of recipient addresses and the times at
22707 which they were sent messages. If the file is full when a new address needs to
22708 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22709 means that a given recipient may receive multiple messages, but at
22710 unpredictable intervals that depend on the rate of turnover of addresses in the
22711 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22712
22713
22714 .option once_file_size autoreply integer 0
22715 See &%once%& above.
22716
22717
22718 .option once_repeat autoreply time&!! 0s
22719 See &%once%& above.
22720 After expansion, the value of this option must be a valid time value.
22721
22722
22723 .option reply_to autoreply string&!! unset
22724 This specifies the contents of the &'Reply-To:'& header when the message is
22725 specified by the transport.
22726
22727
22728 .option return_message autoreply boolean false
22729 If this is set, a copy of the original message is returned with the new
22730 message, subject to the maximum size set in the &%return_size_limit%& global
22731 configuration option.
22732
22733
22734 .option subject autoreply string&!! unset
22735 This specifies the contents of the &'Subject:'& header when the message is
22736 specified by the transport. It is tempting to quote the original subject in
22737 automatic responses. For example:
22738 .code
22739 subject = Re: $h_subject:
22740 .endd
22741 There is a danger in doing this, however. It may allow a third party to
22742 subscribe your users to an opt-in mailing list, provided that the list accepts
22743 bounce messages as subscription confirmations. Well-managed lists require a
22744 non-bounce message to confirm a subscription, so the danger is relatively
22745 small.
22746
22747
22748
22749 .option text autoreply string&!! unset
22750 This specifies a single string to be used as the body of the message when the
22751 message is specified by the transport. If both &%text%& and &%file%& are set,
22752 the text comes first.
22753
22754
22755 .option to autoreply string&!! unset
22756 This specifies recipients of the message and the contents of the &'To:'& header
22757 when the message is specified by the transport.
22758 .ecindex IIDauttra1
22759 .ecindex IIDauttra2
22760
22761
22762
22763
22764 . ////////////////////////////////////////////////////////////////////////////
22765 . ////////////////////////////////////////////////////////////////////////////
22766
22767 .chapter "The lmtp transport" "CHAPLMTP"
22768 .cindex "transports" "&(lmtp)&"
22769 .cindex "&(lmtp)& transport"
22770 .cindex "LMTP" "over a pipe"
22771 .cindex "LMTP" "over a socket"
22772 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22773 specified command
22774 or by interacting with a Unix domain socket.
22775 This transport is something of a cross between the &(pipe)& and &(smtp)&
22776 transports. Exim also has support for using LMTP over TCP/IP; this is
22777 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22778 to be of minority interest, the default build-time configure in &_src/EDITME_&
22779 has it commented out. You need to ensure that
22780 .code
22781 TRANSPORT_LMTP=yes
22782 .endd
22783 .cindex "options" "&(lmtp)& transport"
22784 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22785 included in the Exim binary. The private options of the &(lmtp)& transport are
22786 as follows:
22787
22788 .option batch_id lmtp string&!! unset
22789 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22790
22791
22792 .option batch_max lmtp integer 1
22793 This limits the number of addresses that can be handled in a single delivery.
22794 Most LMTP servers can handle several addresses at once, so it is normally a
22795 good idea to increase this value. See the description of local delivery
22796 batching in chapter &<<CHAPbatching>>&.
22797
22798
22799 .option command lmtp string&!! unset
22800 This option must be set if &%socket%& is not set. The string is a command which
22801 is run in a separate process. It is split up into a command name and list of
22802 arguments, each of which is separately expanded (so expansion cannot change the
22803 number of arguments). The command is run directly, not via a shell. The message
22804 is passed to the new process using the standard input and output to operate the
22805 LMTP protocol.
22806
22807 .option ignore_quota lmtp boolean false
22808 .cindex "LMTP" "ignoring quota errors"
22809 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22810 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22811 in its response to the LHLO command.
22812
22813 .option socket lmtp string&!! unset
22814 This option must be set if &%command%& is not set. The result of expansion must
22815 be the name of a Unix domain socket. The transport connects to the socket and
22816 delivers the message to it using the LMTP protocol.
22817
22818
22819 .option timeout lmtp time 5m
22820 The transport is aborted if the created process or Unix domain socket does not
22821 respond to LMTP commands or message input within this timeout. Delivery
22822 is deferred, and will be tried again later. Here is an example of a typical
22823 LMTP transport:
22824 .code
22825 lmtp:
22826   driver = lmtp
22827   command = /some/local/lmtp/delivery/program
22828   batch_max = 20
22829   user = exim
22830 .endd
22831 This delivers up to 20 addresses at a time, in a mixture of domains if
22832 necessary, running as the user &'exim'&.
22833
22834
22835
22836 . ////////////////////////////////////////////////////////////////////////////
22837 . ////////////////////////////////////////////////////////////////////////////
22838
22839 .chapter "The pipe transport" "CHAPpipetransport"
22840 .scindex IIDpiptra1 "transports" "&(pipe)&"
22841 .scindex IIDpiptra2 "&(pipe)& transport"
22842 The &(pipe)& transport is used to deliver messages via a pipe to a command
22843 running in another process. One example is the use of &(pipe)& as a
22844 pseudo-remote transport for passing messages to some other delivery mechanism
22845 (such as UUCP). Another is the use by individual users to automatically process
22846 their incoming messages. The &(pipe)& transport can be used in one of the
22847 following ways:
22848
22849 .ilist
22850 .vindex "&$local_part$&"
22851 A router routes one address to a transport in the normal way, and the
22852 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22853 contains the local part of the address (as usual), and the command that is run
22854 is specified by the &%command%& option on the transport.
22855 .next
22856 .vindex "&$pipe_addresses$&"
22857 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22858 transport can handle more than one address in a single run. In this case, when
22859 more than one address is routed to the transport, &$local_part$& is not set
22860 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22861 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22862 that are routed to the transport.
22863 .next
22864 .vindex "&$address_pipe$&"
22865 A router redirects an address directly to a pipe command (for example, from an
22866 alias or forward file). In this case, &$address_pipe$& contains the text of the
22867 pipe command, and the &%command%& option on the transport is ignored unless
22868 &%force_command%& is set. If only one address is being transported
22869 (&%batch_max%& is not greater than one, or only one address was redirected to
22870 this pipe command), &$local_part$& contains the local part that was redirected.
22871 .endlist
22872
22873
22874 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22875 deliver messages over pipes using the LMTP interactive protocol. This is
22876 implemented by the &(lmtp)& transport.
22877
22878 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22879 &_.forward_& file, the command runs under the uid and gid of that user. In
22880 other cases, the uid and gid have to be specified explicitly, either on the
22881 transport or on the router that handles the address. Current and &"home"&
22882 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22883 details of the local delivery environment and chapter &<<CHAPbatching>>&
22884 for a discussion of local delivery batching.
22885
22886
22887 .section "Concurrent delivery" "SECID140"
22888 If two messages arrive at almost the same time, and both are routed to a pipe
22889 delivery, the two pipe transports may be run concurrently. You must ensure that
22890 any pipe commands you set up are robust against this happening. If the commands
22891 write to a file, the &%exim_lock%& utility might be of use.
22892 Alternatively the &%max_parallel%& option could be used with a value
22893 of "1" to enforce serialization.
22894
22895
22896
22897
22898 .section "Returned status and data" "SECID141"
22899 .cindex "&(pipe)& transport" "returned data"
22900 If the command exits with a non-zero return code, the delivery is deemed to
22901 have failed, unless either the &%ignore_status%& option is set (in which case
22902 the return code is treated as zero), or the return code is one of those listed
22903 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22904 later"&. In this case, delivery is deferred. Details of a permanent failure are
22905 logged, but are not included in the bounce message, which merely contains
22906 &"local delivery failed"&.
22907
22908 If the command exits on a signal and the &%freeze_signal%& option is set then
22909 the message will be frozen in the queue. If that option is not set, a bounce
22910 will be sent as normal.
22911
22912 If the return code is greater than 128 and the command being run is a shell
22913 script, it normally means that the script was terminated by a signal whose
22914 value is the return code minus 128. The &%freeze_signal%& option does not
22915 apply in this case.
22916
22917 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22918 return code is set to 127. This is the value that a shell returns if it is
22919 asked to run a non-existent command. The wording for the log line suggests that
22920 a non-existent command may be the problem.
22921
22922 The &%return_output%& option can affect the result of a pipe delivery. If it is
22923 set and the command produces any output on its standard output or standard
22924 error streams, the command is considered to have failed, even if it gave a zero
22925 return code or if &%ignore_status%& is set. The output from the command is
22926 included as part of the bounce message. The &%return_fail_output%& option is
22927 similar, except that output is returned only when the command exits with a
22928 failure return code, that is, a value other than zero or a code that matches
22929 &%temp_errors%&.
22930
22931
22932
22933 .section "How the command is run" "SECThowcommandrun"
22934 .cindex "&(pipe)& transport" "path for command"
22935 The command line is (by default) broken down into a command name and arguments
22936 by the &(pipe)& transport itself. The &%allow_commands%& and
22937 &%restrict_to_path%& options can be used to restrict the commands that may be
22938 run.
22939
22940 .cindex "quoting" "in pipe command"
22941 Unquoted arguments are delimited by white space. If an argument appears in
22942 double quotes, backslash is interpreted as an escape character in the usual
22943 way. If an argument appears in single quotes, no escaping is done.
22944
22945 String expansion is applied to the command line except when it comes from a
22946 traditional &_.forward_& file (commands from a filter file are expanded). The
22947 expansion is applied to each argument in turn rather than to the whole line.
22948 For this reason, any string expansion item that contains white space must be
22949 quoted so as to be contained within a single argument. A setting such as
22950 .code
22951 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22952 .endd
22953 will not work, because the expansion item gets split between several
22954 arguments. You have to write
22955 .code
22956 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22957 .endd
22958 to ensure that it is all in one argument. The expansion is done in this way,
22959 argument by argument, so that the number of arguments cannot be changed as a
22960 result of expansion, and quotes or backslashes in inserted variables do not
22961 interact with external quoting. However, this leads to problems if you want to
22962 generate multiple arguments (or the command name plus arguments) from a single
22963 expansion. In this situation, the simplest solution is to use a shell. For
22964 example:
22965 .code
22966 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22967 .endd
22968
22969 .cindex "transport" "filter"
22970 .cindex "filter" "transport filter"
22971 .vindex "&$pipe_addresses$&"
22972 Special handling takes place when an argument consists of precisely the text
22973 &`$pipe_addresses`&. This is not a general expansion variable; the only
22974 place this string is recognized is when it appears as an argument for a pipe or
22975 transport filter command. It causes each address that is being handled to be
22976 inserted in the argument list at that point &'as a separate argument'&. This
22977 avoids any problems with spaces or shell metacharacters, and is of use when a
22978 &(pipe)& transport is handling groups of addresses in a batch.
22979
22980 If &%force_command%& is enabled on the transport, Special handling takes place
22981 for an argument that consists of precisely the text &`$address_pipe`&.  It
22982 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22983 argument is inserted in the argument list at that point
22984 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22985 the only item in the argument; in fact, if it were then &%force_command%&
22986 should behave as a no-op.  Rather, it should be used to adjust the command
22987 run while preserving the argument vector separation.
22988
22989 After splitting up into arguments and expansion, the resulting command is run
22990 in a subprocess directly from the transport, &'not'& under a shell. The
22991 message that is being delivered is supplied on the standard input, and the
22992 standard output and standard error are both connected to a single pipe that is
22993 read by Exim. The &%max_output%& option controls how much output the command
22994 may produce, and the &%return_output%& and &%return_fail_output%& options
22995 control what is done with it.
22996
22997 Not running the command under a shell (by default) lessens the security risks
22998 in cases when a command from a user's filter file is built out of data that was
22999 taken from an incoming message. If a shell is required, it can of course be
23000 explicitly specified as the command to be run. However, there are circumstances
23001 where existing commands (for example, in &_.forward_& files) expect to be run
23002 under a shell and cannot easily be modified. To allow for these cases, there is
23003 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23004 works. Instead of breaking up the command line as just described, it expands it
23005 as a single string and passes the result to &_/bin/sh_&. The
23006 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23007 with &%use_shell%&, and the whole mechanism is inherently less secure.
23008
23009
23010
23011 .section "Environment variables" "SECTpipeenv"
23012 .cindex "&(pipe)& transport" "environment for command"
23013 .cindex "environment" "&(pipe)& transport"
23014 The environment variables listed below are set up when the command is invoked.
23015 This list is a compromise for maximum compatibility with other MTAs. Note that
23016 the &%environment%& option can be used to add additional variables to this
23017 environment. The environment for the &(pipe)& transport is not subject
23018 to the &%add_environment%& and &%keep_environment%& main config options.
23019 .display
23020 &`DOMAIN            `&   the domain of the address
23021 &`HOME              `&   the home directory, if set
23022 &`HOST              `&   the host name when called from a router (see below)
23023 &`LOCAL_PART        `&   see below
23024 &`LOCAL_PART_PREFIX `&   see below
23025 &`LOCAL_PART_SUFFIX `&   see below
23026 &`LOGNAME           `&   see below
23027 &`MESSAGE_ID        `&   Exim's local ID for the message
23028 &`PATH              `&   as specified by the &%path%& option below
23029 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23030 &`RECIPIENT         `&   the complete recipient address
23031 &`SENDER            `&   the sender of the message (empty if a bounce)
23032 &`SHELL             `&   &`/bin/sh`&
23033 &`TZ                `&   the value of the &%timezone%& option, if set
23034 &`USER              `&   see below
23035 .endd
23036 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23037 router, LOCAL_PART is set to the local part of the address. When it is
23038 called as a result of a forward or alias expansion, LOCAL_PART is set to
23039 the local part of the address that was expanded. In both cases, any affixes are
23040 removed from the local part, and made available in LOCAL_PART_PREFIX and
23041 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23042 same value as LOCAL_PART for compatibility with other MTAs.
23043
23044 .cindex "HOST"
23045 HOST is set only when a &(pipe)& transport is called from a router that
23046 associates hosts with an address, typically when using &(pipe)& as a
23047 pseudo-remote transport. HOST is set to the first host name specified by
23048 the router.
23049
23050 .cindex "HOME"
23051 If the transport's generic &%home_directory%& option is set, its value is used
23052 for the HOME environment variable. Otherwise, a home directory may be set
23053 by the router's &%transport_home_directory%& option, which defaults to the
23054 user's home directory if &%check_local_user%& is set.
23055
23056
23057 .section "Private options for pipe" "SECID142"
23058 .cindex "options" "&(pipe)& transport"
23059
23060
23061
23062 .option allow_commands pipe "string list&!!" unset
23063 .cindex "&(pipe)& transport" "permitted commands"
23064 The string is expanded, and is then interpreted as a colon-separated list of
23065 permitted commands. If &%restrict_to_path%& is not set, the only commands
23066 permitted are those in the &%allow_commands%& list. They need not be absolute
23067 paths; the &%path%& option is still used for relative paths. If
23068 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23069 in the &%allow_commands%& list, or a name without any slashes that is found on
23070 the path. In other words, if neither &%allow_commands%& nor
23071 &%restrict_to_path%& is set, there is no restriction on the command, but
23072 otherwise only commands that are permitted by one or the other are allowed. For
23073 example, if
23074 .code
23075 allow_commands = /usr/bin/vacation
23076 .endd
23077 and &%restrict_to_path%& is not set, the only permitted command is
23078 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23079 &%use_shell%& is set.
23080
23081
23082 .option batch_id pipe string&!! unset
23083 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23084
23085
23086 .option batch_max pipe integer 1
23087 This limits the number of addresses that can be handled in a single delivery.
23088 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23089
23090
23091 .option check_string pipe string unset
23092 As &(pipe)& writes the message, the start of each line is tested for matching
23093 &%check_string%&, and if it does, the initial matching characters are replaced
23094 by the contents of &%escape_string%&, provided both are set. The value of
23095 &%check_string%& is a literal string, not a regular expression, and the case of
23096 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23097 of &%check_string%& and &%escape_string%& are forced to values that implement
23098 the SMTP escaping protocol. Any settings made in the configuration file are
23099 ignored.
23100
23101
23102 .option command pipe string&!! unset
23103 This option need not be set when &(pipe)& is being used to deliver to pipes
23104 obtained directly from address redirections. In other cases, the option must be
23105 set, to provide a command to be run. It need not yield an absolute path (see
23106 the &%path%& option below). The command is split up into separate arguments by
23107 Exim, and each argument is separately expanded, as described in section
23108 &<<SECThowcommandrun>>& above.
23109
23110
23111 .option environment pipe string&!! unset
23112 .cindex "&(pipe)& transport" "environment for command"
23113 .cindex "environment" "&(pipe)& transport"
23114 This option is used to add additional variables to the environment in which the
23115 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23116 a string which is expanded, and then interpreted as a colon-separated list of
23117 environment settings of the form <&'name'&>=<&'value'&>.
23118
23119
23120 .option escape_string pipe string unset
23121 See &%check_string%& above.
23122
23123
23124 .option freeze_exec_fail pipe boolean false
23125 .cindex "exec failure"
23126 .cindex "failure of exec"
23127 .cindex "&(pipe)& transport" "failure of exec"
23128 Failure to exec the command in a pipe transport is by default treated like
23129 any other failure while running the command. However, if &%freeze_exec_fail%&
23130 is set, failure to exec is treated specially, and causes the message to be
23131 frozen, whatever the setting of &%ignore_status%&.
23132
23133
23134 .option freeze_signal pipe boolean false
23135 .cindex "signal exit"
23136 .cindex "&(pipe)& transport", "signal exit"
23137 Normally if the process run by a command in a pipe transport exits on a signal,
23138 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23139 frozen in Exim's queue instead.
23140
23141
23142 .option force_command pipe boolean false
23143 .cindex "force command"
23144 .cindex "&(pipe)& transport", "force command"
23145 Normally when a router redirects an address directly to a pipe command
23146 the &%command%& option on the transport is ignored.  If &%force_command%&
23147 is set, the &%command%& option will used. This is especially
23148 useful for forcing a wrapper or additional argument to be added to the
23149 command. For example:
23150 .code
23151 command = /usr/bin/remote_exec myhost -- $address_pipe
23152 force_command
23153 .endd
23154
23155 Note that &$address_pipe$& is handled specially in &%command%& when
23156 &%force_command%& is set, expanding out to the original argument vector as
23157 separate items, similarly to a Unix shell &`"$@"`& construct.
23158
23159
23160 .option ignore_status pipe boolean false
23161 If this option is true, the status returned by the subprocess that is set up to
23162 run the command is ignored, and Exim behaves as if zero had been returned.
23163 Otherwise, a non-zero status or termination by signal causes an error return
23164 from the transport unless the status value is one of those listed in
23165 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23166
23167 &*Note*&: This option does not apply to timeouts, which do not return a status.
23168 See the &%timeout_defer%& option for how timeouts are handled.
23169
23170
23171 .option log_defer_output pipe boolean false
23172 .cindex "&(pipe)& transport" "logging output"
23173 If this option is set, and the status returned by the command is
23174 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23175 and any output was produced on stdout or stderr, the first line of it is
23176 written to the main log.
23177
23178
23179 .option log_fail_output pipe boolean false
23180 If this option is set, and the command returns any output on stdout or
23181 stderr, and also ends with a return code that is neither zero nor one of
23182 the return codes listed in &%temp_errors%& (that is, the delivery
23183 failed), the first line of output is written to the main log. This
23184 option and &%log_output%& are mutually exclusive.  Only one of them may
23185 be set.
23186
23187
23188 .option log_output pipe boolean false
23189 If this option is set and the command returns any output on stdout or
23190 stderr, the first line of output is written to the main log, whatever
23191 the return code. This option and &%log_fail_output%& are mutually
23192 exclusive. Only one of them may be set.
23193
23194
23195 .option max_output pipe integer 20K
23196 This specifies the maximum amount of output that the command may produce on its
23197 standard output and standard error file combined. If the limit is exceeded, the
23198 process running the command is killed. This is intended as a safety measure to
23199 catch runaway processes. The limit is applied independently of the settings of
23200 the options that control what is done with such output (for example,
23201 &%return_output%&). Because of buffering effects, the amount of output may
23202 exceed the limit by a small amount before Exim notices.
23203
23204
23205 .option message_prefix pipe string&!! "see below"
23206 The string specified here is expanded and output at the start of every message.
23207 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23208 .code
23209 message_prefix = \
23210   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23211   ${tod_bsdinbox}\n
23212 .endd
23213 .cindex "Cyrus"
23214 .cindex "&%tmail%&"
23215 .cindex "&""From""& line"
23216 This is required by the commonly used &_/usr/bin/vacation_& program.
23217 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23218 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23219 setting
23220 .code
23221 message_prefix =
23222 .endd
23223 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23224 &`\n`& to &`\r\n`& in &%message_prefix%&.
23225
23226
23227 .option message_suffix pipe string&!! "see below"
23228 The string specified here is expanded and output at the end of every message.
23229 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23230 The suffix can be suppressed by setting
23231 .code
23232 message_suffix =
23233 .endd
23234 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23235 &`\n`& to &`\r\n`& in &%message_suffix%&.
23236
23237
23238 .option path pipe string "see below"
23239 This option specifies the string that is set up in the PATH environment
23240 variable of the subprocess. The default is:
23241 .code
23242 /bin:/usr/bin
23243 .endd
23244 If the &%command%& option does not yield an absolute path name, the command is
23245 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23246 apply to a command specified as a transport filter.
23247
23248
23249 .option permit_coredump pipe boolean false
23250 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23251 a core-dump of a pipe command, enable this command.  This enables core-dumps
23252 during delivery and affects both the Exim binary and the pipe command run.
23253 It is recommended that this option remain off unless and until you have a need
23254 for it and that this only be enabled when needed, as the risk of excessive
23255 resource consumption can be quite high.  Note also that Exim is typically
23256 installed as a setuid binary and most operating systems will inhibit coredumps
23257 of these by default, so further OS-specific action may be required.
23258
23259
23260 .option pipe_as_creator pipe boolean false
23261 .cindex "uid (user id)" "local delivery"
23262 If the generic &%user%& option is not set and this option is true, the delivery
23263 process is run under the uid that was in force when Exim was originally called
23264 to accept the message. If the group id is not otherwise set (via the generic
23265 &%group%& option), the gid that was in force when Exim was originally called to
23266 accept the message is used.
23267
23268
23269 .option restrict_to_path pipe boolean false
23270 When this option is set, any command name not listed in &%allow_commands%& must
23271 contain no slashes. The command is searched for only in the directories listed
23272 in the &%path%& option. This option is intended for use in the case when a pipe
23273 command has been generated from a user's &_.forward_& file. This is usually
23274 handled by a &(pipe)& transport called &%address_pipe%&.
23275
23276
23277 .option return_fail_output pipe boolean false
23278 If this option is true, and the command produced any output and ended with a
23279 return code other than zero or one of the codes listed in &%temp_errors%& (that
23280 is, the delivery failed), the output is returned in the bounce message.
23281 However, if the message has a null sender (that is, it is itself a bounce
23282 message), output from the command is discarded. This option and
23283 &%return_output%& are mutually exclusive. Only one of them may be set.
23284
23285
23286
23287 .option return_output pipe boolean false
23288 If this option is true, and the command produced any output, the delivery is
23289 deemed to have failed whatever the return code from the command, and the output
23290 is returned in the bounce message. Otherwise, the output is just discarded.
23291 However, if the message has a null sender (that is, it is a bounce message),
23292 output from the command is always discarded, whatever the setting of this
23293 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23294 of them may be set.
23295
23296
23297
23298 .option temp_errors pipe "string list" "see below"
23299 .cindex "&(pipe)& transport" "temporary failure"
23300 This option contains either a colon-separated list of numbers, or a single
23301 asterisk. If &%ignore_status%& is false
23302 and &%return_output%& is not set,
23303 and the command exits with a non-zero return code, the failure is treated as
23304 temporary and the delivery is deferred if the return code matches one of the
23305 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23306 codes are treated as permanent errors. The default setting contains the codes
23307 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23308 compiled on a system that does not define these macros, it assumes values of 75
23309 and 73, respectively.
23310
23311
23312 .option timeout pipe time 1h
23313 If the command fails to complete within this time, it is killed. This normally
23314 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23315 specifies no timeout. In order to ensure that any subprocesses created by the
23316 command are also killed, Exim makes the initial process a process group leader,
23317 and kills the whole process group on a timeout. However, this can be defeated
23318 if one of the processes starts a new process group.
23319
23320 .option timeout_defer pipe boolean false
23321 A timeout in a &(pipe)& transport, either in the command that the transport
23322 runs, or in a transport filter that is associated with it, is by default
23323 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23324 is set true, both kinds of timeout become temporary errors, causing the
23325 delivery to be deferred.
23326
23327 .option umask pipe "octal integer" 022
23328 This specifies the umask setting for the subprocess that runs the command.
23329
23330
23331 .option use_bsmtp pipe boolean false
23332 .cindex "envelope sender"
23333 If this option is set true, the &(pipe)& transport writes messages in &"batch
23334 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23335 commands. If you want to include a leading HELO command with such messages,
23336 you can do so by setting the &%message_prefix%& option. See section
23337 &<<SECTbatchSMTP>>& for details of batch SMTP.
23338
23339 .option use_classresources pipe boolean false
23340 .cindex "class resources (BSD)"
23341 This option is available only when Exim is running on FreeBSD, NetBSD, or
23342 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23343 resource limits when a &(pipe)& transport is run to perform a delivery. The
23344 limits for the uid under which the pipe is to run are obtained from the login
23345 class database.
23346
23347
23348 .option use_crlf pipe boolean false
23349 .cindex "carriage return"
23350 .cindex "linefeed"
23351 This option causes lines to be terminated with the two-character CRLF sequence
23352 (carriage return, linefeed) instead of just a linefeed character. In the case
23353 of batched SMTP, the byte sequence written to the pipe is then an exact image
23354 of what would be sent down a real SMTP connection.
23355
23356 The contents of the &%message_prefix%& and &%message_suffix%& options are
23357 written verbatim, so must contain their own carriage return characters if these
23358 are needed. When &%use_bsmtp%& is not set, the default values for both
23359 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23360 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23361
23362
23363 .option use_shell pipe boolean false
23364 .vindex "&$pipe_addresses$&"
23365 If this option is set, it causes the command to be passed to &_/bin/sh_&
23366 instead of being run directly from the transport, as described in section
23367 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23368 where the command is expected to be run under a shell and cannot easily be
23369 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23370 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23371 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23372 its &%-c%& option.
23373
23374
23375
23376 .section "Using an external local delivery agent" "SECID143"
23377 .cindex "local delivery" "using an external agent"
23378 .cindex "&'procmail'&"
23379 .cindex "external local delivery"
23380 .cindex "delivery" "&'procmail'&"
23381 .cindex "delivery" "by external agent"
23382 The &(pipe)& transport can be used to pass all messages that require local
23383 delivery to a separate local delivery agent such as &%procmail%&. When doing
23384 this, care must be taken to ensure that the pipe is run under an appropriate
23385 uid and gid. In some configurations one wants this to be a uid that is trusted
23386 by the delivery agent to supply the correct sender of the message. It may be
23387 necessary to recompile or reconfigure the delivery agent so that it trusts an
23388 appropriate user. The following is an example transport and router
23389 configuration for &%procmail%&:
23390 .code
23391 # transport
23392 procmail_pipe:
23393   driver = pipe
23394   command = /usr/local/bin/procmail -d $local_part
23395   return_path_add
23396   delivery_date_add
23397   envelope_to_add
23398   check_string = "From "
23399   escape_string = ">From "
23400   umask = 077
23401   user = $local_part
23402   group = mail
23403
23404 # router
23405 procmail:
23406   driver = accept
23407   check_local_user
23408   transport = procmail_pipe
23409 .endd
23410 In this example, the pipe is run as the local user, but with the group set to
23411 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23412 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23413 user to supply a correct sender address. If you do not specify either a
23414 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23415 home directory is the user's home directory by default.
23416
23417 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23418 .code
23419 IFS=" "
23420 .endd
23421 as shown in some &%procmail%& documentation, because Exim does not by default
23422 use a shell to run pipe commands.
23423
23424 .cindex "Cyrus"
23425 The next example shows a transport and a router for a system where local
23426 deliveries are handled by the Cyrus IMAP server.
23427 .code
23428 # transport
23429 local_delivery_cyrus:
23430   driver = pipe
23431   command = /usr/cyrus/bin/deliver \
23432             -m ${substr_1:$local_part_suffix} -- $local_part
23433   user = cyrus
23434   group = mail
23435   return_output
23436   log_output
23437   message_prefix =
23438   message_suffix =
23439
23440 # router
23441 local_user_cyrus:
23442   driver = accept
23443   check_local_user
23444   local_part_suffix = .*
23445   transport = local_delivery_cyrus
23446 .endd
23447 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23448 &%return_output%& to cause any text written by Cyrus to be returned to the
23449 sender.
23450 .ecindex IIDpiptra1
23451 .ecindex IIDpiptra2
23452
23453
23454 . ////////////////////////////////////////////////////////////////////////////
23455 . ////////////////////////////////////////////////////////////////////////////
23456
23457 .chapter "The smtp transport" "CHAPsmtptrans"
23458 .scindex IIDsmttra1 "transports" "&(smtp)&"
23459 .scindex IIDsmttra2 "&(smtp)& transport"
23460 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23461 or LMTP protocol. The list of hosts to try can either be taken from the address
23462 that is being processed (having been set up by the router), or specified
23463 explicitly for the transport. Timeout and retry processing (see chapter
23464 &<<CHAPretry>>&) is applied to each IP address independently.
23465
23466
23467 .section "Multiple messages on a single connection" "SECID144"
23468 The sending of multiple messages over a single TCP/IP connection can arise in
23469 two ways:
23470
23471 .ilist
23472 If a message contains more than &%max_rcpt%& (see below) addresses that are
23473 routed to the same host, more than one copy of the message has to be sent to
23474 that host. In this situation, multiple copies may be sent in a single run of
23475 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23476 does when it has too many addresses to send in one message also depends on the
23477 value of the global &%remote_max_parallel%& option. Details are given in
23478 section &<<SECToutSMTPTCP>>&.)
23479 .next
23480 .cindex "hints database" "remembering routing"
23481 When a message has been successfully delivered over a TCP/IP connection, Exim
23482 looks in its hints database to see if there are any other messages awaiting a
23483 connection to the same host. If there are, a new delivery process is started
23484 for one of them, and the current TCP/IP connection is passed on to it. The new
23485 process may in turn send multiple copies and possibly create yet another
23486 process.
23487 .endlist
23488
23489
23490 For each copy sent over the same TCP/IP connection, a sequence counter is
23491 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23492 no further messages are sent over that connection.
23493
23494
23495
23496 .section "Use of the $host and $host_address variables" "SECID145"
23497 .vindex "&$host$&"
23498 .vindex "&$host_address$&"
23499 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23500 &$host_address$& are the name and IP address of the first host on the host list
23501 passed by the router. However, when the transport is about to connect to a
23502 specific host, and while it is connected to that host, &$host$& and
23503 &$host_address$& are set to the values for that host. These are the values
23504 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23505 &%serialize_hosts%&, and the various TLS options are expanded.
23506
23507
23508 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23509 .vindex &$tls_bits$&
23510 .vindex &$tls_cipher$&
23511 .vindex &$tls_peerdn$&
23512 .vindex &$tls_sni$&
23513 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23514 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23515 are the values that were set when the message was received.
23516 These are the values that are used for options that are expanded before any
23517 SMTP connections are made. Just before each connection is made, these four
23518 variables are emptied. If TLS is subsequently started, they are set to the
23519 appropriate values for the outgoing connection, and these are the values that
23520 are in force when any authenticators are run and when the
23521 &%authenticated_sender%& option is expanded.
23522
23523 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23524 and will be removed in a future release.
23525
23526
23527 .section "Private options for smtp" "SECID146"
23528 .cindex "options" "&(smtp)& transport"
23529 The private options of the &(smtp)& transport are as follows:
23530
23531
23532 .option address_retry_include_sender smtp boolean true
23533 .cindex "4&'xx'& responses" "retrying after"
23534 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23535 is the combination of sender and recipient that is delayed in subsequent queue
23536 runs until the retry time is reached. You can delay the recipient without
23537 reference to the sender (which is what earlier versions of Exim did), by
23538 setting &%address_retry_include_sender%& false. However, this can lead to
23539 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23540
23541 .option allow_localhost smtp boolean false
23542 .cindex "local host" "sending to"
23543 .cindex "fallback" "hosts specified on transport"
23544 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23545 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23546 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23547 the delivery anyway. This should be used only in special cases when the
23548 configuration ensures that no looping will result (for example, a differently
23549 configured Exim is listening on the port to which the message is sent).
23550
23551
23552 .option authenticated_sender smtp string&!! unset
23553 .cindex "Cyrus"
23554 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23555 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23556 overriding any existing authenticated sender value. If the string expansion is
23557 forced to fail, the option is ignored. Other expansion failures cause delivery
23558 to be deferred. If the result of expansion is an empty string, that is also
23559 ignored.
23560
23561 The expansion happens after the outgoing connection has been made and TLS
23562 started, if required. This means that the &$host$&, &$host_address$&,
23563 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23564 particular connection.
23565
23566 If the SMTP session is not authenticated, the expansion of
23567 &%authenticated_sender%& still happens (and can cause the delivery to be
23568 deferred if it fails), but no AUTH= item is added to MAIL commands
23569 unless &%authenticated_sender_force%& is true.
23570
23571 This option allows you to use the &(smtp)& transport in LMTP mode to
23572 deliver mail to Cyrus IMAP and provide the proper local part as the
23573 &"authenticated sender"&, via a setting such as:
23574 .code
23575 authenticated_sender = $local_part
23576 .endd
23577 This removes the need for IMAP subfolders to be assigned special ACLs to
23578 allow direct delivery to those subfolders.
23579
23580 Because of expected uses such as that just described for Cyrus (when no
23581 domain is involved), there is no checking on the syntax of the provided
23582 value.
23583
23584
23585 .option authenticated_sender_force smtp boolean false
23586 If this option is set true, the &%authenticated_sender%& option's value
23587 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23588 authenticated as a client.
23589
23590
23591 .option command_timeout smtp time 5m
23592 This sets a timeout for receiving a response to an SMTP command that has been
23593 sent out. It is also used when waiting for the initial banner line from the
23594 remote host. Its value must not be zero.
23595
23596
23597 .option connect_timeout smtp time 5m
23598 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23599 to a remote host. A setting of zero allows the system timeout (typically
23600 several minutes) to act. To have any effect, the value of this option must be
23601 less than the system timeout. However, it has been observed that on some
23602 systems there is no system timeout, which is why the default value for this
23603 option is 5 minutes, a value recommended by RFC 1123.
23604
23605
23606 .option connection_max_messages smtp integer 500
23607 .cindex "SMTP" "passed connection"
23608 .cindex "SMTP" "multiple deliveries"
23609 .cindex "multiple SMTP deliveries"
23610 This controls the maximum number of separate message deliveries that are sent
23611 over a single TCP/IP connection. If the value is zero, there is no limit.
23612 For testing purposes, this value can be overridden by the &%-oB%& command line
23613 option.
23614
23615
23616 .option data_timeout smtp time 5m
23617 This sets a timeout for the transmission of each block in the data portion of
23618 the message. As a result, the overall timeout for a message depends on the size
23619 of the message. Its value must not be zero. See also &%final_timeout%&.
23620
23621
23622 .option dkim_domain smtp string&!! unset
23623 .option dkim_selector smtp string&!! unset
23624 .option dkim_private_key smtp string&!! unset
23625 .option dkim_canon smtp string&!! unset
23626 .option dkim_strict smtp string&!! unset
23627 .option dkim_sign_headers smtp string&!! unset
23628 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23629
23630
23631 .option delay_after_cutoff smtp boolean true
23632 This option controls what happens when all remote IP addresses for a given
23633 domain have been inaccessible for so long that they have passed their retry
23634 cutoff times.
23635
23636 In the default state, if the next retry time has not been reached for any of
23637 them, the address is bounced without trying any deliveries. In other words,
23638 Exim delays retrying an IP address after the final cutoff time until a new
23639 retry time is reached, and can therefore bounce an address without ever trying
23640 a delivery, when machines have been down for a long time. Some people are
23641 unhappy at this prospect, so...
23642
23643 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23644 addresses are past their final cutoff time, Exim tries to deliver to those
23645 IP addresses that have not been tried since the message arrived. If there are
23646 none, of if they all fail, the address is bounced. In other words, it does not
23647 delay when a new message arrives, but immediately tries those expired IP
23648 addresses that haven't been tried since the message arrived. If there is a
23649 continuous stream of messages for the dead hosts, unsetting
23650 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23651 to them.
23652
23653
23654 .option dns_qualify_single smtp boolean true
23655 If the &%hosts%& or &%fallback_hosts%& option is being used,
23656 and the &%gethostbyname%& option is false,
23657 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23658 in chapter &<<CHAPdnslookup>>& for more details.
23659
23660
23661 .option dns_search_parents smtp boolean false
23662 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23663 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23664 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23665 details.
23666
23667
23668 .option dnssec_request_domains smtp "domain list&!!" unset
23669 .cindex "MX record" "security"
23670 .cindex "DNSSEC" "MX lookup"
23671 .cindex "security" "MX lookup"
23672 .cindex "DNS" "DNSSEC"
23673 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23674 the dnssec request bit set.
23675 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23676
23677
23678
23679 .option dnssec_require_domains smtp "domain list&!!" unset
23680 .cindex "MX record" "security"
23681 .cindex "DNSSEC" "MX lookup"
23682 .cindex "security" "MX lookup"
23683 .cindex "DNS" "DNSSEC"
23684 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23685 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23686 (AD bit) set will be ignored and logged as a host-lookup failure.
23687 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23688
23689
23690
23691 .option dscp smtp string&!! unset
23692 .cindex "DCSP" "outbound"
23693 This option causes the DSCP value associated with a socket to be set to one
23694 of a number of fixed strings or to numeric value.
23695 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23696 Common values include &`throughput`&, &`mincost`&, and on newer systems
23697 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23698
23699 The outbound packets from Exim will be marked with this value in the header
23700 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23701 that these values will have any effect, not be stripped by networking
23702 equipment, or do much of anything without cooperation with your Network
23703 Engineer and those of all network operators between the source and destination.
23704
23705
23706 .option fallback_hosts smtp "string list" unset
23707 .cindex "fallback" "hosts specified on transport"
23708 String expansion is not applied to this option. The argument must be a
23709 colon-separated list of host names or IP addresses, optionally also including
23710 port numbers, though the separator can be changed, as described in section
23711 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23712 item in a &%route_list%& setting for the &(manualroute)& router, as described
23713 in section &<<SECTformatonehostitem>>&.
23714
23715 Fallback hosts can also be specified on routers, which associate them with the
23716 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23717 &%fallback_hosts%& specified on the transport is used only if the address does
23718 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23719 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23720 However, &%hosts_randomize%& does apply to fallback host lists.
23721
23722 If Exim is unable to deliver to any of the hosts for a particular address, and
23723 the errors are not permanent rejections, the address is put on a separate
23724 transport queue with its host list replaced by the fallback hosts, unless the
23725 address was routed via MX records and the current host was in the original MX
23726 list. In that situation, the fallback host list is not used.
23727
23728 Once normal deliveries are complete, the fallback queue is delivered by
23729 re-running the same transports with the new host lists. If several failing
23730 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23731 copy of the message is sent.
23732
23733 The resolution of the host names on the fallback list is controlled by the
23734 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23735 both to cases when the host list comes with the address and when it is taken
23736 from &%hosts%&. This option provides a &"use a smart host only if delivery
23737 fails"& facility.
23738
23739
23740 .option final_timeout smtp time 10m
23741 This is the timeout that applies while waiting for the response to the final
23742 line containing just &"."& that terminates a message. Its value must not be
23743 zero.
23744
23745 .option gethostbyname smtp boolean false
23746 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23747 being used, names are looked up using &[gethostbyname()]&
23748 (or &[getipnodebyname()]& when available)
23749 instead of using the DNS. Of course, that function may in fact use the DNS, but
23750 it may also consult other sources of information such as &_/etc/hosts_&.
23751
23752 .option gnutls_compat_mode smtp boolean unset
23753 This option controls whether GnuTLS is used in compatibility mode in an Exim
23754 server. This reduces security slightly, but improves interworking with older
23755 implementations of TLS.
23756
23757 .option helo_data smtp string&!! "see below"
23758 .cindex "HELO" "argument, setting"
23759 .cindex "EHLO" "argument, setting"
23760 .cindex "LHLO argument setting"
23761 The value of this option is expanded after a connection to a another host has
23762 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23763 command that starts the outgoing SMTP or LMTP session. The default value of the
23764 option is:
23765 .code
23766 $primary_hostname
23767 .endd
23768 During the expansion, the variables &$host$& and &$host_address$& are set to
23769 the identity of the remote host, and the variables &$sending_ip_address$& and
23770 &$sending_port$& are set to the local IP address and port number that are being
23771 used. These variables can be used to generate different values for different
23772 servers or different local IP addresses. For example, if you want the string
23773 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23774 interface address, you could use this:
23775 .code
23776 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23777   {$primary_hostname}}
23778 .endd
23779 The use of &%helo_data%& applies both to sending messages and when doing
23780 callouts.
23781
23782 .option hosts smtp "string list&!!" unset
23783 Hosts are associated with an address by a router such as &(dnslookup)&, which
23784 finds the hosts by looking up the address domain in the DNS, or by
23785 &(manualroute)&, which has lists of hosts in its configuration. However,
23786 email addresses can be passed to the &(smtp)& transport by any router, and not
23787 all of them can provide an associated list of hosts.
23788
23789 The &%hosts%& option specifies a list of hosts to be used if the address being
23790 processed does not have any hosts associated with it. The hosts specified by
23791 &%hosts%& are also used, whether or not the address has its own hosts, if
23792 &%hosts_override%& is set.
23793
23794 The string is first expanded, before being interpreted as a colon-separated
23795 list of host names or IP addresses, possibly including port numbers. The
23796 separator may be changed to something other than colon, as described in section
23797 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23798 item in a &%route_list%& setting for the &(manualroute)& router, as described
23799 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23800 of the &(manualroute)& router is not available here.
23801
23802 If the expansion fails, delivery is deferred. Unless the failure was caused by
23803 the inability to complete a lookup, the error is logged to the panic log as
23804 well as the main log. Host names are looked up either by searching directly for
23805 address records in the DNS or by calling &[gethostbyname()]& (or
23806 &[getipnodebyname()]& when available), depending on the setting of the
23807 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23808 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23809 address are used.
23810
23811 During delivery, the hosts are tried in order, subject to their retry status,
23812 unless &%hosts_randomize%& is set.
23813
23814
23815 .option hosts_avoid_esmtp smtp "host list&!!" unset
23816 .cindex "ESMTP, avoiding use of"
23817 .cindex "HELO" "forcing use of"
23818 .cindex "EHLO" "avoiding use of"
23819 .cindex "PIPELINING" "avoiding the use of"
23820 This option is for use with broken hosts that announce ESMTP facilities (for
23821 example, PIPELINING) and then fail to implement them properly. When a host
23822 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23823 start of the SMTP session. This means that it cannot use any of the ESMTP
23824 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23825
23826
23827 .option hosts_avoid_pipelining smtp "host list&!!" unset
23828 .cindex "PIPELINING" "avoiding the use of"
23829 Exim will not use the SMTP PIPELINING extension when delivering to any host
23830 that matches this list, even if the server host advertises PIPELINING support.
23831
23832
23833 .option hosts_avoid_tls smtp "host list&!!" unset
23834 .cindex "TLS" "avoiding for certain hosts"
23835 Exim will not try to start a TLS session when delivering to any host that
23836 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23837
23838 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23839 .cindex "TLS" "avoiding for certain hosts"
23840 Exim will not try to start a TLS session for a verify callout,
23841 or when delivering in cutthrough mode,
23842 to any host that matches this list.
23843
23844
23845 .option hosts_max_try smtp integer 5
23846 .cindex "host" "maximum number to try"
23847 .cindex "limit" "number of hosts tried"
23848 .cindex "limit" "number of MX tried"
23849 .cindex "MX record" "maximum tried"
23850 This option limits the number of IP addresses that are tried for any one
23851 delivery in cases where there are temporary delivery errors. Section
23852 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23853
23854
23855 .option hosts_max_try_hardlimit smtp integer 50
23856 This is an additional check on the maximum number of IP addresses that Exim
23857 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23858 why it exists.
23859
23860
23861
23862 .option hosts_nopass_tls smtp "host list&!!" unset
23863 .cindex "TLS" "passing connection"
23864 .cindex "multiple SMTP deliveries"
23865 .cindex "TLS" "multiple message deliveries"
23866 For any host that matches this list, a connection on which a TLS session has
23867 been started will not be passed to a new delivery process for sending another
23868 message on the same connection. See section &<<SECTmulmessam>>& for an
23869 explanation of when this might be needed.
23870
23871
23872 .option hosts_override smtp boolean false
23873 If this option is set and the &%hosts%& option is also set, any hosts that are
23874 attached to the address are ignored, and instead the hosts specified by the
23875 &%hosts%& option are always used. This option does not apply to
23876 &%fallback_hosts%&.
23877
23878
23879 .option hosts_randomize smtp boolean false
23880 .cindex "randomized host list"
23881 .cindex "host" "list of; randomized"
23882 .cindex "fallback" "randomized hosts"
23883 If this option is set, and either the list of hosts is taken from the
23884 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23885 were not obtained from MX records (this includes fallback hosts from the
23886 router), and were not randomized by the router, the order of trying the hosts
23887 is randomized each time the transport runs. Randomizing the order of a host
23888 list can be used to do crude load sharing.
23889
23890 When &%hosts_randomize%& is true, a host list may be split into groups whose
23891 order is separately randomized. This makes it possible to set up MX-like
23892 behaviour. The boundaries between groups are indicated by an item that is just
23893 &`+`& in the host list. For example:
23894 .code
23895 hosts = host1:host2:host3:+:host4:host5
23896 .endd
23897 The order of the first three hosts and the order of the last two hosts is
23898 randomized for each use, but the first three always end up before the last two.
23899 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23900
23901 .option hosts_require_auth smtp "host list&!!" unset
23902 .cindex "authentication" "required by client"
23903 This option provides a list of servers for which authentication must succeed
23904 before Exim will try to transfer a message. If authentication fails for
23905 servers which are not in this list, Exim tries to send unauthenticated. If
23906 authentication fails for one of these servers, delivery is deferred. This
23907 temporary error is detectable in the retry rules, so it can be turned into a
23908 hard failure if required. See also &%hosts_try_auth%&, and chapter
23909 &<<CHAPSMTPAUTH>>& for details of authentication.
23910
23911
23912 .option hosts_request_ocsp smtp "host list&!!" *
23913 .cindex "TLS" "requiring for certain servers"
23914 Exim will request a Certificate Status on a
23915 TLS session for any host that matches this list.
23916 &%tls_verify_certificates%& should also be set for the transport.
23917
23918 .option hosts_require_ocsp smtp "host list&!!" unset
23919 .cindex "TLS" "requiring for certain servers"
23920 Exim will request, and check for a valid Certificate Status being given, on a
23921 TLS session for any host that matches this list.
23922 &%tls_verify_certificates%& should also be set for the transport.
23923
23924 .option hosts_require_tls smtp "host list&!!" unset
23925 .cindex "TLS" "requiring for certain servers"
23926 Exim will insist on using a TLS session when delivering to any host that
23927 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23928 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23929 incoming messages, use an appropriate ACL.
23930
23931 .option hosts_try_auth smtp "host list&!!" unset
23932 .cindex "authentication" "optional in client"
23933 This option provides a list of servers to which, provided they announce
23934 authentication support, Exim will attempt to authenticate as a client when it
23935 connects. If authentication fails, Exim will try to transfer the message
23936 unauthenticated. See also &%hosts_require_auth%&, and chapter
23937 &<<CHAPSMTPAUTH>>& for details of authentication.
23938
23939 .new
23940 .option hosts_try_chunking smtp "host list&!!" *
23941 .cindex CHUNKING "enabling, in client"
23942 .cindex BDAT "SMTP command"
23943 .cindex "RFC 3030" "CHUNKING"
23944 This option provides a list of server to which, provided they announce
23945 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
23946 BDAT will not be used in conjuction with a transport filter.
23947 .wen
23948
23949 .option hosts_try_prdr smtp "host list&!!" *
23950 .cindex "PRDR" "enabling, optional in client"
23951 This option provides a list of servers to which, provided they announce
23952 PRDR support, Exim will attempt to negotiate PRDR
23953 for multi-recipient messages.
23954 The option can usually be left as default.
23955
23956 .option interface smtp "string list&!!" unset
23957 .cindex "bind IP address"
23958 .cindex "IP address" "binding"
23959 .vindex "&$host$&"
23960 .vindex "&$host_address$&"
23961 This option specifies which interface to bind to when making an outgoing SMTP
23962 call. The value is an IP address, not an interface name such as
23963 &`eth0`&. Do not confuse this with the interface address that was used when a
23964 message was received, which is in &$received_ip_address$&, formerly known as
23965 &$interface_address$&. The name was changed to minimize confusion with the
23966 outgoing interface address. There is no variable that contains an outgoing
23967 interface address because, unless it is set by this option, its value is
23968 unknown.
23969
23970 During the expansion of the &%interface%& option the variables &$host$& and
23971 &$host_address$& refer to the host to which a connection is about to be made
23972 during the expansion of the string. Forced expansion failure, or an empty
23973 string result causes the option to be ignored. Otherwise, after expansion, the
23974 string must be a list of IP addresses, colon-separated by default, but the
23975 separator can be changed in the usual way. For example:
23976 .code
23977 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23978 .endd
23979 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23980 connection. If none of them are the correct type, the option is ignored. If
23981 &%interface%& is not set, or is ignored, the system's IP functions choose which
23982 interface to use if the host has more than one.
23983
23984
23985 .option keepalive smtp boolean true
23986 .cindex "keepalive" "on outgoing connection"
23987 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23988 connections. When set, it causes the kernel to probe idle connections
23989 periodically, by sending packets with &"old"& sequence numbers. The other end
23990 of the connection should send a acknowledgment if the connection is still okay
23991 or a reset if the connection has been aborted. The reason for doing this is
23992 that it has the beneficial effect of freeing up certain types of connection
23993 that can get stuck when the remote host is disconnected without tidying up the
23994 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23995 unreachable hosts.
23996
23997
23998 .option lmtp_ignore_quota smtp boolean false
23999 .cindex "LMTP" "ignoring quota errors"
24000 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24001 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24002 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24003
24004 .option max_rcpt smtp integer 100
24005 .cindex "RCPT" "maximum number of outgoing"
24006 This option limits the number of RCPT commands that are sent in a single
24007 SMTP message transaction. Each set of addresses is treated independently, and
24008 so can cause parallel connections to the same host if &%remote_max_parallel%&
24009 permits this.
24010
24011
24012 .option multi_domain smtp boolean&!! true
24013 .vindex "&$domain$&"
24014 When this option is set, the &(smtp)& transport can handle a number of
24015 addresses containing a mixture of different domains provided they all resolve
24016 to the same list of hosts. Turning the option off restricts the transport to
24017 handling only one domain at a time. This is useful if you want to use
24018 &$domain$& in an expansion for the transport, because it is set only when there
24019 is a single domain involved in a remote delivery.
24020
24021 It is expanded per-address and can depend on any of
24022 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24023 &$host$&, &$host_address$& and &$host_port$&.
24024
24025 .option port smtp string&!! "see below"
24026 .cindex "port" "sending TCP/IP"
24027 .cindex "TCP/IP" "setting outgoing port"
24028 This option specifies the TCP/IP port on the server to which Exim connects.
24029 &*Note:*& Do not confuse this with the port that was used when a message was
24030 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24031 The name was changed to minimize confusion with the outgoing port. There is no
24032 variable that contains an outgoing port.
24033
24034 If the value of this option begins with a digit it is taken as a port number;
24035 otherwise it is looked up using &[getservbyname()]&. The default value is
24036 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24037 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24038 is deferred.
24039
24040
24041
24042 .option protocol smtp string smtp
24043 .cindex "LMTP" "over TCP/IP"
24044 .cindex "ssmtp protocol" "outbound"
24045 .cindex "TLS" "SSL-on-connect outbound"
24046 .vindex "&$port$&"
24047 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24048 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24049 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24050 deliveries into closed message stores. Exim also has support for running LMTP
24051 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24052
24053 If this option is set to &"smtps"&, the default value for the &%port%& option
24054 changes to &"smtps"&, and the transport initiates TLS immediately after
24055 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24056 The Internet standards bodies strongly discourage use of this mode.
24057
24058
24059 .option retry_include_ip_address smtp boolean&!! true
24060 Exim normally includes both the host name and the IP address in the key it
24061 constructs for indexing retry data after a temporary delivery failure. This
24062 means that when one of several IP addresses for a host is failing, it gets
24063 tried periodically (controlled by the retry rules), but use of the other IP
24064 addresses is not affected.
24065
24066 However, in some dialup environments hosts are assigned a different IP address
24067 each time they connect. In this situation the use of the IP address as part of
24068 the retry key leads to undesirable behaviour. Setting this option false causes
24069 Exim to use only the host name.
24070 Since it is expanded it can be made to depend on the host or domain.
24071
24072
24073 .option serialize_hosts smtp "host list&!!" unset
24074 .cindex "serializing connections"
24075 .cindex "host" "serializing connections"
24076 Because Exim operates in a distributed manner, if several messages for the same
24077 host arrive at around the same time, more than one simultaneous connection to
24078 the remote host can occur. This is not usually a problem except when there is a
24079 slow link between the hosts. In that situation it may be helpful to restrict
24080 Exim to one connection at a time. This can be done by setting
24081 &%serialize_hosts%& to match the relevant hosts.
24082
24083 .cindex "hints database" "serializing deliveries to a host"
24084 Exim implements serialization by means of a hints database in which a record is
24085 written whenever a process connects to one of the restricted hosts. The record
24086 is deleted when the connection is completed. Obviously there is scope for
24087 records to get left lying around if there is a system or program crash. To
24088 guard against this, Exim ignores any records that are more than six hours old.
24089
24090 If you set up this kind of serialization, you should also arrange to delete the
24091 relevant hints database whenever your system reboots. The names of the files
24092 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24093 may be one or two files, depending on the type of DBM in use. The same files
24094 are used for ETRN serialization.
24095
24096 See also the &%max_parallel%& generic transport option.
24097
24098
24099 .option size_addition smtp integer 1024
24100 .cindex "SMTP" "SIZE"
24101 .cindex "message" "size issue for transport filter"
24102 .cindex "size" "of message"
24103 .cindex "transport" "filter"
24104 .cindex "filter" "transport filter"
24105 If a remote SMTP server indicates that it supports the SIZE option of the
24106 MAIL command, Exim uses this to pass over the message size at the start of
24107 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24108 sends, to allow for headers and other text that may be added during delivery by
24109 configuration options or in a transport filter. It may be necessary to increase
24110 this if a lot of text is added to messages.
24111
24112 Alternatively, if the value of &%size_addition%& is set negative, it disables
24113 the use of the SIZE option altogether.
24114
24115
24116 .option socks_proxy smtp string&!! unset
24117 .cindex proxy SOCKS
24118 This option enables use of SOCKS proxies for connections made by the
24119 transport.  For details see &<<SECTproxySOCKS>>&.
24120
24121
24122 .option tls_certificate smtp string&!! unset
24123 .cindex "TLS" "client certificate, location of"
24124 .cindex "certificate" "client, location of"
24125 .vindex "&$host$&"
24126 .vindex "&$host_address$&"
24127 The value of this option must be the absolute path to a file which contains the
24128 client's certificate, for possible use when sending a message over an encrypted
24129 connection. The values of &$host$& and &$host_address$& are set to the name and
24130 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24131 details of TLS.
24132
24133 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24134 certificate when sending messages as a client. The global option of the same
24135 name specifies the certificate for Exim as a server; it is not automatically
24136 assumed that the same certificate should be used when Exim is operating as a
24137 client.
24138
24139
24140 .option tls_crl smtp string&!! unset
24141 .cindex "TLS" "client certificate revocation list"
24142 .cindex "certificate" "revocation list for client"
24143 This option specifies a certificate revocation list. The expanded value must
24144 be the name of a file that contains a CRL in PEM format.
24145
24146
24147 .option tls_dh_min_bits smtp integer 1024
24148 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24149 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24150 key agreement is negotiated, the server will provide a large prime number
24151 for use.  This option establishes the minimum acceptable size of that number.
24152 If the parameter offered by the server is too small, then the TLS handshake
24153 will fail.
24154
24155 Only supported when using GnuTLS.
24156
24157
24158 .option tls_privatekey smtp string&!! unset
24159 .cindex "TLS" "client private key, location of"
24160 .vindex "&$host$&"
24161 .vindex "&$host_address$&"
24162 The value of this option must be the absolute path to a file which contains the
24163 client's private key. This is used when sending a message over an encrypted
24164 connection using a client certificate. The values of &$host$& and
24165 &$host_address$& are set to the name and address of the server during the
24166 expansion. If this option is unset, or the expansion is forced to fail, or the
24167 result is an empty string, the private key is assumed to be in the same file as
24168 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24169
24170
24171 .option tls_require_ciphers smtp string&!! unset
24172 .cindex "TLS" "requiring specific ciphers"
24173 .cindex "cipher" "requiring specific"
24174 .vindex "&$host$&"
24175 .vindex "&$host_address$&"
24176 The value of this option must be a list of permitted cipher suites, for use
24177 when setting up an outgoing encrypted connection. (There is a global option of
24178 the same name for controlling incoming connections.) The values of &$host$& and
24179 &$host_address$& are set to the name and address of the server during the
24180 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24181 is used in different ways by OpenSSL and GnuTLS (see sections
24182 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24183 ciphers is a preference order.
24184
24185
24186
24187 .option tls_sni smtp string&!! unset
24188 .cindex "TLS" "Server Name Indication"
24189 .vindex "&$tls_sni$&"
24190 If this option is set then it sets the $tls_out_sni variable and causes any
24191 TLS session to pass this value as the Server Name Indication extension to
24192 the remote side, which can be used by the remote side to select an appropriate
24193 certificate and private key for the session.
24194
24195 See &<<SECTtlssni>>& for more information.
24196
24197 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24198 TLS extensions.
24199
24200
24201
24202
24203 .option tls_tempfail_tryclear smtp boolean true
24204 .cindex "4&'xx'& responses" "to STARTTLS"
24205 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24206 setting up a TLS session, this option determines whether or not Exim should try
24207 to deliver the message unencrypted. If it is set false, delivery to the
24208 current host is deferred; if there are other hosts, they are tried. If this
24209 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24210 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24211 TLS negotiation fails, Exim closes the current connection (because it is in an
24212 unknown state), opens a new one to the same host, and then tries the delivery
24213 in clear.
24214
24215
24216 .option tls_try_verify_hosts smtp "host list&!!" *
24217 .cindex "TLS" "server certificate verification"
24218 .cindex "certificate" "verification of server"
24219 This option gives a list of hosts for which, on encrypted connections,
24220 certificate verification will be tried but need not succeed.
24221 The &%tls_verify_certificates%& option must also be set.
24222 Note that unless the host is in this list
24223 TLS connections will be denied to hosts using self-signed certificates
24224 when &%tls_verify_certificates%& is matched.
24225 The &$tls_out_certificate_verified$& variable is set when
24226 certificate verification succeeds.
24227
24228
24229 .option tls_verify_cert_hostnames smtp "host list&!!" *
24230 .cindex "TLS" "server certificate hostname verification"
24231 .cindex "certificate" "verification of server"
24232 This option give a list of hosts for which,
24233 while verifying the server certificate,
24234 checks will be included on the host name
24235 (note that this will generally be the result of a DNS MX lookup)
24236 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24237 limited to being the initial component of a 3-or-more component FQDN.
24238
24239 There is no equivalent checking on client certificates.
24240
24241
24242 .option tls_verify_certificates smtp string&!! system
24243 .cindex "TLS" "server certificate verification"
24244 .cindex "certificate" "verification of server"
24245 .vindex "&$host$&"
24246 .vindex "&$host_address$&"
24247 The value of this option must be either the
24248 word "system"
24249 or the absolute path to
24250 a file or directory containing permitted certificates for servers,
24251 for use when setting up an encrypted connection.
24252
24253 The "system" value for the option will use a location compiled into the SSL library.
24254 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24255 is taken as empty and an explicit location
24256 must be specified.
24257
24258 The use of a directory for the option value is not available for GnuTLS versions
24259 preceding 3.3.6 and a single file must be used.
24260
24261 With OpenSSL the certificates specified
24262 explicitly
24263 either by file or directory
24264 are added to those given by the system default location.
24265
24266 The values of &$host$& and
24267 &$host_address$& are set to the name and address of the server during the
24268 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24269
24270 For back-compatibility,
24271 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24272 (a single-colon empty list counts as being set)
24273 and certificate verification fails the TLS connection is closed.
24274
24275
24276 .option tls_verify_hosts smtp "host list&!!" unset
24277 .cindex "TLS" "server certificate verification"
24278 .cindex "certificate" "verification of server"
24279 This option gives a list of hosts for which, on encrypted connections,
24280 certificate verification must succeed.
24281 The &%tls_verify_certificates%& option must also be set.
24282 If both this option and &%tls_try_verify_hosts%& are unset
24283 operation is as if this option selected all hosts.
24284
24285
24286
24287
24288 .section "How the limits for the number of hosts to try are used" &&&
24289          "SECTvalhosmax"
24290 .cindex "host" "maximum number to try"
24291 .cindex "limit" "hosts; maximum number tried"
24292 There are two options that are concerned with the number of hosts that are
24293 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24294 &%hosts_max_try_hardlimit%&.
24295
24296
24297 The &%hosts_max_try%& option limits the number of hosts that are tried
24298 for a single delivery. However, despite the term &"host"& in its name, the
24299 option actually applies to each IP address independently. In other words, a
24300 multihomed host is treated as several independent hosts, just as it is for
24301 retrying.
24302
24303 Many of the larger ISPs have multiple MX records which often point to
24304 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24305 created as a result of routing one of these domains.
24306
24307 Trying every single IP address on such a long list does not seem sensible; if
24308 several at the top of the list fail, it is reasonable to assume there is some
24309 problem that is likely to affect all of them. Roughly speaking, the value of
24310 &%hosts_max_try%& is the maximum number that are tried before deferring the
24311 delivery. However, the logic cannot be quite that simple.
24312
24313 Firstly, IP addresses that are skipped because their retry times have not
24314 arrived do not count, and in addition, addresses that are past their retry
24315 limits are also not counted, even when they are tried. This means that when
24316 some IP addresses are past their retry limits, more than the value of
24317 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24318 that all IP addresses are considered before timing out an email address (but
24319 see below for an exception).
24320
24321 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24322 list to see if there is a subsequent host with a different (higher valued) MX.
24323 If there is, that host is considered next, and the current IP address is used
24324 but not counted. This behaviour helps in the case of a domain with a retry rule
24325 that hardly ever delays any hosts, as is now explained:
24326
24327 Consider the case of a long list of hosts with one MX value, and a few with a
24328 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24329 hosts at the top of the list are tried at first. With the default retry rule,
24330 which specifies increasing retry times, the higher MX hosts are eventually
24331 tried when those at the top of the list are skipped because they have not
24332 reached their retry times.
24333
24334 However, it is common practice to put a fixed short retry time on domains for
24335 large ISPs, on the grounds that their servers are rarely down for very long.
24336 Unfortunately, these are exactly the domains that tend to resolve to long lists
24337 of hosts. The short retry time means that the lowest MX hosts are tried every
24338 time. The attempts may be in a different order because of random sorting, but
24339 without the special MX check, the higher MX hosts would never be tried until
24340 all the lower MX hosts had timed out (which might be several days), because
24341 there are always some lower MX hosts that have reached their retry times. With
24342 the special check, Exim considers at least one IP address from each MX value at
24343 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24344 reached.
24345
24346 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24347 particular, Exim normally eventually tries all the IP addresses before timing
24348 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24349 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24350 been set up with hundreds of IP addresses for some domains. It can
24351 take a very long time indeed for an address to time out in these cases.
24352
24353 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24354 Exim never tries more than this number of IP addresses; if it hits this limit
24355 and they are all timed out, the email address is bounced, even though not all
24356 possible IP addresses have been tried.
24357 .ecindex IIDsmttra1
24358 .ecindex IIDsmttra2
24359
24360
24361
24362
24363
24364 . ////////////////////////////////////////////////////////////////////////////
24365 . ////////////////////////////////////////////////////////////////////////////
24366
24367 .chapter "Address rewriting" "CHAPrewrite"
24368 .scindex IIDaddrew "rewriting" "addresses"
24369 There are some circumstances in which Exim automatically rewrites domains in
24370 addresses. The two most common are when an address is given without a domain
24371 (referred to as an &"unqualified address"&) or when an address contains an
24372 abbreviated domain that is expanded by DNS lookup.
24373
24374 Unqualified envelope addresses are accepted only for locally submitted
24375 messages, or for messages that are received from hosts matching
24376 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24377 appropriate. Unqualified addresses in header lines are qualified if they are in
24378 locally submitted messages, or messages from hosts that are permitted to send
24379 unqualified envelope addresses. Otherwise, unqualified addresses in header
24380 lines are neither qualified nor rewritten.
24381
24382 One situation in which Exim does &'not'& automatically rewrite a domain is
24383 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24384 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24385 do this. The new RFCs do not contain this suggestion.
24386
24387
24388 .section "Explicitly configured address rewriting" "SECID147"
24389 This chapter describes the rewriting rules that can be used in the
24390 main rewrite section of the configuration file, and also in the generic
24391 &%headers_rewrite%& option that can be set on any transport.
24392
24393 Some people believe that configured address rewriting is a Mortal Sin.
24394 Others believe that life is not possible without it. Exim provides the
24395 facility; you do not have to use it.
24396
24397 The main rewriting rules that appear in the &"rewrite"& section of the
24398 configuration file are applied to addresses in incoming messages, both envelope
24399 addresses and addresses in header lines. Each rule specifies the types of
24400 address to which it applies.
24401
24402 Whether or not addresses in header lines are rewritten depends on the origin of
24403 the headers and the type of rewriting. Global rewriting, that is, rewriting
24404 rules from the rewrite section of the configuration file, is applied only to
24405 those headers that were received with the message. Header lines that are added
24406 by ACLs or by a system filter or by individual routers or transports (which
24407 are specific to individual recipient addresses) are not rewritten by the global
24408 rules.
24409
24410 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24411 applies all headers except those added by routers and transports. That is, as
24412 well as the headers that were received with the message, it also applies to
24413 headers that were added by an ACL or a system filter.
24414
24415
24416 In general, rewriting addresses from your own system or domain has some
24417 legitimacy. Rewriting other addresses should be done only with great care and
24418 in special circumstances. The author of Exim believes that rewriting should be
24419 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24420 Although it can sometimes be used as a routing tool, this is very strongly
24421 discouraged.
24422
24423 There are two commonly encountered circumstances where rewriting is used, as
24424 illustrated by these examples:
24425
24426 .ilist
24427 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24428 exchange mail with each other behind a firewall, but there is only a single
24429 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24430 &'hitch.fict.example'& when sending mail off-site.
24431 .next
24432 A host rewrites the local parts of its own users so that, for example,
24433 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24434 .endlist
24435
24436
24437
24438 .section "When does rewriting happen?" "SECID148"
24439 .cindex "rewriting" "timing of"
24440 .cindex "&ACL;" "rewriting addresses in"
24441 Configured address rewriting can take place at several different stages of a
24442 message's processing.
24443
24444 .vindex "&$sender_address$&"
24445 At the start of an ACL for MAIL, the sender address may have been rewritten
24446 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24447 ordinary rewrite rules have yet been applied. If, however, the sender address
24448 is verified in the ACL, it is rewritten before verification, and remains
24449 rewritten thereafter. The subsequent value of &$sender_address$& is the
24450 rewritten address. This also applies if sender verification happens in a
24451 RCPT ACL. Otherwise, when the sender address is not verified, it is
24452 rewritten as soon as a message's header lines have been received.
24453
24454 .vindex "&$domain$&"
24455 .vindex "&$local_part$&"
24456 Similarly, at the start of an ACL for RCPT, the current recipient's address
24457 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24458 rewrite rules have yet been applied to it. However, the behaviour is different
24459 from the sender address when a recipient is verified. The address is rewritten
24460 for the verification, but the rewriting is not remembered at this stage. The
24461 value of &$local_part$& and &$domain$& after verification are always the same
24462 as they were before (that is, they contain the unrewritten &-- except for
24463 SMTP-time rewriting &-- address).
24464
24465 As soon as a message's header lines have been received, all the envelope
24466 recipient addresses are permanently rewritten, and rewriting is also applied to
24467 the addresses in the header lines (if configured). This happens before adding
24468 any header lines that were specified in MAIL or RCPT ACLs, and
24469 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24470 before the DATA ACL and &[local_scan()]& functions are run.
24471
24472 When an address is being routed, either for delivery or for verification,
24473 rewriting is applied immediately to child addresses that are generated by
24474 redirection, unless &%no_rewrite%& is set on the router.
24475
24476 .cindex "envelope sender" "rewriting at transport time"
24477 .cindex "rewriting" "at transport time"
24478 .cindex "header lines" "rewriting at transport time"
24479 At transport time, additional rewriting of addresses in header lines can be
24480 specified by setting the generic &%headers_rewrite%& option on a transport.
24481 This option contains rules that are identical in form to those in the rewrite
24482 section of the configuration file. They are applied to the original message
24483 header lines and any that were added by ACLs or a system filter. They are not
24484 applied to header lines that are added by routers or the transport.
24485
24486 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24487 transport option. However, it is not possible to rewrite envelope recipients at
24488 transport time.
24489
24490
24491
24492
24493 .section "Testing the rewriting rules that apply on input" "SECID149"
24494 .cindex "rewriting" "testing"
24495 .cindex "testing" "rewriting"
24496 Exim's input rewriting configuration appears in a part of the run time
24497 configuration file headed by &"begin rewrite"&. It can be tested by the
24498 &%-brw%& command line option. This takes an address (which can be a full RFC
24499 2822 address) as its argument. The output is a list of how the address would be
24500 transformed by the rewriting rules for each of the different places it might
24501 appear in an incoming message, that is, for each different header and for the
24502 envelope sender and recipient fields. For example,
24503 .code
24504 exim -brw ph10@exim.workshop.example
24505 .endd
24506 might produce the output
24507 .code
24508 sender: Philip.Hazel@exim.workshop.example
24509 from: Philip.Hazel@exim.workshop.example
24510 to: ph10@exim.workshop.example
24511 cc: ph10@exim.workshop.example
24512 bcc: ph10@exim.workshop.example
24513 reply-to: Philip.Hazel@exim.workshop.example
24514 env-from: Philip.Hazel@exim.workshop.example
24515 env-to: ph10@exim.workshop.example
24516 .endd
24517 which shows that rewriting has been set up for that address when used in any of
24518 the source fields, but not when it appears as a recipient address. At the
24519 present time, there is no equivalent way of testing rewriting rules that are
24520 set for a particular transport.
24521
24522
24523 .section "Rewriting rules" "SECID150"
24524 .cindex "rewriting" "rules"
24525 The rewrite section of the configuration file consists of lines of rewriting
24526 rules in the form
24527 .display
24528 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24529 .endd
24530 Rewriting rules that are specified for the &%headers_rewrite%& generic
24531 transport option are given as a colon-separated list. Each item in the list
24532 takes the same form as a line in the main rewriting configuration (except that
24533 any colons must be doubled, of course).
24534
24535 The formats of source patterns and replacement strings are described below.
24536 Each is terminated by white space, unless enclosed in double quotes, in which
24537 case normal quoting conventions apply inside the quotes. The flags are single
24538 characters which may appear in any order. Spaces and tabs between them are
24539 ignored.
24540
24541 For each address that could potentially be rewritten, the rules are scanned in
24542 order, and replacements for the address from earlier rules can themselves be
24543 replaced by later rules (but see the &"q"& and &"R"& flags).
24544
24545 The order in which addresses are rewritten is undefined, may change between
24546 releases, and must not be relied on, with one exception: when a message is
24547 received, the envelope sender is always rewritten first, before any header
24548 lines are rewritten. For example, the replacement string for a rewrite of an
24549 address in &'To:'& must not assume that the message's address in &'From:'& has
24550 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24551 that the envelope sender has already been rewritten.
24552
24553 .vindex "&$domain$&"
24554 .vindex "&$local_part$&"
24555 The variables &$local_part$& and &$domain$& can be used in the replacement
24556 string to refer to the address that is being rewritten. Note that lookup-driven
24557 rewriting can be done by a rule of the form
24558 .code
24559 *@*   ${lookup ...
24560 .endd
24561 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24562 refer to the address that is being rewritten.
24563
24564
24565 .section "Rewriting patterns" "SECID151"
24566 .cindex "rewriting" "patterns"
24567 .cindex "address list" "in a rewriting pattern"
24568 The source pattern in a rewriting rule is any item which may appear in an
24569 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24570 single-item address list, which means that it is expanded before being tested
24571 against the address. As always, if you use a regular expression as a pattern,
24572 you must take care to escape dollar and backslash characters, or use the &`\N`&
24573 facility to suppress string expansion within the regular expression.
24574
24575 Domains in patterns should be given in lower case. Local parts in patterns are
24576 case-sensitive. If you want to do case-insensitive matching of local parts, you
24577 can use a regular expression that starts with &`^(?i)`&.
24578
24579 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24580 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24581 depending on the type of match which occurred. These can be used in the
24582 replacement string to insert portions of the incoming address. &$0$& always
24583 refers to the complete incoming address. When a regular expression is used, the
24584 numerical variables are set from its capturing subexpressions. For other types
24585 of pattern they are set as follows:
24586
24587 .ilist
24588 If a local part or domain starts with an asterisk, the numerical variables
24589 refer to the character strings matched by asterisks, with &$1$& associated with
24590 the first asterisk, and &$2$& with the second, if present. For example, if the
24591 pattern
24592 .code
24593 *queen@*.fict.example
24594 .endd
24595 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24596 .code
24597 $0 = hearts-queen@wonderland.fict.example
24598 $1 = hearts-
24599 $2 = wonderland
24600 .endd
24601 Note that if the local part does not start with an asterisk, but the domain
24602 does, it is &$1$& that contains the wild part of the domain.
24603
24604 .next
24605 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24606 of the domain are placed in the next available numerical variables. Suppose,
24607 for example, that the address &'foo@bar.baz.example'& is processed by a
24608 rewriting rule of the form
24609 .display
24610 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24611 .endd
24612 and the key in the file that matches the domain is &`*.baz.example`&. Then
24613 .code
24614 $1 = foo
24615 $2 = bar
24616 $3 = baz.example
24617 .endd
24618 If the address &'foo@baz.example'& is looked up, this matches the same
24619 wildcard file entry, and in this case &$2$& is set to the empty string, but
24620 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24621 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24622 whole domain. For non-partial domain lookups, no numerical variables are set.
24623 .endlist
24624
24625
24626 .section "Rewriting replacements" "SECID152"
24627 .cindex "rewriting" "replacements"
24628 If the replacement string for a rule is a single asterisk, addresses that
24629 match the pattern and the flags are &'not'& rewritten, and no subsequent
24630 rewriting rules are scanned. For example,
24631 .code
24632 hatta@lookingglass.fict.example  *  f
24633 .endd
24634 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24635 &'From:'& headers.
24636
24637 .vindex "&$domain$&"
24638 .vindex "&$local_part$&"
24639 If the replacement string is not a single asterisk, it is expanded, and must
24640 yield a fully qualified address. Within the expansion, the variables
24641 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24642 Any letters they contain retain their original case &-- they are not lower
24643 cased. The numerical variables are set up according to the type of pattern that
24644 matched the address, as described above. If the expansion is forced to fail by
24645 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24646 current rule is abandoned, but subsequent rules may take effect. Any other
24647 expansion failure causes the entire rewriting operation to be abandoned, and an
24648 entry written to the panic log.
24649
24650
24651
24652 .section "Rewriting flags" "SECID153"
24653 There are three different kinds of flag that may appear on rewriting rules:
24654
24655 .ilist
24656 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24657 c, f, h, r, s, t.
24658 .next
24659 A flag that specifies rewriting at SMTP time: S.
24660 .next
24661 Flags that control the rewriting process: Q, q, R, w.
24662 .endlist
24663
24664 For rules that are part of the &%headers_rewrite%& generic transport option,
24665 E, F, T, and S are not permitted.
24666
24667
24668
24669 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24670          "SECID154"
24671 .cindex "rewriting" "flags"
24672 If none of the following flag letters, nor the &"S"& flag (see section
24673 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24674 and to both the sender and recipient fields of the envelope, whereas a
24675 transport-time rewriting rule just applies to all headers. Otherwise, the
24676 rewriting rule is skipped unless the relevant addresses are being processed.
24677 .display
24678 &`E`&       rewrite all envelope fields
24679 &`F`&       rewrite the envelope From field
24680 &`T`&       rewrite the envelope To field
24681 &`b`&       rewrite the &'Bcc:'& header
24682 &`c`&       rewrite the &'Cc:'& header
24683 &`f`&       rewrite the &'From:'& header
24684 &`h`&       rewrite all headers
24685 &`r`&       rewrite the &'Reply-To:'& header
24686 &`s`&       rewrite the &'Sender:'& header
24687 &`t`&       rewrite the &'To:'& header
24688 .endd
24689 "All headers" means all of the headers listed above that can be selected
24690 individually, plus their &'Resent-'& versions. It does not include
24691 other headers such as &'Subject:'& etc.
24692
24693 You should be particularly careful about rewriting &'Sender:'& headers, and
24694 restrict this to special known cases in your own domains.
24695
24696
24697 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24698 .cindex "SMTP" "rewriting malformed addresses"
24699 .cindex "RCPT" "rewriting argument of"
24700 .cindex "MAIL" "rewriting argument of"
24701 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24702 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24703 before any other processing; even before syntax checking. The pattern is
24704 required to be a regular expression, and it is matched against the whole of the
24705 data for the command, including any surrounding angle brackets.
24706
24707 .vindex "&$domain$&"
24708 .vindex "&$local_part$&"
24709 This form of rewrite rule allows for the handling of addresses that are not
24710 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24711 input). Because the input is not required to be a syntactically valid address,
24712 the variables &$local_part$& and &$domain$& are not available during the
24713 expansion of the replacement string. The result of rewriting replaces the
24714 original address in the MAIL or RCPT command.
24715
24716
24717 .section "Flags controlling the rewriting process" "SECID155"
24718 There are four flags which control the way the rewriting process works. These
24719 take effect only when a rule is invoked, that is, when the address is of the
24720 correct type (matches the flags) and matches the pattern:
24721
24722 .ilist
24723 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24724 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24725 absence of &"Q"& the rewritten address must always include a domain.
24726 .next
24727 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24728 even if no rewriting actually takes place because of a &"fail"& in the
24729 expansion. The &"q"& flag is not effective if the address is of the wrong type
24730 (does not match the flags) or does not match the pattern.
24731 .next
24732 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24733 address, up to ten times. It can be combined with the &"q"& flag, to stop
24734 rewriting once it fails to match (after at least one successful rewrite).
24735 .next
24736 .cindex "rewriting" "whole addresses"
24737 When an address in a header is rewritten, the rewriting normally applies only
24738 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24739 left unchanged. For example, rewriting might change
24740 .code
24741 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24742 .endd
24743 into
24744 .code
24745 From: Ford Prefect <prefectf@hitch.fict.example>
24746 .endd
24747 .cindex "RFC 2047"
24748 Sometimes there is a need to replace the whole address item, and this can be
24749 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24750 causes an address in a header line to be rewritten, the entire address is
24751 replaced, not just the working part. The replacement must be a complete RFC
24752 2822 address, including the angle brackets if necessary. If text outside angle
24753 brackets contains a character whose value is greater than 126 or less than 32
24754 (except for tab), the text is encoded according to RFC 2047. The character set
24755 is taken from &%headers_charset%&, which gets its default at build time.
24756
24757 When the &"w"& flag is set on a rule that causes an envelope address to be
24758 rewritten, all but the working part of the replacement address is discarded.
24759 .endlist
24760
24761
24762 .section "Rewriting examples" "SECID156"
24763 Here is an example of the two common rewriting paradigms:
24764 .code
24765 *@*.hitch.fict.example  $1@hitch.fict.example
24766 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24767                      {$value}fail}@hitch.fict.example bctfrF
24768 .endd
24769 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24770 the string expansion to fail if the lookup does not succeed. In this context it
24771 has the effect of leaving the original address unchanged, but Exim goes on to
24772 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24773 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24774 explicitly, which would cause the rewritten address to be the same as before,
24775 at the cost of a small bit of processing. Not supplying either of these is an
24776 error, since the rewritten address would then contain no local part.
24777
24778 The first example above replaces the domain with a superior, more general
24779 domain. This may not be desirable for certain local parts. If the rule
24780 .code
24781 root@*.hitch.fict.example  *
24782 .endd
24783 were inserted before the first rule, rewriting would be suppressed for the
24784 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24785
24786 Rewriting can be made conditional on a number of tests, by making use of
24787 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24788 messages that originate outside the local host:
24789 .code
24790 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24791                          {$1@hitch.fict.example}fail}"
24792 .endd
24793 The replacement string is quoted in this example because it contains white
24794 space.
24795
24796 .cindex "rewriting" "bang paths"
24797 .cindex "bang paths" "rewriting"
24798 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24799 an address it treats it as an unqualified local part which it qualifies with
24800 the local qualification domain (if the source of the message is local or if the
24801 remote host is permitted to send unqualified addresses). Rewriting can
24802 sometimes be used to handle simple bang paths with a fixed number of
24803 components. For example, the rule
24804 .code
24805 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24806 .endd
24807 rewrites a two-component bang path &'host.name!user'& as the domain address
24808 &'user@host.name'&. However, there is a security implication in using this as
24809 a global rewriting rule for envelope addresses. It can provide a backdoor
24810 method for using your system as a relay, because the incoming addresses appear
24811 to be local. If the bang path addresses are received via SMTP, it is safer to
24812 use the &"S"& flag to rewrite them as they are received, so that relay checking
24813 can be done on the rewritten addresses.
24814 .ecindex IIDaddrew
24815
24816
24817
24818
24819
24820 . ////////////////////////////////////////////////////////////////////////////
24821 . ////////////////////////////////////////////////////////////////////////////
24822
24823 .chapter "Retry configuration" "CHAPretry"
24824 .scindex IIDretconf1 "retry" "configuration, description of"
24825 .scindex IIDregconf2 "configuration file" "retry section"
24826 The &"retry"& section of the runtime configuration file contains a list of
24827 retry rules that control how often Exim tries to deliver messages that cannot
24828 be delivered at the first attempt. If there are no retry rules (the section is
24829 empty or not present), there are no retries. In this situation, temporary
24830 errors are treated as permanent. The default configuration contains a single,
24831 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24832 line option can be used to test which retry rule will be used for a given
24833 address, domain and error.
24834
24835 The most common cause of retries is temporary failure to deliver to a remote
24836 host because the host is down, or inaccessible because of a network problem.
24837 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24838 address) basis, not on a per-message basis. Thus, if one message has recently
24839 been delayed, delivery of a new message to the same host is not immediately
24840 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24841 log selector is set, the message
24842 .cindex "retry" "time not reached"
24843 &"retry time not reached"& is written to the main log whenever a delivery is
24844 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24845 the handling of errors during remote deliveries.
24846
24847 Retry processing applies to routing as well as to delivering, except as covered
24848 in the next paragraph. The retry rules do not distinguish between these
24849 actions. It is not possible, for example, to specify different behaviour for
24850 failures to route the domain &'snark.fict.example'& and failures to deliver to
24851 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24852 added complication, so did not implement it. However, although they share the
24853 same retry rule, the actual retry times for routing and transporting a given
24854 domain are maintained independently.
24855
24856 When a delivery is not part of a queue run (typically an immediate delivery on
24857 receipt of a message), the routers are always run, and local deliveries are
24858 always attempted, even if retry times are set for them. This makes for better
24859 behaviour if one particular message is causing problems (for example, causing
24860 quota overflow, or provoking an error in a filter file). If such a delivery
24861 suffers a temporary failure, the retry data is updated as normal, and
24862 subsequent delivery attempts from queue runs occur only when the retry time for
24863 the local address is reached.
24864
24865 .section "Changing retry rules" "SECID157"
24866 If you change the retry rules in your configuration, you should consider
24867 whether or not to delete the retry data that is stored in Exim's spool area in
24868 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24869 always safe; that is why they are called &"hints"&.
24870
24871 The hints retry data contains suggested retry times based on the previous
24872 rules. In the case of a long-running problem with a remote host, it might
24873 record the fact that the host has timed out. If your new rules increase the
24874 timeout time for such a host, you should definitely remove the old retry data
24875 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24876 messages that it should now be retaining.
24877
24878
24879
24880 .section "Format of retry rules" "SECID158"
24881 .cindex "retry" "rules"
24882 Each retry rule occupies one line and consists of three or four parts,
24883 separated by white space: a pattern, an error name, an optional list of sender
24884 addresses, and a list of retry parameters. The pattern and sender lists must be
24885 enclosed in double quotes if they contain white space. The rules are searched
24886 in order until one is found where the pattern, error name, and sender list (if
24887 present) match the failing host or address, the error that occurred, and the
24888 message's sender, respectively.
24889
24890
24891 The pattern is any single item that may appear in an address list (see section
24892 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24893 which means that it is expanded before being tested against the address that
24894 has been delayed. A negated address list item is permitted. Address
24895 list processing treats a plain domain name as if it were preceded by &"*@"&,
24896 which makes it possible for many retry rules to start with just a domain. For
24897 example,
24898 .code
24899 lookingglass.fict.example        *  F,24h,30m;
24900 .endd
24901 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24902 whereas
24903 .code
24904 alice@lookingglass.fict.example  *  F,24h,30m;
24905 .endd
24906 applies only to temporary failures involving the local part &%alice%&.
24907 In practice, almost all rules start with a domain name pattern without a local
24908 part.
24909
24910 .cindex "regular expressions" "in retry rules"
24911 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24912 must match a complete address, not just a domain, because that is how regular
24913 expressions work in address lists.
24914 .display
24915 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24916 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24917 .endd
24918
24919
24920 .section "Choosing which retry rule to use for address errors" "SECID159"
24921 When Exim is looking for a retry rule after a routing attempt has failed (for
24922 example, after a DNS timeout), each line in the retry configuration is tested
24923 against the complete address only if &%retry_use_local_part%& is set for the
24924 router. Otherwise, only the domain is used, except when matching against a
24925 regular expression, when the local part of the address is replaced with &"*"&.
24926 A domain on its own can match a domain pattern, or a pattern that starts with
24927 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24928 &%check_local_user%& is true, and false for other routers.
24929
24930 Similarly, when Exim is looking for a retry rule after a local delivery has
24931 failed (for example, after a mailbox full error), each line in the retry
24932 configuration is tested against the complete address only if
24933 &%retry_use_local_part%& is set for the transport (it defaults true for all
24934 local transports).
24935
24936 .cindex "4&'xx'& responses" "retry rules for"
24937 However, when Exim is looking for a retry rule after a remote delivery attempt
24938 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24939 whole address is always used as the key when searching the retry rules. The
24940 rule that is found is used to create a retry time for the combination of the
24941 failing address and the message's sender. It is the combination of sender and
24942 recipient that is delayed in subsequent queue runs until its retry time is
24943 reached. You can delay the recipient without regard to the sender by setting
24944 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24945 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24946 commands.
24947
24948
24949
24950 .section "Choosing which retry rule to use for host and message errors" &&&
24951          "SECID160"
24952 For a temporary error that is not related to an individual address (for
24953 example, a connection timeout), each line in the retry configuration is checked
24954 twice. First, the name of the remote host is used as a domain name (preceded by
24955 &"*@"& when matching a regular expression). If this does not match the line,
24956 the domain from the email address is tried in a similar fashion. For example,
24957 suppose the MX records for &'a.b.c.example'& are
24958 .code
24959 a.b.c.example  MX  5  x.y.z.example
24960                MX  6  p.q.r.example
24961                MX  7  m.n.o.example
24962 .endd
24963 and the retry rules are
24964 .code
24965 p.q.r.example    *      F,24h,30m;
24966 a.b.c.example    *      F,4d,45m;
24967 .endd
24968 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24969 first rule matches neither the host nor the domain, so Exim looks at the second
24970 rule. This does not match the host, but it does match the domain, so it is used
24971 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24972 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24973 first retry rule is used, because it matches the host.
24974
24975 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24976 first rule to determine retry times, but for all the other hosts for the domain
24977 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24978 routing to &'a.b.c.example'& suffers a temporary failure.
24979
24980 &*Note*&: The host name is used when matching the patterns, not its IP address.
24981 However, if a message is routed directly to an IP address without the use of a
24982 host name, for example, if a &(manualroute)& router contains a setting such as:
24983 .code
24984 route_list = *.a.example  192.168.34.23
24985 .endd
24986 then the &"host name"& that is used when searching for a retry rule is the
24987 textual form of the IP address.
24988
24989 .section "Retry rules for specific errors" "SECID161"
24990 .cindex "retry" "specific errors; specifying"
24991 The second field in a retry rule is the name of a particular error, or an
24992 asterisk, which matches any error. The errors that can be tested for are:
24993
24994 .vlist
24995 .vitem &%auth_failed%&
24996 Authentication failed when trying to send to a host in the
24997 &%hosts_require_auth%& list in an &(smtp)& transport.
24998
24999 .vitem &%data_4xx%&
25000 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25001 after the command, or after sending the message's data.
25002
25003 .vitem &%mail_4xx%&
25004 A 4&'xx'& error was received for an outgoing MAIL command.
25005
25006 .vitem &%rcpt_4xx%&
25007 A 4&'xx'& error was received for an outgoing RCPT command.
25008 .endlist
25009
25010 For the three 4&'xx'& errors, either the first or both of the x's can be given
25011 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25012 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25013 and have retries every ten minutes with a one-hour timeout, you could set up a
25014 retry rule of this form:
25015 .code
25016 the.domain.name  rcpt_452   F,1h,10m
25017 .endd
25018 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25019 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25020
25021 .vlist
25022 .vitem &%lost_connection%&
25023 A server unexpectedly closed the SMTP connection. There may, of course,
25024 legitimate reasons for this (host died, network died), but if it repeats a lot
25025 for the same host, it indicates something odd.
25026
25027 .vitem &%lookup%&
25028 A DNS lookup for a host failed.
25029 Note that a &%dnslookup%& router will need to have matched
25030 its &%fail_defer_domains%& option for this retry type to be usable.
25031 Also note that a &%manualroute%& router will probably need
25032 its &%host_find_failed%& option set to &%defer%&.
25033
25034 .vitem &%refused_MX%&
25035 A connection to a host obtained from an MX record was refused.
25036
25037 .vitem &%refused_A%&
25038 A connection to a host not obtained from an MX record was refused.
25039
25040 .vitem &%refused%&
25041 A connection was refused.
25042
25043 .vitem &%timeout_connect_MX%&
25044 A connection attempt to a host obtained from an MX record timed out.
25045
25046 .vitem &%timeout_connect_A%&
25047 A connection attempt to a host not obtained from an MX record timed out.
25048
25049 .vitem &%timeout_connect%&
25050 A connection attempt timed out.
25051
25052 .vitem &%timeout_MX%&
25053 There was a timeout while connecting or during an SMTP session with a host
25054 obtained from an MX record.
25055
25056 .vitem &%timeout_A%&
25057 There was a timeout while connecting or during an SMTP session with a host not
25058 obtained from an MX record.
25059
25060 .vitem &%timeout%&
25061 There was a timeout while connecting or during an SMTP session.
25062
25063 .vitem &%tls_required%&
25064 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25065 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25066 to STARTTLS, or there was a problem setting up the TLS connection.
25067
25068 .vitem &%quota%&
25069 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25070 transport.
25071
25072 .vitem &%quota_%&<&'time'&>
25073 .cindex "quota" "error testing in retry rule"
25074 .cindex "retry" "quota error testing"
25075 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25076 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25077 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25078 for four days.
25079 .endlist
25080
25081 .cindex "mailbox" "time of last read"
25082 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25083 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25084 it should be based on the last time that the user accessed the mailbox.
25085 However, it is not always possible to determine this. Exim uses the following
25086 heuristic rules:
25087
25088 .ilist
25089 If the mailbox is a single file, the time of last access (the &"atime"&) is
25090 used. As no new messages are being delivered (because the mailbox is over
25091 quota), Exim does not access the file, so this is the time of last user access.
25092 .next
25093 .cindex "maildir format" "time of last read"
25094 For a maildir delivery, the time of last modification of the &_new_&
25095 subdirectory is used. As the mailbox is over quota, no new files are created in
25096 the &_new_& subdirectory, because no new messages are being delivered. Any
25097 change to the &_new_& subdirectory is therefore assumed to be the result of an
25098 MUA moving a new message to the &_cur_& directory when it is first read. The
25099 time that is used is therefore the last time that the user read a new message.
25100 .next
25101 For other kinds of multi-file mailbox, the time of last access cannot be
25102 obtained, so a retry rule that uses this type of error field is never matched.
25103 .endlist
25104
25105 The quota errors apply both to system-enforced quotas and to Exim's own quota
25106 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25107 when a local delivery is deferred because a partition is full (the ENOSPC
25108 error).
25109
25110
25111
25112 .section "Retry rules for specified senders" "SECID162"
25113 .cindex "retry" "rules; sender-specific"
25114 You can specify retry rules that apply only when the failing message has a
25115 specific sender. In particular, this can be used to define retry rules that
25116 apply only to bounce messages. The third item in a retry rule can be of this
25117 form:
25118 .display
25119 &`senders=`&<&'address list'&>
25120 .endd
25121 The retry timings themselves are then the fourth item. For example:
25122 .code
25123 *   rcpt_4xx   senders=:   F,1h,30m
25124 .endd
25125 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25126 host. If the address list contains white space, it must be enclosed in quotes.
25127 For example:
25128 .code
25129 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25130 .endd
25131 &*Warning*&: This facility can be unhelpful if it is used for host errors
25132 (which do not depend on the recipient). The reason is that the sender is used
25133 only to match the retry rule. Once the rule has been found for a host error,
25134 its contents are used to set a retry time for the host, and this will apply to
25135 all messages, not just those with specific senders.
25136
25137 When testing retry rules using &%-brt%&, you can supply a sender using the
25138 &%-f%& command line option, like this:
25139 .code
25140 exim -f "" -brt user@dom.ain
25141 .endd
25142 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25143 list is never matched.
25144
25145
25146
25147
25148
25149 .section "Retry parameters" "SECID163"
25150 .cindex "retry" "parameters in rules"
25151 The third (or fourth, if a senders list is present) field in a retry rule is a
25152 sequence of retry parameter sets, separated by semicolons. Each set consists of
25153 .display
25154 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25155 .endd
25156 The letter identifies the algorithm for computing a new retry time; the cutoff
25157 time is the time beyond which this algorithm no longer applies, and the
25158 arguments vary the algorithm's action. The cutoff time is measured from the
25159 time that the first failure for the domain (combined with the local part if
25160 relevant) was detected, not from the time the message was received.
25161
25162 .cindex "retry" "algorithms"
25163 .cindex "retry" "fixed intervals"
25164 .cindex "retry" "increasing intervals"
25165 .cindex "retry" "random intervals"
25166 The available algorithms are:
25167
25168 .ilist
25169 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25170 the interval.
25171 .next
25172 &'G'&: retry at geometrically increasing intervals. The first argument
25173 specifies a starting value for the interval, and the second a multiplier, which
25174 is used to increase the size of the interval at each retry.
25175 .next
25176 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25177 retry, the previous interval is multiplied by the factor in order to get a
25178 maximum for the next interval. The minimum interval is the first argument of
25179 the parameter, and an actual interval is chosen randomly between them. Such a
25180 rule has been found to be helpful in cluster configurations when all the
25181 members of the cluster restart at once, and may therefore synchronize their
25182 queue processing times.
25183 .endlist
25184
25185 When computing the next retry time, the algorithm definitions are scanned in
25186 order until one whose cutoff time has not yet passed is reached. This is then
25187 used to compute a new retry time that is later than the current time. In the
25188 case of fixed interval retries, this simply means adding the interval to the
25189 current time. For geometrically increasing intervals, retry intervals are
25190 computed from the rule's parameters until one that is greater than the previous
25191 interval is found. The main configuration variable
25192 .cindex "limit" "retry interval"
25193 .cindex "retry" "interval, maximum"
25194 .oindex "&%retry_interval_max%&"
25195 &%retry_interval_max%& limits the maximum interval between retries. It
25196 cannot be set greater than &`24h`&, which is its default value.
25197
25198 A single remote domain may have a number of hosts associated with it, and each
25199 host may have more than one IP address. Retry algorithms are selected on the
25200 basis of the domain name, but are applied to each IP address independently. If,
25201 for example, a host has two IP addresses and one is unusable, Exim will
25202 generate retry times for it and will not try to use it until its next retry
25203 time comes. Thus the good IP address is likely to be tried first most of the
25204 time.
25205
25206 .cindex "hints database" "use for retrying"
25207 Retry times are hints rather than promises. Exim does not make any attempt to
25208 run deliveries exactly at the computed times. Instead, a queue runner process
25209 starts delivery processes for delayed messages periodically, and these attempt
25210 new deliveries only for those addresses that have passed their next retry time.
25211 If a new message arrives for a deferred address, an immediate delivery attempt
25212 occurs only if the address has passed its retry time. In the absence of new
25213 messages, the minimum time between retries is the interval between queue runner
25214 processes. There is not much point in setting retry times of five minutes if
25215 your queue runners happen only once an hour, unless there are a significant
25216 number of incoming messages (which might be the case on a system that is
25217 sending everything to a smart host, for example).
25218
25219 The data in the retry hints database can be inspected by using the
25220 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25221 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25222 &'exinext'& utility script can be used to find out what the next retry times
25223 are for the hosts associated with a particular mail domain, and also for local
25224 deliveries that have been deferred.
25225
25226
25227 .section "Retry rule examples" "SECID164"
25228 Here are some example retry rules:
25229 .code
25230 alice@wonderland.fict.example quota_5d  F,7d,3h
25231 wonderland.fict.example       quota_5d
25232 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25233 lookingglass.fict.example     *         F,24h,30m;
25234 *                 refused_A   F,2h,20m;
25235 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25236 .endd
25237 The first rule sets up special handling for mail to
25238 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25239 mailbox has not been read for at least 5 days. Retries continue every three
25240 hours for 7 days. The second rule handles over-quota errors for all other local
25241 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25242 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25243 fail are bounced immediately if the mailbox has not been read for at least 5
25244 days.
25245
25246 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25247 happen every 15 minutes for an hour, then with geometrically increasing
25248 intervals until two days have passed since a delivery first failed. After the
25249 first hour there is a delay of one hour, then two hours, then four hours, and
25250 so on (this is a rather extreme example).
25251
25252 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25253 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25254 all other domains, with special action for connection refusal from hosts that
25255 were not obtained from an MX record.
25256
25257 The final rule in a retry configuration should always have asterisks in the
25258 first two fields so as to provide a general catch-all for any addresses that do
25259 not have their own special handling. This example tries every 15 minutes for 2
25260 hours, then with intervals starting at one hour and increasing by a factor of
25261 1.5 up to 16 hours, then every 8 hours up to 5 days.
25262
25263
25264
25265 .section "Timeout of retry data" "SECID165"
25266 .cindex "timeout" "of retry data"
25267 .oindex "&%retry_data_expire%&"
25268 .cindex "hints database" "data expiry"
25269 .cindex "retry" "timeout of data"
25270 Exim timestamps the data that it writes to its retry hints database. When it
25271 consults the data during a delivery it ignores any that is older than the value
25272 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25273 been tried for 7 days, Exim will try to deliver to it immediately a message
25274 arrives, and if that fails, it will calculate a retry time as if it were
25275 failing for the first time.
25276
25277 This improves the behaviour for messages routed to rarely-used hosts such as MX
25278 backups. If such a host was down at one time, and happens to be down again when
25279 Exim tries a month later, using the old retry data would imply that it had been
25280 down all the time, which is not a justified assumption.
25281
25282 If a host really is permanently dead, this behaviour causes a burst of retries
25283 every now and again, but only if messages routed to it are rare. If there is a
25284 message at least once every 7 days the retry data never expires.
25285
25286
25287
25288
25289 .section "Long-term failures" "SECID166"
25290 .cindex "delivery failure, long-term"
25291 .cindex "retry" "after long-term failure"
25292 Special processing happens when an email address has been failing for so long
25293 that the cutoff time for the last algorithm is reached. For example, using the
25294 default retry rule:
25295 .code
25296 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25297 .endd
25298 the cutoff time is four days. Reaching the retry cutoff is independent of how
25299 long any specific message has been failing; it is the length of continuous
25300 failure for the recipient address that counts.
25301
25302 When the cutoff time is reached for a local delivery, or for all the IP
25303 addresses associated with a remote delivery, a subsequent delivery failure
25304 causes Exim to give up on the address, and a bounce message is generated.
25305 In order to cater for new messages that use the failing address, a next retry
25306 time is still computed from the final algorithm, and is used as follows:
25307
25308 For local deliveries, one delivery attempt is always made for any subsequent
25309 messages. If this delivery fails, the address fails immediately. The
25310 post-cutoff retry time is not used.
25311
25312 If the delivery is remote, there are two possibilities, controlled by the
25313 .oindex "&%delay_after_cutoff%&"
25314 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25315 default. Until the post-cutoff retry time for one of the IP addresses is
25316 reached, the failing email address is bounced immediately, without a delivery
25317 attempt taking place. After that time, one new delivery attempt is made to
25318 those IP addresses that are past their retry times, and if that still fails,
25319 the address is bounced and new retry times are computed.
25320
25321 In other words, when all the hosts for a given email address have been failing
25322 for a long time, Exim bounces rather then defers until one of the hosts' retry
25323 times is reached. Then it tries once, and bounces if that attempt fails. This
25324 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25325 to a broken destination, but if the host does recover, Exim will eventually
25326 notice.
25327
25328 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25329 addresses are past their final cutoff time, Exim tries to deliver to those IP
25330 addresses that have not been tried since the message arrived. If there are
25331 no suitable IP addresses, or if they all fail, the address is bounced. In other
25332 words, it does not delay when a new message arrives, but tries the expired
25333 addresses immediately, unless they have been tried since the message arrived.
25334 If there is a continuous stream of messages for the failing domains, setting
25335 &%delay_after_cutoff%& false means that there will be many more attempts to
25336 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25337 true.
25338
25339 .section "Deliveries that work intermittently" "SECID167"
25340 .cindex "retry" "intermittently working deliveries"
25341 Some additional logic is needed to cope with cases where a host is
25342 intermittently available, or when a message has some attribute that prevents
25343 its delivery when others to the same address get through. In this situation,
25344 because some messages are successfully delivered, the &"retry clock"& for the
25345 host or address keeps getting reset by the successful deliveries, and so
25346 failing messages remain on the queue for ever because the cutoff time is never
25347 reached.
25348
25349 Two exceptional actions are applied to prevent this happening. The first
25350 applies to errors that are related to a message rather than a remote host.
25351 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25352 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25353 commands, and quota failures. For this type of error, if a message's arrival
25354 time is earlier than the &"first failed"& time for the error, the earlier time
25355 is used when scanning the retry rules to decide when to try next and when to
25356 time out the address.
25357
25358 The exceptional second action applies in all cases. If a message has been on
25359 the queue for longer than the cutoff time of any applicable retry rule for a
25360 given address, a delivery is attempted for that address, even if it is not yet
25361 time, and if this delivery fails, the address is timed out. A new retry time is
25362 not computed in this case, so that other messages for the same address are
25363 considered immediately.
25364 .ecindex IIDretconf1
25365 .ecindex IIDregconf2
25366
25367
25368
25369
25370
25371
25372 . ////////////////////////////////////////////////////////////////////////////
25373 . ////////////////////////////////////////////////////////////////////////////
25374
25375 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25376 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25377 .scindex IIDauthconf2 "authentication"
25378 The &"authenticators"& section of Exim's run time configuration is concerned
25379 with SMTP authentication. This facility is an extension to the SMTP protocol,
25380 described in RFC 2554, which allows a client SMTP host to authenticate itself
25381 to a server. This is a common way for a server to recognize clients that are
25382 permitted to use it as a relay. SMTP authentication is not of relevance to the
25383 transfer of mail between servers that have no managerial connection with each
25384 other.
25385
25386 .cindex "AUTH" "description of"
25387 Very briefly, the way SMTP authentication works is as follows:
25388
25389 .ilist
25390 The server advertises a number of authentication &'mechanisms'& in response to
25391 the client's EHLO command.
25392 .next
25393 The client issues an AUTH command, naming a specific mechanism. The command
25394 may, optionally, contain some authentication data.
25395 .next
25396 The server may issue one or more &'challenges'&, to which the client must send
25397 appropriate responses. In simple authentication mechanisms, the challenges are
25398 just prompts for user names and passwords. The server does not have to issue
25399 any challenges &-- in some mechanisms the relevant data may all be transmitted
25400 with the AUTH command.
25401 .next
25402 The server either accepts or denies authentication.
25403 .next
25404 If authentication succeeds, the client may optionally make use of the AUTH
25405 option on the MAIL command to pass an authenticated sender in subsequent
25406 mail transactions. Authentication lasts for the remainder of the SMTP
25407 connection.
25408 .next
25409 If authentication fails, the client may give up, or it may try a different
25410 authentication mechanism, or it may try transferring mail over the
25411 unauthenticated connection.
25412 .endlist
25413
25414 If you are setting up a client, and want to know which authentication
25415 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25416 SMTP port) on the server, and issue an EHLO command. The response to this
25417 includes the list of supported mechanisms. For example:
25418 .display
25419 &`$ `&&*&`telnet server.example 25`&*&
25420 &`Trying 192.168.34.25...`&
25421 &`Connected to server.example.`&
25422 &`Escape character is &#x0027;^]&#x0027;.`&
25423 &`220 server.example ESMTP Exim 4.20 ...`&
25424 &*&`ehlo client.example`&*&
25425 &`250-server.example Hello client.example [10.8.4.5]`&
25426 &`250-SIZE 52428800`&
25427 &`250-PIPELINING`&
25428 &`250-AUTH PLAIN`&
25429 &`250 HELP`&
25430 .endd
25431 The second-last line of this example output shows that the server supports
25432 authentication using the PLAIN mechanism. In Exim, the different authentication
25433 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25434 routers and transports, which authenticators are included in the binary is
25435 controlled by build-time definitions. The following are currently available,
25436 included by setting
25437 .code
25438 AUTH_CRAM_MD5=yes
25439 AUTH_CYRUS_SASL=yes
25440 AUTH_DOVECOT=yes
25441 AUTH_GSASL=yes
25442 AUTH_HEIMDAL_GSSAPI=yes
25443 AUTH_PLAINTEXT=yes
25444 AUTH_SPA=yes
25445 AUTH_TLS=yes
25446 .endd
25447 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25448 authentication mechanism (RFC 2195), and the second provides an interface to
25449 the Cyrus SASL authentication library.
25450 The third is an interface to Dovecot's authentication system, delegating the
25451 work via a socket interface.
25452 The fourth provides an interface to the GNU SASL authentication library, which
25453 provides mechanisms but typically not data sources.
25454 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25455 supporting setting a server keytab.
25456 The sixth can be configured to support
25457 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25458 not formally documented, but used by several MUAs. The seventh authenticator
25459 supports Microsoft's &'Secure Password Authentication'& mechanism.
25460 The eighth is an Exim authenticator but not an SMTP one;
25461 instead it can use information from a TLS negotiation.
25462
25463 The authenticators are configured using the same syntax as other drivers (see
25464 section &<<SECTfordricon>>&). If no authenticators are required, no
25465 authentication section need be present in the configuration file. Each
25466 authenticator can in principle have both server and client functions. When Exim
25467 is receiving SMTP mail, it is acting as a server; when it is sending out
25468 messages over SMTP, it is acting as a client. Authenticator configuration
25469 options are provided for use in both these circumstances.
25470
25471 To make it clear which options apply to which situation, the prefixes
25472 &%server_%& and &%client_%& are used on option names that are specific to
25473 either the server or the client function, respectively. Server and client
25474 functions are disabled if none of their options are set. If an authenticator is
25475 to be used for both server and client functions, a single definition, using
25476 both sets of options, is required. For example:
25477 .code
25478 cram:
25479   driver = cram_md5
25480   public_name = CRAM-MD5
25481   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25482   client_name = ph10
25483   client_secret = secret2
25484 .endd
25485 The &%server_%& option is used when Exim is acting as a server, and the
25486 &%client_%& options when it is acting as a client.
25487
25488 Descriptions of the individual authenticators are given in subsequent chapters.
25489 The remainder of this chapter covers the generic options for the
25490 authenticators, followed by general discussion of the way authentication works
25491 in Exim.
25492
25493 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25494 per-mechanism basis.  Please read carefully to determine which variables hold
25495 account labels such as usercodes and which hold passwords or other
25496 authenticating data.
25497
25498 Note that some mechanisms support two different identifiers for accounts: the
25499 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25500 and &'authz'& are commonly encountered.  The American spelling is standard here.
25501 Conceptually, authentication data such as passwords are tied to the identifier
25502 used to authenticate; servers may have rules to permit one user to act as a
25503 second user, so that after login the session is treated as though that second
25504 user had logged in.  That second user is the &'authorization id'&.  A robust
25505 configuration might confirm that the &'authz'& field is empty or matches the
25506 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25507 as verified data, the &'authz'& as an unverified request which the server might
25508 choose to honour.
25509
25510 A &'realm'& is a text string, typically a domain name, presented by a server
25511 to a client to help it select an account and credentials to use.  In some
25512 mechanisms, the client and server provably agree on the realm, but clients
25513 typically can not treat the realm as secure data to be blindly trusted.
25514
25515
25516
25517 .section "Generic options for authenticators" "SECID168"
25518 .cindex "authentication" "generic options"
25519 .cindex "options" "generic; for authenticators"
25520
25521 .option client_condition authenticators string&!! unset
25522 When Exim is authenticating as a client, it skips any authenticator whose
25523 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25524 used, for example, to skip plain text authenticators when the connection is not
25525 encrypted by a setting such as:
25526 .code
25527 client_condition = ${if !eq{$tls_out_cipher}{}}
25528 .endd
25529
25530
25531 .option client_set_id authenticators string&!! unset
25532 When client authentication succeeds, this condition is expanded; the
25533 result is used in the log lines for outbound messages.
25534 Typically it will be the user name used for authentication.
25535
25536
25537 .option driver authenticators string unset
25538 This option must always be set. It specifies which of the available
25539 authenticators is to be used.
25540
25541
25542 .option public_name authenticators string unset
25543 This option specifies the name of the authentication mechanism that the driver
25544 implements, and by which it is known to the outside world. These names should
25545 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25546 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25547 defaults to the driver's instance name.
25548
25549
25550 .option server_advertise_condition authenticators string&!! unset
25551 When a server is about to advertise an authentication mechanism, the condition
25552 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25553 mechanism is not advertised.
25554 If the expansion fails, the mechanism is not advertised. If the failure was not
25555 forced, and was not caused by a lookup defer, the incident is logged.
25556 See section &<<SECTauthexiser>>& below for further discussion.
25557
25558
25559 .option server_condition authenticators string&!! unset
25560 This option must be set for a &%plaintext%& server authenticator, where it
25561 is used directly to control authentication. See section &<<SECTplainserver>>&
25562 for details.
25563
25564 For the &(gsasl)& authenticator, this option is required for various
25565 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25566
25567 For the other authenticators, &%server_condition%& can be used as an additional
25568 authentication or authorization mechanism that is applied after the other
25569 authenticator conditions succeed. If it is set, it is expanded when the
25570 authenticator would otherwise return a success code. If the expansion is forced
25571 to fail, authentication fails. Any other expansion failure causes a temporary
25572 error code to be returned. If the result of a successful expansion is an empty
25573 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25574 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25575 other result, a temporary error code is returned, with the expanded string as
25576 the error text.
25577
25578
25579 .option server_debug_print authenticators string&!! unset
25580 If this option is set and authentication debugging is enabled (see the &%-d%&
25581 command line option), the string is expanded and included in the debugging
25582 output when the authenticator is run as a server. This can help with checking
25583 out the values of variables.
25584 If expansion of the string fails, the error message is written to the debugging
25585 output, and Exim carries on processing.
25586
25587
25588 .option server_set_id authenticators string&!! unset
25589 .vindex "&$authenticated_id$&"
25590 When an Exim server successfully authenticates a client, this string is
25591 expanded using data from the authentication, and preserved for any incoming
25592 messages in the variable &$authenticated_id$&. It is also included in the log
25593 lines for incoming messages. For example, a user/password authenticator
25594 configuration might preserve the user name that was used to authenticate, and
25595 refer to it subsequently during delivery of the message.
25596 If expansion fails, the option is ignored.
25597
25598
25599 .option server_mail_auth_condition authenticators string&!! unset
25600 This option allows a server to discard authenticated sender addresses supplied
25601 as part of MAIL commands in SMTP connections that are authenticated by the
25602 driver on which &%server_mail_auth_condition%& is set. The option is not used
25603 as part of the authentication process; instead its (unexpanded) value is
25604 remembered for later use.
25605 How it is used is described in the following section.
25606
25607
25608
25609
25610
25611 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25612 .cindex "authentication" "sender; authenticated"
25613 .cindex "AUTH" "on MAIL command"
25614 When a client supplied an AUTH= item on a MAIL command, Exim applies
25615 the following checks before accepting it as the authenticated sender of the
25616 message:
25617
25618 .ilist
25619 If the connection is not using extended SMTP (that is, HELO was used rather
25620 than EHLO), the use of AUTH= is a syntax error.
25621 .next
25622 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25623 .next
25624 .vindex "&$authenticated_sender$&"
25625 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25626 running, the value of &$authenticated_sender$& is set to the value obtained
25627 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25628 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25629 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25630 given for the MAIL command.
25631 .next
25632 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25633 is accepted and placed in &$authenticated_sender$& only if the client has
25634 authenticated.
25635 .next
25636 If the AUTH= value was accepted by either of the two previous rules, and
25637 the client has authenticated, and the authenticator has a setting for the
25638 &%server_mail_auth_condition%&, the condition is checked at this point. The
25639 valued that was saved from the authenticator is expanded. If the expansion
25640 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25641 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25642 the value of &$authenticated_sender$& is retained and passed on with the
25643 message.
25644 .endlist
25645
25646
25647 When &$authenticated_sender$& is set for a message, it is passed on to other
25648 hosts to which Exim authenticates as a client. Do not confuse this value with
25649 &$authenticated_id$&, which is a string obtained from the authentication
25650 process, and which is not usually a complete email address.
25651
25652 .vindex "&$sender_address$&"
25653 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25654 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25655 therefore make use of &$authenticated_sender$&. The converse is not true: the
25656 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25657 ACL is run.
25658
25659
25660
25661 .section "Authentication on an Exim server" "SECTauthexiser"
25662 .cindex "authentication" "on an Exim server"
25663 When Exim receives an EHLO command, it advertises the public names of those
25664 authenticators that are configured as servers, subject to the following
25665 conditions:
25666
25667 .ilist
25668 The client host must match &%auth_advertise_hosts%& (default *).
25669 .next
25670 It the &%server_advertise_condition%& option is set, its expansion must not
25671 yield the empty string, &"0"&, &"no"&, or &"false"&.
25672 .endlist
25673
25674 The order in which the authenticators are defined controls the order in which
25675 the mechanisms are advertised.
25676
25677 Some mail clients (for example, some versions of Netscape) require the user to
25678 provide a name and password for authentication whenever AUTH is advertised,
25679 even though authentication may not in fact be needed (for example, Exim may be
25680 set up to allow unconditional relaying from the client by an IP address check).
25681 You can make such clients more friendly by not advertising AUTH to them.
25682 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25683 that runs for RCPT) to relay without authentication, you should set
25684 .code
25685 auth_advertise_hosts = ! 10.9.8.0/24
25686 .endd
25687 so that no authentication mechanisms are advertised to them.
25688
25689 The &%server_advertise_condition%& controls the advertisement of individual
25690 authentication mechanisms. For example, it can be used to restrict the
25691 advertisement of a particular mechanism to encrypted connections, by a setting
25692 such as:
25693 .code
25694 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25695 .endd
25696 .vindex "&$tls_in_cipher$&"
25697 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25698 yields &"yes"&, which allows the advertisement to happen.
25699
25700 When an Exim server receives an AUTH command from a client, it rejects it
25701 immediately if AUTH was not advertised in response to an earlier EHLO
25702 command. This is the case if
25703
25704 .ilist
25705 The client host does not match &%auth_advertise_hosts%&; or
25706 .next
25707 No authenticators are configured with server options; or
25708 .next
25709 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25710 server authenticators.
25711 .endlist
25712
25713
25714 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25715 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25716 AUTH is accepted from any client host.
25717
25718 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25719 server authentication mechanism that was advertised in response to EHLO and
25720 that matches the one named in the AUTH command. If it finds one, it runs
25721 the appropriate authentication protocol, and authentication either succeeds or
25722 fails. If there is no matching advertised mechanism, the AUTH command is
25723 rejected with a 504 error.
25724
25725 .vindex "&$received_protocol$&"
25726 .vindex "&$sender_host_authenticated$&"
25727 When a message is received from an authenticated host, the value of
25728 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25729 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25730 public name) of the authenticator driver that successfully authenticated the
25731 client from which the message was received. This variable is empty if there was
25732 no successful authentication.
25733
25734
25735
25736
25737 .section "Testing server authentication" "SECID169"
25738 .cindex "authentication" "testing a server"
25739 .cindex "AUTH" "testing a server"
25740 .cindex "base64 encoding" "creating authentication test data"
25741 Exim's &%-bh%& option can be useful for testing server authentication
25742 configurations. The data for the AUTH command has to be sent using base64
25743 encoding. A quick way to produce such data for testing is the following Perl
25744 script:
25745 .code
25746 use MIME::Base64;
25747 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25748 .endd
25749 .cindex "binary zero" "in authentication data"
25750 This interprets its argument as a Perl string, and then encodes it. The
25751 interpretation as a Perl string allows binary zeros, which are required for
25752 some kinds of authentication, to be included in the data. For example, a
25753 command line to run this script on such data might be
25754 .code
25755 encode '\0user\0password'
25756 .endd
25757 Note the use of single quotes to prevent the shell interpreting the
25758 backslashes, so that they can be interpreted by Perl to specify characters
25759 whose code value is zero.
25760
25761 &*Warning 1*&: If either of the user or password strings starts with an octal
25762 digit, you must use three zeros instead of one after the leading backslash. If
25763 you do not, the octal digit that starts your string will be incorrectly
25764 interpreted as part of the code for the first character.
25765
25766 &*Warning 2*&: If there are characters in the strings that Perl interprets
25767 specially, you must use a Perl escape to prevent them being misinterpreted. For
25768 example, a command such as
25769 .code
25770 encode '\0user@domain.com\0pas$$word'
25771 .endd
25772 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25773
25774 If you have the &%mimencode%& command installed, another way to do produce
25775 base64-encoded strings is to run the command
25776 .code
25777 echo -e -n `\0user\0password' | mimencode
25778 .endd
25779 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25780 in the argument, and the &%-n%& option specifies no newline at the end of its
25781 output. However, not all versions of &%echo%& recognize these options, so you
25782 should check your version before relying on this suggestion.
25783
25784
25785
25786 .section "Authentication by an Exim client" "SECID170"
25787 .cindex "authentication" "on an Exim client"
25788 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25789 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25790 announces support for authentication, and the host matches an entry in either
25791 of these options, Exim (as a client) tries to authenticate as follows:
25792
25793 .ilist
25794 For each authenticator that is configured as a client, in the order in which
25795 they are defined in the configuration, it searches the authentication
25796 mechanisms announced by the server for one whose name matches the public name
25797 of the authenticator.
25798 .next
25799 .vindex "&$host$&"
25800 .vindex "&$host_address$&"
25801 When it finds one that matches, it runs the authenticator's client code. The
25802 variables &$host$& and &$host_address$& are available for any string expansions
25803 that the client might do. They are set to the server's name and IP address. If
25804 any expansion is forced to fail, the authentication attempt is abandoned, and
25805 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25806 delivery to be deferred.
25807 .next
25808 If the result of the authentication attempt is a temporary error or a timeout,
25809 Exim abandons trying to send the message to the host for the moment. It will
25810 try again later. If there are any backup hosts available, they are tried in the
25811 usual way.
25812 .next
25813 If the response to authentication is a permanent error (5&'xx'& code), Exim
25814 carries on searching the list of authenticators and tries another one if
25815 possible. If all authentication attempts give permanent errors, or if there are
25816 no attempts because no mechanisms match (or option expansions force failure),
25817 what happens depends on whether the host matches &%hosts_require_auth%& or
25818 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25819 delivery is deferred. The error can be detected in the retry rules, and thereby
25820 turned into a permanent error if you wish. In the second case, Exim tries to
25821 deliver the message unauthenticated.
25822 .endlist
25823
25824 .cindex "AUTH" "on MAIL command"
25825 When Exim has authenticated itself to a remote server, it adds the AUTH
25826 parameter to the MAIL commands it sends, if it has an authenticated sender for
25827 the message. If the message came from a remote host, the authenticated sender
25828 is the one that was receiving on an incoming MAIL command, provided that the
25829 incoming connection was authenticated and the &%server_mail_auth%& condition
25830 allowed the authenticated sender to be retained. If a local process calls Exim
25831 to send a message, the sender address that is built from the login name and
25832 &%qualify_domain%& is treated as authenticated. However, if the
25833 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25834 the authenticated sender that was received with the message.
25835 .ecindex IIDauthconf1
25836 .ecindex IIDauthconf2
25837
25838
25839
25840
25841
25842
25843 . ////////////////////////////////////////////////////////////////////////////
25844 . ////////////////////////////////////////////////////////////////////////////
25845
25846 .chapter "The plaintext authenticator" "CHAPplaintext"
25847 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25848 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25849 The &(plaintext)& authenticator can be configured to support the PLAIN and
25850 LOGIN authentication mechanisms, both of which transfer authentication data as
25851 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25852 security risk; you are strongly advised to insist on the use of SMTP encryption
25853 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25854 use unencrypted plain text, you should not use the same passwords for SMTP
25855 connections as you do for login accounts.
25856
25857 .section "Plaintext options" "SECID171"
25858 .cindex "options" "&(plaintext)& authenticator (server)"
25859 When configured as a server, &(plaintext)& uses the following options:
25860
25861 .option server_condition authenticators string&!! unset
25862 This is actually a global authentication option, but it must be set in order to
25863 configure the &(plaintext)& driver as a server. Its use is described below.
25864
25865 .option server_prompts plaintext string&!! unset
25866 The contents of this option, after expansion, must be a colon-separated list of
25867 prompt strings. If expansion fails, a temporary authentication rejection is
25868 given.
25869
25870 .section "Using plaintext in a server" "SECTplainserver"
25871 .cindex "AUTH" "in &(plaintext)& authenticator"
25872 .cindex "binary zero" "in &(plaintext)& authenticator"
25873 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25874         "in &(plaintext)& authenticator"
25875 .vindex "&$auth1$&, &$auth2$&, etc"
25876 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25877
25878 When running as a server, &(plaintext)& performs the authentication test by
25879 expanding a string. The data sent by the client with the AUTH command, or in
25880 response to subsequent prompts, is base64 encoded, and so may contain any byte
25881 values when decoded. If any data is supplied with the command, it is treated as
25882 a list of strings, separated by NULs (binary zeros), the first three of which
25883 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25884 (neither LOGIN nor PLAIN uses more than three strings).
25885
25886 For compatibility with previous releases of Exim, the values are also placed in
25887 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25888 variables for this purpose is now deprecated, as it can lead to confusion in
25889 string expansions that also use them for other things.
25890
25891 If there are more strings in &%server_prompts%& than the number of strings
25892 supplied with the AUTH command, the remaining prompts are used to obtain more
25893 data. Each response from the client may be a list of NUL-separated strings.
25894
25895 .vindex "&$authenticated_id$&"
25896 Once a sufficient number of data strings have been received,
25897 &%server_condition%& is expanded. If the expansion is forced to fail,
25898 authentication fails. Any other expansion failure causes a temporary error code
25899 to be returned. If the result of a successful expansion is an empty string,
25900 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25901 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25902 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25903 For any other result, a temporary error code is returned, with the expanded
25904 string as the error text
25905
25906 &*Warning*&: If you use a lookup in the expansion to find the user's
25907 password, be sure to make the authentication fail if the user is unknown.
25908 There are good and bad examples at the end of the next section.
25909
25910
25911
25912 .section "The PLAIN authentication mechanism" "SECID172"
25913 .cindex "PLAIN authentication mechanism"
25914 .cindex "authentication" "PLAIN mechanism"
25915 .cindex "binary zero" "in &(plaintext)& authenticator"
25916 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25917 sent as one item of data (that is, one combined string containing two NUL
25918 separators). The data is sent either as part of the AUTH command, or
25919 subsequently in response to an empty prompt from the server.
25920
25921 The second and third strings are a user name and a corresponding password.
25922 Using a single fixed user name and password as an example, this could be
25923 configured as follows:
25924 .code
25925 fixed_plain:
25926   driver = plaintext
25927   public_name = PLAIN
25928   server_prompts = :
25929   server_condition = \
25930     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25931   server_set_id = $auth2
25932 .endd
25933 Note that the default result strings from &%if%& (&"true"& or an empty string)
25934 are exactly what we want here, so they need not be specified. Obviously, if the
25935 password contains expansion-significant characters such as dollar, backslash,
25936 or closing brace, they have to be escaped.
25937
25938 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25939 the end of a string list are ignored). If all the data comes as part of the
25940 AUTH command, as is commonly the case, the prompt is not used. This
25941 authenticator is advertised in the response to EHLO as
25942 .code
25943 250-AUTH PLAIN
25944 .endd
25945 and a client host can authenticate itself by sending the command
25946 .code
25947 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25948 .endd
25949 As this contains three strings (more than the number of prompts), no further
25950 data is required from the client. Alternatively, the client may just send
25951 .code
25952 AUTH PLAIN
25953 .endd
25954 to initiate authentication, in which case the server replies with an empty
25955 prompt. The client must respond with the combined data string.
25956
25957 The data string is base64 encoded, as required by the RFC. This example,
25958 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25959 represents a zero byte. This is split up into three strings, the first of which
25960 is empty. The &%server_condition%& option in the authenticator checks that the
25961 second two are &`username`& and &`mysecret`& respectively.
25962
25963 Having just one fixed user name and password, as in this example, is not very
25964 realistic, though for a small organization with only a handful of
25965 authenticating clients it could make sense.
25966
25967 A more sophisticated instance of this authenticator could use the user name in
25968 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25969 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25970 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25971 This is an incorrect example:
25972 .code
25973 server_condition = \
25974   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25975 .endd
25976 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25977 which it then compares to the supplied password (&$auth3$&). Why is this example
25978 incorrect? It works fine for existing users, but consider what happens if a
25979 non-existent user name is given. The lookup fails, but as no success/failure
25980 strings are given for the lookup, it yields an empty string. Thus, to defeat
25981 the authentication, all a client has to do is to supply a non-existent user
25982 name and an empty password. The correct way of writing this test is:
25983 .code
25984 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25985   {${if eq{$value}{$auth3}}} {false}}
25986 .endd
25987 In this case, if the lookup succeeds, the result is checked; if the lookup
25988 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25989 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25990 always fails if its second argument is empty. However, the second way of
25991 writing the test makes the logic clearer.
25992
25993
25994 .section "The LOGIN authentication mechanism" "SECID173"
25995 .cindex "LOGIN authentication mechanism"
25996 .cindex "authentication" "LOGIN mechanism"
25997 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25998 in a number of programs. No data is sent with the AUTH command. Instead, a
25999 user name and password are supplied separately, in response to prompts. The
26000 plaintext authenticator can be configured to support this as in this example:
26001 .code
26002 fixed_login:
26003   driver = plaintext
26004   public_name = LOGIN
26005   server_prompts = User Name : Password
26006   server_condition = \
26007     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26008   server_set_id = $auth1
26009 .endd
26010 Because of the way plaintext operates, this authenticator accepts data supplied
26011 with the AUTH command (in contravention of the specification of LOGIN), but
26012 if the client does not supply it (as is the case for LOGIN clients), the prompt
26013 strings are used to obtain two data items.
26014
26015 Some clients are very particular about the precise text of the prompts. For
26016 example, Outlook Express is reported to recognize only &"Username:"& and
26017 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26018 strings. It uses the &%ldapauth%& expansion condition to check the user
26019 name and password by binding to an LDAP server:
26020 .code
26021 login:
26022   driver = plaintext
26023   public_name = LOGIN
26024   server_prompts = Username:: : Password::
26025   server_condition = ${if and{{ \
26026     !eq{}{$auth1} }{ \
26027     ldapauth{\
26028       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26029       pass=${quote:$auth2} \
26030       ldap://ldap.example.org/} }} }
26031   server_set_id = uid=$auth1,ou=people,o=example.org
26032 .endd
26033 We have to check that the username is not empty before using it, because LDAP
26034 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26035 operator to correctly quote the DN for authentication. However, the basic
26036 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26037 correct one to use for the password, because quoting is needed only to make
26038 the password conform to the Exim syntax. At the LDAP level, the password is an
26039 uninterpreted string.
26040
26041
26042 .section "Support for different kinds of authentication" "SECID174"
26043 A number of string expansion features are provided for the purpose of
26044 interfacing to different ways of user authentication. These include checking
26045 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26046 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26047 &<<SECTexpcond>>&.
26048
26049
26050
26051
26052 .section "Using plaintext in a client" "SECID175"
26053 .cindex "options" "&(plaintext)& authenticator (client)"
26054 The &(plaintext)& authenticator has two client options:
26055
26056 .option client_ignore_invalid_base64 plaintext boolean false
26057 If the client receives a server prompt that is not a valid base64 string,
26058 authentication is abandoned by default. However, if this option is set true,
26059 the error in the challenge is ignored and the client sends the response as
26060 usual.
26061
26062 .option client_send plaintext string&!! unset
26063 The string is a colon-separated list of authentication data strings. Each
26064 string is independently expanded before being sent to the server. The first
26065 string is sent with the AUTH command; any more strings are sent in response
26066 to prompts from the server. Before each string is expanded, the value of the
26067 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26068 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26069 way. Thus, the prompt that is received in response to sending the first string
26070 (with the AUTH command) can be used in the expansion of the second string, and
26071 so on. If an invalid base64 string is received when
26072 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26073 &$auth$&<&'n'&> variable.
26074
26075 &*Note*&: You cannot use expansion to create multiple strings, because
26076 splitting takes priority and happens first.
26077
26078 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26079 the data, further processing is applied to each string before it is sent. If
26080 there are any single circumflex characters in the string, they are converted to
26081 NULs. Should an actual circumflex be required as data, it must be doubled in
26082 the string.
26083
26084 This is an example of a client configuration that implements the PLAIN
26085 authentication mechanism with a fixed user name and password:
26086 .code
26087 fixed_plain:
26088   driver = plaintext
26089   public_name = PLAIN
26090   client_send = ^username^mysecret
26091 .endd
26092 The lack of colons means that the entire text is sent with the AUTH
26093 command, with the circumflex characters converted to NULs. A similar example
26094 that uses the LOGIN mechanism is:
26095 .code
26096 fixed_login:
26097   driver = plaintext
26098   public_name = LOGIN
26099   client_send = : username : mysecret
26100 .endd
26101 The initial colon means that the first string is empty, so no data is sent with
26102 the AUTH command itself. The remaining strings are sent in response to
26103 prompts.
26104 .ecindex IIDplaiauth1
26105 .ecindex IIDplaiauth2
26106
26107
26108
26109
26110 . ////////////////////////////////////////////////////////////////////////////
26111 . ////////////////////////////////////////////////////////////////////////////
26112
26113 .chapter "The cram_md5 authenticator" "CHID9"
26114 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26115 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26116 .cindex "CRAM-MD5 authentication mechanism"
26117 .cindex "authentication" "CRAM-MD5 mechanism"
26118 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26119 sends a challenge string to the client, and the response consists of a user
26120 name and the CRAM-MD5 digest of the challenge string combined with a secret
26121 string (password) which is known to both server and client. Thus, the secret
26122 is not sent over the network as plain text, which makes this authenticator more
26123 secure than &(plaintext)&. However, the downside is that the secret has to be
26124 available in plain text at either end.
26125
26126
26127 .section "Using cram_md5 as a server" "SECID176"
26128 .cindex "options" "&(cram_md5)& authenticator (server)"
26129 This authenticator has one server option, which must be set to configure the
26130 authenticator as a server:
26131
26132 .option server_secret cram_md5 string&!! unset
26133 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26134 When the server receives the client's response, the user name is placed in
26135 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26136 obtain the password for that user. The server then computes the CRAM-MD5 digest
26137 that the client should have sent, and checks that it received the correct
26138 string. If the expansion of &%server_secret%& is forced to fail, authentication
26139 fails. If the expansion fails for some other reason, a temporary error code is
26140 returned to the client.
26141
26142 For compatibility with previous releases of Exim, the user name is also placed
26143 in &$1$&. However, the use of this variables for this purpose is now
26144 deprecated, as it can lead to confusion in string expansions that also use
26145 numeric variables for other things.
26146
26147 For example, the following authenticator checks that the user name given by the
26148 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26149 user name, authentication fails.
26150 .code
26151 fixed_cram:
26152   driver = cram_md5
26153   public_name = CRAM-MD5
26154   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26155   server_set_id = $auth1
26156 .endd
26157 .vindex "&$authenticated_id$&"
26158 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26159 name in &$authenticated_id$&. A more typical configuration might look up the
26160 secret string in a file, using the user name as the key. For example:
26161 .code
26162 lookup_cram:
26163   driver = cram_md5
26164   public_name = CRAM-MD5
26165   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26166                   {$value}fail}
26167   server_set_id = $auth1
26168 .endd
26169 Note that this expansion explicitly forces failure if the lookup fails
26170 because &$auth1$& contains an unknown user name.
26171
26172 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26173 using the relevant libraries, you need to know the realm to specify in the
26174 lookup and then ask for the &"userPassword"& attribute for that user in that
26175 realm, with:
26176 .code
26177 cyrusless_crammd5:
26178   driver = cram_md5
26179   public_name = CRAM-MD5
26180   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26181                   dbmjz{/etc/sasldb2}{$value}fail}
26182   server_set_id = $auth1
26183 .endd
26184
26185 .section "Using cram_md5 as a client" "SECID177"
26186 .cindex "options" "&(cram_md5)& authenticator (client)"
26187 When used as a client, the &(cram_md5)& authenticator has two options:
26188
26189
26190
26191 .option client_name cram_md5 string&!! "the primary host name"
26192 This string is expanded, and the result used as the user name data when
26193 computing the response to the server's challenge.
26194
26195
26196 .option client_secret cram_md5 string&!! unset
26197 This option must be set for the authenticator to work as a client. Its value is
26198 expanded and the result used as the secret string when computing the response.
26199
26200
26201 .vindex "&$host$&"
26202 .vindex "&$host_address$&"
26203 Different user names and secrets can be used for different servers by referring
26204 to &$host$& or &$host_address$& in the options. Forced failure of either
26205 expansion string is treated as an indication that this authenticator is not
26206 prepared to handle this case. Exim moves on to the next configured client
26207 authenticator. Any other expansion failure causes Exim to give up trying to
26208 send the message to the current server.
26209
26210 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26211 strings, is:
26212 .code
26213 fixed_cram:
26214   driver = cram_md5
26215   public_name = CRAM-MD5
26216   client_name = ph10
26217   client_secret = secret
26218 .endd
26219 .ecindex IIDcramauth1
26220 .ecindex IIDcramauth2
26221
26222
26223
26224 . ////////////////////////////////////////////////////////////////////////////
26225 . ////////////////////////////////////////////////////////////////////////////
26226
26227 .chapter "The cyrus_sasl authenticator" "CHID10"
26228 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26229 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26230 .cindex "Cyrus" "SASL library"
26231 .cindex "Kerberos"
26232 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26233 Digital Ltd (&url(http://www.aldigital.co.uk)).
26234
26235 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26236 library implementation of the RFC 2222 (&"Simple Authentication and Security
26237 Layer"&). This library supports a number of authentication mechanisms,
26238 including PLAIN and LOGIN, but also several others that Exim does not support
26239 directly. In particular, there is support for Kerberos authentication.
26240
26241 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26242 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26243 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26244 name of the driver to determine which mechanism to support.
26245
26246 Where access to some kind of secret file is required, for example in GSSAPI
26247 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26248 user, and that the Cyrus SASL library has no way of escalating privileges
26249 by default. You may also find you need to set environment variables,
26250 depending on the driver you are using.
26251
26252 The application name provided by Exim is &"exim"&, so various SASL options may
26253 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26254 Kerberos, note that because of limitations in the GSSAPI interface,
26255 changing the server keytab might need to be communicated down to the Kerberos
26256 layer independently. The mechanism for doing so is dependent upon the Kerberos
26257 implementation.
26258
26259 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26260 may be set to point to an alternative keytab file. Exim will pass this
26261 variable through from its own inherited environment when started as root or the
26262 Exim user. The keytab file needs to be readable by the Exim user.
26263 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26264 environment variable.  In practice, for those releases, the Cyrus authenticator
26265 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26266 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26267
26268
26269 .section "Using cyrus_sasl as a server" "SECID178"
26270 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26271 (on a successful authentication) into &$auth1$&. For compatibility with
26272 previous releases of Exim, the username is also placed in &$1$&. However, the
26273 use of this variable for this purpose is now deprecated, as it can lead to
26274 confusion in string expansions that also use numeric variables for other
26275 things.
26276
26277
26278 .option server_hostname cyrus_sasl string&!! "see below"
26279 This option selects the hostname that is used when communicating with the
26280 library. The default value is &`$primary_hostname`&. It is up to the underlying
26281 SASL plug-in what it does with this data.
26282
26283
26284 .option server_mech cyrus_sasl string "see below"
26285 This option selects the authentication mechanism this driver should use. The
26286 default is the value of the generic &%public_name%& option. This option allows
26287 you to use a different underlying mechanism from the advertised name. For
26288 example:
26289 .code
26290 sasl:
26291   driver = cyrus_sasl
26292   public_name = X-ANYTHING
26293   server_mech = CRAM-MD5
26294   server_set_id = $auth1
26295 .endd
26296
26297 .option server_realm cyrus_sasl string&!! unset
26298 This specifies the SASL realm that the server claims to be in.
26299
26300
26301 .option server_service cyrus_sasl string &`smtp`&
26302 This is the SASL service that the server claims to implement.
26303
26304
26305 For straightforward cases, you do not need to set any of the authenticator's
26306 private options. All you need to do is to specify an appropriate mechanism as
26307 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26308 PLAIN, you could have two authenticators as follows:
26309 .code
26310 sasl_cram_md5:
26311   driver = cyrus_sasl
26312   public_name = CRAM-MD5
26313   server_set_id = $auth1
26314
26315 sasl_plain:
26316   driver = cyrus_sasl
26317   public_name = PLAIN
26318   server_set_id = $auth2
26319 .endd
26320 Cyrus SASL does implement the LOGIN authentication method, even though it is
26321 not a standard method. It is disabled by default in the source distribution,
26322 but it is present in many binary distributions.
26323 .ecindex IIDcyrauth1
26324 .ecindex IIDcyrauth2
26325
26326
26327
26328
26329 . ////////////////////////////////////////////////////////////////////////////
26330 . ////////////////////////////////////////////////////////////////////////////
26331 .chapter "The dovecot authenticator" "CHAPdovecot"
26332 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26333 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26334 This authenticator is an interface to the authentication facility of the
26335 Dovecot POP/IMAP server, which can support a number of authentication methods.
26336 Note that Dovecot must be configured to use auth-client not auth-userdb.
26337 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26338 to use the same mechanisms for SMTP authentication. This is a server
26339 authenticator only. There is only one option:
26340
26341 .option server_socket dovecot string unset
26342
26343 This option must specify the socket that is the interface to Dovecot
26344 authentication. The &%public_name%& option must specify an authentication
26345 mechanism that Dovecot is configured to support. You can have several
26346 authenticators for different mechanisms. For example:
26347 .code
26348 dovecot_plain:
26349   driver = dovecot
26350   public_name = PLAIN
26351   server_socket = /var/run/dovecot/auth-client
26352   server_set_id = $auth1
26353
26354 dovecot_ntlm:
26355   driver = dovecot
26356   public_name = NTLM
26357   server_socket = /var/run/dovecot/auth-client
26358   server_set_id = $auth1
26359 .endd
26360 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26361 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26362 option is passed in the Dovecot authentication command. If, for a TLS
26363 connection, a client certificate has been verified, the &"valid-client-cert"&
26364 option is passed. When authentication succeeds, the identity of the user
26365 who authenticated is placed in &$auth1$&.
26366 .ecindex IIDdcotauth1
26367 .ecindex IIDdcotauth2
26368
26369
26370 . ////////////////////////////////////////////////////////////////////////////
26371 . ////////////////////////////////////////////////////////////////////////////
26372 .chapter "The gsasl authenticator" "CHAPgsasl"
26373 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26374 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26375 .cindex "authentication" "GNU SASL"
26376 .cindex "authentication" "SASL"
26377 .cindex "authentication" "EXTERNAL"
26378 .cindex "authentication" "ANONYMOUS"
26379 .cindex "authentication" "PLAIN"
26380 .cindex "authentication" "LOGIN"
26381 .cindex "authentication" "DIGEST-MD5"
26382 .cindex "authentication" "CRAM-MD5"
26383 .cindex "authentication" "SCRAM-SHA-1"
26384 The &(gsasl)& authenticator provides server integration for the GNU SASL
26385 library and the mechanisms it provides.  This is new as of the 4.80 release
26386 and there are a few areas where the library does not let Exim smoothly
26387 scale to handle future authentication mechanisms, so no guarantee can be
26388 made that any particular new authentication mechanism will be supported
26389 without code changes in Exim.
26390
26391
26392 .option server_channelbinding gsasl boolean false
26393 Some authentication mechanisms are able to use external context at both ends
26394 of the session to bind the authentication to that context, and fail the
26395 authentication process if that context differs.  Specifically, some TLS
26396 ciphersuites can provide identifying information about the cryptographic
26397 context.
26398
26399 This means that certificate identity and verification becomes a non-issue,
26400 as a man-in-the-middle attack will cause the correct client and server to
26401 see different identifiers and authentication will fail.
26402
26403 This is currently only supported when using the GnuTLS library.  This is
26404 only usable by mechanisms which support "channel binding"; at time of
26405 writing, that's the SCRAM family.
26406
26407 This defaults off to ensure smooth upgrade across Exim releases, in case
26408 this option causes some clients to start failing.  Some future release
26409 of Exim may switch the default to be true.
26410
26411
26412 .option server_hostname gsasl string&!! "see below"
26413 This option selects the hostname that is used when communicating with the
26414 library. The default value is &`$primary_hostname`&.
26415 Some mechanisms will use this data.
26416
26417
26418 .option server_mech gsasl string "see below"
26419 This option selects the authentication mechanism this driver should use. The
26420 default is the value of the generic &%public_name%& option. This option allows
26421 you to use a different underlying mechanism from the advertised name. For
26422 example:
26423 .code
26424 sasl:
26425   driver = gsasl
26426   public_name = X-ANYTHING
26427   server_mech = CRAM-MD5
26428   server_set_id = $auth1
26429 .endd
26430
26431
26432 .option server_password gsasl string&!! unset
26433 Various mechanisms need access to the cleartext password on the server, so
26434 that proof-of-possession can be demonstrated on the wire, without sending
26435 the password itself.
26436
26437 The data available for lookup varies per mechanism.
26438 In all cases, &$auth1$& is set to the &'authentication id'&.
26439 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26440 if available, else the empty string.
26441 The &$auth3$& variable will always be the &'realm'& if available,
26442 else the empty string.
26443
26444 A forced failure will cause authentication to defer.
26445
26446 If using this option, it may make sense to set the &%server_condition%&
26447 option to be simply "true".
26448
26449
26450 .option server_realm gsasl string&!! unset
26451 This specifies the SASL realm that the server claims to be in.
26452 Some mechanisms will use this data.
26453
26454
26455 .option server_scram_iter gsasl string&!! unset
26456 This option provides data for the SCRAM family of mechanisms.
26457 &$auth1$& is not available at evaluation time.
26458 (This may change, as we receive feedback on use)
26459
26460
26461 .option server_scram_salt gsasl string&!! unset
26462 This option provides data for the SCRAM family of mechanisms.
26463 &$auth1$& is not available at evaluation time.
26464 (This may change, as we receive feedback on use)
26465
26466
26467 .option server_service gsasl string &`smtp`&
26468 This is the SASL service that the server claims to implement.
26469 Some mechanisms will use this data.
26470
26471
26472 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26473 .vindex "&$auth1$&, &$auth2$&, etc"
26474 These may be set when evaluating specific options, as detailed above.
26475 They will also be set when evaluating &%server_condition%&.
26476
26477 Unless otherwise stated below, the &(gsasl)& integration will use the following
26478 meanings for these variables:
26479
26480 .ilist
26481 .vindex "&$auth1$&"
26482 &$auth1$&: the &'authentication id'&
26483 .next
26484 .vindex "&$auth2$&"
26485 &$auth2$&: the &'authorization id'&
26486 .next
26487 .vindex "&$auth3$&"
26488 &$auth3$&: the &'realm'&
26489 .endlist
26490
26491 On a per-mechanism basis:
26492
26493 .ilist
26494 .cindex "authentication" "EXTERNAL"
26495 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26496 the &%server_condition%& option must be present.
26497 .next
26498 .cindex "authentication" "ANONYMOUS"
26499 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26500 the &%server_condition%& option must be present.
26501 .next
26502 .cindex "authentication" "GSSAPI"
26503 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26504 &$auth2$& will be set to the &'authorization id'&,
26505 the &%server_condition%& option must be present.
26506 .endlist
26507
26508 An &'anonymous token'& is something passed along as an unauthenticated
26509 identifier; this is analogous to FTP anonymous authentication passing an
26510 email address, or software-identifier@, as the "password".
26511
26512
26513 An example showing the password having the realm specified in the callback
26514 and demonstrating a Cyrus SASL to GSASL migration approach is:
26515 .code
26516 gsasl_cyrusless_crammd5:
26517   driver = gsasl
26518   public_name = CRAM-MD5
26519   server_realm = imap.example.org
26520   server_password = ${lookup{$auth1:$auth3:userPassword}\
26521                     dbmjz{/etc/sasldb2}{$value}fail}
26522   server_set_id = ${quote:$auth1}
26523   server_condition = yes
26524 .endd
26525
26526
26527 . ////////////////////////////////////////////////////////////////////////////
26528 . ////////////////////////////////////////////////////////////////////////////
26529
26530 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26531 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26532 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26533 .cindex "authentication" "GSSAPI"
26534 .cindex "authentication" "Kerberos"
26535 The &(heimdal_gssapi)& authenticator provides server integration for the
26536 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26537 reliably.
26538
26539 .option server_hostname heimdal_gssapi string&!! "see below"
26540 This option selects the hostname that is used, with &%server_service%&,
26541 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26542 identifier.  The default value is &`$primary_hostname`&.
26543
26544 .option server_keytab heimdal_gssapi string&!! unset
26545 If set, then Heimdal will not use the system default keytab (typically
26546 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26547 The value should be a pathname, with no &"file:"& prefix.
26548
26549 .option server_service heimdal_gssapi string&!! "smtp"
26550 This option specifies the service identifier used, in conjunction with
26551 &%server_hostname%&, for building the identifier for finding credentials
26552 from the keytab.
26553
26554
26555 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26556 Beware that these variables will typically include a realm, thus will appear
26557 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26558 not verified, so a malicious client can set it to anything.
26559
26560 The &$auth1$& field should be safely trustable as a value from the Key
26561 Distribution Center.  Note that these are not quite email addresses.
26562 Each identifier is for a role, and so the left-hand-side may include a
26563 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26564
26565 .vindex "&$auth1$&, &$auth2$&, etc"
26566 .ilist
26567 .vindex "&$auth1$&"
26568 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26569 .next
26570 .vindex "&$auth2$&"
26571 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26572 authentication.  If that was empty, this will also be set to the
26573 GSS Display Name.
26574 .endlist
26575
26576
26577 . ////////////////////////////////////////////////////////////////////////////
26578 . ////////////////////////////////////////////////////////////////////////////
26579
26580 .chapter "The spa authenticator" "CHAPspa"
26581 .scindex IIDspaauth1 "&(spa)& authenticator"
26582 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26583 .cindex "authentication" "Microsoft Secure Password"
26584 .cindex "authentication" "NTLM"
26585 .cindex "Microsoft Secure Password Authentication"
26586 .cindex "NTLM authentication"
26587 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26588 Password Authentication'& mechanism,
26589 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26590 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26591 taken from the Samba project (&url(http://www.samba.org)). The code for the
26592 server side was subsequently contributed by Tom Kistner. The mechanism works as
26593 follows:
26594
26595 .ilist
26596 After the AUTH command has been accepted, the client sends an SPA
26597 authentication request based on the user name and optional domain.
26598 .next
26599 The server sends back a challenge.
26600 .next
26601 The client builds a challenge response which makes use of the user's password
26602 and sends it to the server, which then accepts or rejects it.
26603 .endlist
26604
26605 Encryption is used to protect the password in transit.
26606
26607
26608
26609 .section "Using spa as a server" "SECID179"
26610 .cindex "options" "&(spa)& authenticator (server)"
26611 The &(spa)& authenticator has just one server option:
26612
26613 .option server_password spa string&!! unset
26614 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26615 This option is expanded, and the result must be the cleartext password for the
26616 authenticating user, whose name is at this point in &$auth1$&. For
26617 compatibility with previous releases of Exim, the user name is also placed in
26618 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26619 it can lead to confusion in string expansions that also use numeric variables
26620 for other things. For example:
26621 .code
26622 spa:
26623   driver = spa
26624   public_name = NTLM
26625   server_password = \
26626     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26627 .endd
26628 If the expansion is forced to fail, authentication fails. Any other expansion
26629 failure causes a temporary error code to be returned.
26630
26631
26632
26633
26634
26635 .section "Using spa as a client" "SECID180"
26636 .cindex "options" "&(spa)& authenticator (client)"
26637 The &(spa)& authenticator has the following client options:
26638
26639
26640
26641 .option client_domain spa string&!! unset
26642 This option specifies an optional domain for the authentication.
26643
26644
26645 .option client_password spa string&!! unset
26646 This option specifies the user's password, and must be set.
26647
26648
26649 .option client_username spa string&!! unset
26650 This option specifies the user name, and must be set. Here is an example of a
26651 configuration of this authenticator for use with the mail servers at
26652 &'msn.com'&:
26653 .code
26654 msn:
26655   driver = spa
26656   public_name = MSN
26657   client_username = msn/msn_username
26658   client_password = msn_plaintext_password
26659   client_domain = DOMAIN_OR_UNSET
26660 .endd
26661 .ecindex IIDspaauth1
26662 .ecindex IIDspaauth2
26663
26664
26665
26666
26667
26668 . ////////////////////////////////////////////////////////////////////////////
26669 . ////////////////////////////////////////////////////////////////////////////
26670
26671 .chapter "The tls authenticator" "CHAPtlsauth"
26672 .scindex IIDtlsauth1 "&(tls)& authenticator"
26673 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26674 .cindex "authentication" "Client Certificate"
26675 .cindex "authentication" "X509"
26676 .cindex "Certificate-based authentication"
26677 The &(tls)& authenticator provides server support for
26678 authentication based on client certificates.
26679
26680 It is not an SMTP authentication mechanism and is not
26681 advertised by the server as part of the SMTP EHLO response.
26682 It is an Exim authenticator in the sense that it affects
26683 the protocol element of the log line, can be tested for
26684 by the &%authenticated%& ACL condition, and can set
26685 the &$authenticated_id$& variable.
26686
26687 The client must present a verifiable certificate,
26688 for which it must have been requested via the
26689 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26690 (see &<<CHAPTLS>>&).
26691
26692 If an authenticator of this type is configured it is
26693 run before any SMTP-level communication is done,
26694 and can authenticate the connection.
26695 If it does, SMTP authentication is not offered.
26696
26697 A maximum of one authenticator of this type may be present.
26698
26699
26700 .cindex "options" "&(tls)& authenticator (server)"
26701 The &(tls)& authenticator has three server options:
26702
26703 .option server_param1 tls string&!! unset
26704 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26705 This option is expanded after the TLS negotiation and
26706 the result is placed in &$auth1$&.
26707 If the expansion is forced to fail, authentication fails. Any other expansion
26708 failure causes a temporary error code to be returned.
26709
26710 .option server_param2 tls string&!! unset
26711 .option server_param3 tls string&!! unset
26712 As above, for &$auth2$& and &$auth3$&.
26713
26714 &%server_param1%& may also be spelled &%server_param%&.
26715
26716
26717 Example:
26718 .code
26719 tls:
26720   driver = tls
26721   server_param1 =     ${certextract {subj_altname,mail,>:} \
26722                                     {$tls_in_peercert}}
26723   server_condition =  ${if forany {$auth1} \
26724                             {!= {0} \
26725                                 {${lookup ldap{ldap:///\
26726                          mailname=${quote_ldap_dn:${lc:$item}},\
26727                          ou=users,LDAP_DC?mailid} {$value}{0} \
26728                        }    }   } }
26729   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26730 .endd
26731 This accepts a client certificate that is verifiable against any
26732 of your configured trust-anchors
26733 which usually means the full set of public CAs)
26734 and which has a SAN with a good account name.
26735 Note that the client cert is on the wire in-clear, including the SAN,
26736 whereas a plaintext SMTP AUTH done inside TLS is not.
26737
26738 . An alternative might use
26739 . .code
26740 .   server_param1 = ${sha256:$tls_in_peercert}
26741 . .endd
26742 . to require one of a set of specific certs that define a given account
26743 . (the verification is still required, but mostly irrelevant).
26744 . This would help for per-device use.
26745 .
26746 . However, for the future we really need support for checking a
26747 . user cert in LDAP - which probably wants a base-64 DER.
26748
26749 .ecindex IIDtlsauth1
26750 .ecindex IIDtlsauth2
26751
26752
26753 Note that because authentication is traditionally an SMTP operation,
26754 the &%authenticated%& ACL condition cannot be used in
26755 a connect- or helo-ACL.
26756
26757
26758
26759 . ////////////////////////////////////////////////////////////////////////////
26760 . ////////////////////////////////////////////////////////////////////////////
26761
26762 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26763          "Encrypted SMTP connections"
26764 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26765 .scindex IIDencsmtp2 "SMTP" "encryption"
26766 .cindex "TLS" "on SMTP connection"
26767 .cindex "OpenSSL"
26768 .cindex "GnuTLS"
26769 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26770 Sockets Layer), is implemented by making use of the OpenSSL library or the
26771 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26772 cryptographic code in the Exim distribution itself for implementing TLS. In
26773 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26774 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26775 You also need to understand the basic concepts of encryption at a managerial
26776 level, and in particular, the way that public keys, private keys, and
26777 certificates are used.
26778
26779 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26780 connection is established, the client issues a STARTTLS command. If the
26781 server accepts this, the client and the server negotiate an encryption
26782 mechanism. If the negotiation succeeds, the data that subsequently passes
26783 between them is encrypted.
26784
26785 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26786 and if so, what cipher suite is in use, whether the client supplied a
26787 certificate, and whether or not that certificate was verified. This makes it
26788 possible for an Exim server to deny or accept certain commands based on the
26789 encryption state.
26790
26791 &*Warning*&: Certain types of firewall and certain anti-virus products can
26792 disrupt TLS connections. You need to turn off SMTP scanning for these products
26793 in order to get TLS to work.
26794
26795
26796
26797 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26798          "SECID284"
26799 .cindex "ssmtp protocol"
26800 .cindex "smtps protocol"
26801 .cindex "SMTP" "ssmtp protocol"
26802 .cindex "SMTP" "smtps protocol"
26803 Early implementations of encrypted SMTP used a different TCP port from normal
26804 SMTP, and expected an encryption negotiation to start immediately, instead of
26805 waiting for a STARTTLS command from the client using the standard SMTP
26806 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26807 allocated for this purpose.
26808
26809 This approach was abandoned when encrypted SMTP was standardized, but there are
26810 still some legacy clients that use it. Exim supports these clients by means of
26811 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26812 numbers; the most common use is expected to be:
26813 .code
26814 tls_on_connect_ports = 465
26815 .endd
26816 The port numbers specified by this option apply to all SMTP connections, both
26817 via the daemon and via &'inetd'&. You still need to specify all the ports that
26818 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26819 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26820 an extra port &-- rather, it specifies different behaviour on a port that is
26821 defined elsewhere.
26822
26823 There is also a &%-tls-on-connect%& command line option. This overrides
26824 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26825
26826
26827
26828
26829
26830
26831 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26832 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26833 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26834 followed later, when the first versions of GnuTLS were released. To build Exim
26835 to use GnuTLS, you need to set
26836 .code
26837 USE_GNUTLS=yes
26838 .endd
26839 in Local/Makefile, in addition to
26840 .code
26841 SUPPORT_TLS=yes
26842 .endd
26843 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26844 include files and libraries for GnuTLS can be found.
26845
26846 There are some differences in usage when using GnuTLS instead of OpenSSL:
26847
26848 .ilist
26849 The &%tls_verify_certificates%& option
26850 cannot be the path of a directory
26851 for GnuTLS versions before 3.3.6
26852 (for later versions, or OpenSSL, it can be either).
26853 .next
26854 The default value for &%tls_dhparam%& differs for historical reasons.
26855 .next
26856 .vindex "&$tls_in_peerdn$&"
26857 .vindex "&$tls_out_peerdn$&"
26858 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26859 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26860 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26861 .next
26862 OpenSSL identifies cipher suites using hyphens as separators, for example:
26863 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26864 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26865 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26866 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26867 to handle its own older variants) when processing lists of cipher suites in the
26868 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26869 option).
26870 .next
26871 The &%tls_require_ciphers%& options operate differently, as described in the
26872 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26873 .next
26874 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26875 When using OpenSSL, this option is ignored.
26876 (If an API is found to let OpenSSL be configured in this way,
26877 let the Exim Maintainers know and we'll likely use it).
26878 .next
26879 Some other recently added features may only be available in one or the other.
26880 This should be documented with the feature.  If the documentation does not
26881 explicitly state that the feature is infeasible in the other TLS
26882 implementation, then patches are welcome.
26883 .endlist
26884
26885
26886 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26887 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26888 an explicit path; if the latter, then the text about generation still applies,
26889 but not the chosen filename.
26890 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26891 See the documentation of &%tls_dhparam%& for more information.
26892
26893 GnuTLS uses D-H parameters that may take a substantial amount of time
26894 to compute. It is unreasonable to re-compute them for every TLS session.
26895 Therefore, Exim keeps this data in a file in its spool directory, called
26896 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26897 of bits requested.
26898 The file is owned by the Exim user and is readable only by
26899 its owner. Every Exim process that start up GnuTLS reads the D-H
26900 parameters from this file. If the file does not exist, the first Exim process
26901 that needs it computes the data and writes it to a temporary file which is
26902 renamed once it is complete. It does not matter if several Exim processes do
26903 this simultaneously (apart from wasting a few resources). Once a file is in
26904 place, new Exim processes immediately start using it.
26905
26906 For maximum security, the parameters that are stored in this file should be
26907 recalculated periodically, the frequency depending on your paranoia level.
26908 If you are avoiding using the fixed D-H primes published in RFCs, then you
26909 are concerned about some advanced attacks and will wish to do this; if you do
26910 not regenerate then you might as well stick to the standard primes.
26911
26912 Arranging this is easy in principle; just delete the file when you want new
26913 values to be computed. However, there may be a problem. The calculation of new
26914 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26915 If the system is not very active, &_/dev/random_& may delay returning data
26916 until enough randomness (entropy) is available. This may cause Exim to hang for
26917 a substantial amount of time, causing timeouts on incoming connections.
26918
26919 The solution is to generate the parameters externally to Exim. They are stored
26920 in &_gnutls-params-N_& in PEM format, which means that they can be
26921 generated externally using the &(certtool)& command that is part of GnuTLS.
26922
26923 To replace the parameters with new ones, instead of deleting the file
26924 and letting Exim re-create it, you can generate new parameters using
26925 &(certtool)& and, when this has been done, replace Exim's cache file by
26926 renaming. The relevant commands are something like this:
26927 .code
26928 # ls
26929 [ look for file; assume gnutls-params-2236 is the most recent ]
26930 # rm -f new-params
26931 # touch new-params
26932 # chown exim:exim new-params
26933 # chmod 0600 new-params
26934 # certtool --generate-dh-params --bits 2236 >>new-params
26935 # openssl dhparam -noout -text -in new-params | head
26936 [ check the first line, make sure it's not more than 2236;
26937   if it is, then go back to the start ("rm") and repeat
26938   until the size generated is at most the size requested ]
26939 # chmod 0400 new-params
26940 # mv new-params gnutls-params-2236
26941 .endd
26942 If Exim never has to generate the parameters itself, the possibility of
26943 stalling is removed.
26944
26945 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26946 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26947 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26948 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26949 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26950 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26951 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26952 which applies to all D-H usage, client or server.  If the value returned by
26953 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26954 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26955 limit, which is still much higher than Exim historically used.
26956
26957 The filename and bits used will change as the GnuTLS maintainers change the
26958 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26959 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26960 2432 bits, while NSS is limited to 2236 bits.
26961
26962 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26963 increase the chance of the generated prime actually being within acceptable
26964 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26965 procedure above.  There is no sane procedure available to Exim to double-check
26966 the size of the generated prime, so it might still be too large.
26967
26968
26969 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26970 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26971 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26972 There is a function in the OpenSSL library that can be passed a list of cipher
26973 suites before the cipher negotiation takes place. This specifies which ciphers
26974 are acceptable. The list is colon separated and may contain names like
26975 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26976 directly to this function call.
26977 Many systems will install the OpenSSL manual-pages, so you may have
26978 &'ciphers(1)'& available to you.
26979 The following quotation from the OpenSSL
26980 documentation specifies what forms of item are allowed in the cipher string:
26981
26982 .ilist
26983 It can consist of a single cipher suite such as RC4-SHA.
26984 .next
26985 It can represent a list of cipher suites containing a certain algorithm,
26986 or cipher suites of a certain type. For example SHA1 represents all
26987 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26988 SSL v3 algorithms.
26989 .next
26990 Lists of cipher suites can be combined in a single cipher string using
26991 the + character. This is used as a logical and operation. For example
26992 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26993 algorithms.
26994 .endlist
26995
26996 Each cipher string can be optionally preceded by one of the characters &`!`&,
26997 &`-`& or &`+`&.
26998 .ilist
26999 If &`!`& is used, the ciphers are permanently deleted from the list. The
27000 ciphers deleted can never reappear in the list even if they are explicitly
27001 stated.
27002 .next
27003 If &`-`& is used, the ciphers are deleted from the list, but some or all
27004 of the ciphers can be added again by later options.
27005 .next
27006 If &`+`& is used, the ciphers are moved to the end of the list. This
27007 option does not add any new ciphers; it just moves matching existing ones.
27008 .endlist
27009
27010 If none of these characters is present, the string is interpreted as
27011 a list of ciphers to be appended to the current preference list. If the list
27012 includes any ciphers already present they will be ignored: that is, they will
27013 not be moved to the end of the list.
27014 .endlist
27015
27016 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27017 string:
27018 .code
27019 # note single-quotes to get ! past any shell history expansion
27020 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27021 .endd
27022
27023 This example will let the library defaults be permitted on the MX port, where
27024 there's probably no identity verification anyway, but ups the ante on the
27025 submission ports where the administrator might have some influence on the
27026 choice of clients used:
27027 .code
27028 # OpenSSL variant; see man ciphers(1)
27029 tls_require_ciphers = ${if =={$received_port}{25}\
27030                            {DEFAULT}\
27031                            {HIGH:!MD5:!SHA1}}
27032 .endd
27033
27034
27035
27036 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27037          "SECTreqciphgnu"
27038 .cindex "GnuTLS" "specifying parameters for"
27039 .cindex "TLS" "specifying ciphers (GnuTLS)"
27040 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27041 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27042 .cindex "TLS" "specifying protocols (GnuTLS)"
27043 .cindex "TLS" "specifying priority string (GnuTLS)"
27044 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27045 The GnuTLS library allows the caller to provide a "priority string", documented
27046 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27047 ciphersuite specification in OpenSSL.
27048
27049 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27050 and controls both protocols and ciphers.
27051
27052 The &%tls_require_ciphers%& option is available both as an global option,
27053 controlling how Exim behaves as a server, and also as an option of the
27054 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27055 the value is string expanded.  The resulting string is not an Exim list and
27056 the string is given to the GnuTLS library, so that Exim does not need to be
27057 aware of future feature enhancements of GnuTLS.
27058
27059 Documentation of the strings accepted may be found in the GnuTLS manual, under
27060 "Priority strings".  This is online as
27061 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27062 but beware that this relates to GnuTLS 3, which may be newer than the version
27063 installed on your system.  If you are using GnuTLS 3,
27064 then the example code
27065 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27066 on that site can be used to test a given string.
27067
27068 For example:
27069 .code
27070 # Disable older versions of protocols
27071 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27072 .endd
27073
27074 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27075 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27076 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27077
27078 This example will let the library defaults be permitted on the MX port, where
27079 there's probably no identity verification anyway, and lowers security further
27080 by increasing compatibility; but this ups the ante on the submission ports
27081 where the administrator might have some influence on the choice of clients
27082 used:
27083 .code
27084 # GnuTLS variant
27085 tls_require_ciphers = ${if =={$received_port}{25}\
27086                            {NORMAL:%COMPAT}\
27087                            {SECURE128}}
27088 .endd
27089
27090
27091 .section "Configuring an Exim server to use TLS" "SECID182"
27092 .cindex "TLS" "configuring an Exim server"
27093 When Exim has been built with TLS support, it advertises the availability of
27094 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27095 but not to any others. The default value of this option is unset, which means
27096 that STARTTLS is not advertised at all. This default is chosen because you
27097 need to set some other options in order to make TLS available, and also it is
27098 sensible for systems that want to use TLS only as a client.
27099
27100 If a client issues a STARTTLS command and there is some configuration
27101 problem in the server, the command is rejected with a 454 error. If the client
27102 persists in trying to issue SMTP commands, all except QUIT are rejected
27103 with the error
27104 .code
27105 554 Security failure
27106 .endd
27107 If a STARTTLS command is issued within an existing TLS session, it is
27108 rejected with a 554 error code.
27109
27110 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27111 must be set to match some hosts. The default is * which matches all hosts.
27112
27113 .new
27114 If this is all you do, TLS encryption will be enabled but not authentication -
27115 meaning that the peer has no assurance it is actually you he is talking to.
27116 You gain protection from a passive sniffer listening on the wire but not
27117 from someone able to intercept the communication.
27118 .wen
27119
27120 Further protection requires some further configuration at the server end.
27121
27122 It is rumoured that all existing clients that support TLS/SSL use RSA
27123 encryption. To make this work you need to set, in the server,
27124 .code
27125 tls_certificate = /some/file/name
27126 tls_privatekey = /some/file/name
27127 .endd
27128 These options are, in fact, expanded strings, so you can make them depend on
27129 the identity of the client that is connected if you wish. The first file
27130 contains the server's X509 certificate, and the second contains the private key
27131 that goes with it. These files need to be
27132 PEM format and readable by the Exim user, and must
27133 always be given as full path names.
27134 The key must not be password-protected.
27135 They can be the same file if both the
27136 certificate and the key are contained within it. If &%tls_privatekey%& is not
27137 set, or if its expansion is forced to fail or results in an empty string, this
27138 is assumed to be the case. The certificate file may also contain intermediate
27139 certificates that need to be sent to the client to enable it to authenticate
27140 the server's certificate.
27141
27142 If you do not understand about certificates and keys, please try to find a
27143 source of this background information, which is not Exim-specific. (There are a
27144 few comments below in section &<<SECTcerandall>>&.)
27145
27146 &*Note*&: These options do not apply when Exim is operating as a client &--
27147 they apply only in the case of a server. If you need to use a certificate in an
27148 Exim client, you must set the options of the same names in an &(smtp)&
27149 transport.
27150
27151 With just these options, an Exim server will be able to use TLS. It does not
27152 require the client to have a certificate (but see below for how to insist on
27153 this). There is one other option that may be needed in other situations. If
27154 .code
27155 tls_dhparam = /some/file/name
27156 .endd
27157 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27158 with the parameters contained in the file.
27159 Set this to &`none`& to disable use of DH entirely, by making no prime
27160 available:
27161 .code
27162 tls_dhparam = none
27163 .endd
27164 This may also be set to a string identifying a standard prime to be used for
27165 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27166 used is &`ike23`&.  There are a few standard primes available, see the
27167 documentation for &%tls_dhparam%& for the complete list.
27168
27169 See the command
27170 .code
27171 openssl dhparam
27172 .endd
27173 for a way of generating file data.
27174
27175 The strings supplied for these three options are expanded every time a client
27176 host connects. It is therefore possible to use different certificates and keys
27177 for different hosts, if you so wish, by making use of the client's IP address
27178 in &$sender_host_address$& to control the expansion. If a string expansion is
27179 forced to fail, Exim behaves as if the option is not set.
27180
27181 .cindex "cipher" "logging"
27182 .cindex "log" "TLS cipher"
27183 .vindex "&$tls_in_cipher$&"
27184 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27185 an incoming TLS connection. It is included in the &'Received:'& header of an
27186 incoming message (by default &-- you can, of course, change this), and it is
27187 also included in the log line that records a message's arrival, keyed by
27188 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27189 condition can be used to test for specific cipher suites in ACLs.
27190
27191 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27192 can check the name of the cipher suite and vary their actions accordingly. The
27193 cipher suite names vary, depending on which TLS library is being used. For
27194 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27195 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27196 documentation for more details.
27197
27198 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27199 (again depending on the &%tls_cipher%& log selector).
27200
27201
27202 .section "Requesting and verifying client certificates" "SECID183"
27203 .cindex "certificate" "verification of client"
27204 .cindex "TLS" "client certificate verification"
27205 If you want an Exim server to request a certificate when negotiating a TLS
27206 session with a client, you must set either &%tls_verify_hosts%& or
27207 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27208 apply to all TLS connections. For any host that matches one of these options,
27209 Exim requests a certificate as part of the setup of the TLS session. The
27210 contents of the certificate are verified by comparing it with a list of
27211 expected certificates.
27212 These may be the system default set (depending on library version),
27213 an explicit file or,
27214 depending on library version, a directory, identified by
27215 &%tls_verify_certificates%&.
27216
27217 A file can contain multiple certificates, concatenated end to end. If a
27218 directory is used
27219 (OpenSSL only),
27220 each certificate must be in a separate file, with a name (or a symbolic link)
27221 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27222 certificate. You can compute the relevant hash by running the command
27223 .code
27224 openssl x509 -hash -noout -in /cert/file
27225 .endd
27226 where &_/cert/file_& contains a single certificate.
27227
27228 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27229 what happens if the client does not supply a certificate, or if the certificate
27230 does not match any of the certificates in the collection named by
27231 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27232 attempt to set up a TLS session is aborted, and the incoming connection is
27233 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27234 session continues. ACLs that run for subsequent SMTP commands can detect the
27235 fact that no certificate was verified, and vary their actions accordingly. For
27236 example, you can insist on a certificate before accepting a message for
27237 relaying, but not when the message is destined for local delivery.
27238
27239 .vindex "&$tls_in_peerdn$&"
27240 When a client supplies a certificate (whether it verifies or not), the value of
27241 the Distinguished Name of the certificate is made available in the variable
27242 &$tls_in_peerdn$& during subsequent processing of the message.
27243
27244 .cindex "log" "distinguished name"
27245 Because it is often a long text string, it is not included in the log line or
27246 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27247 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27248 &%received_header_text%& to change the &'Received:'& header. When no
27249 certificate is supplied, &$tls_in_peerdn$& is empty.
27250
27251
27252 .section "Revoked certificates" "SECID184"
27253 .cindex "TLS" "revoked certificates"
27254 .cindex "revocation list"
27255 .cindex "certificate" "revocation list"
27256 .cindex "OCSP" "stapling"
27257 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27258 certificates are revoked. If you have such a list, you can pass it to an Exim
27259 server using the global option called &%tls_crl%& and to an Exim client using
27260 an identically named option for the &(smtp)& transport. In each case, the value
27261 of the option is expanded and must then be the name of a file that contains a
27262 CRL in PEM format.
27263 The downside is that clients have to periodically re-download a potentially huge
27264 file from every certificate authority they know of.
27265
27266 The way with most moving parts at query time is Online Certificate
27267 Status Protocol (OCSP), where the client verifies the certificate
27268 against an OCSP server run by the CA.  This lets the CA track all
27269 usage of the certs.  It requires running software with access to the
27270 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27271 is based on HTTP and can be proxied accordingly.
27272
27273 The only widespread OCSP server implementation (known to this writer)
27274 comes as part of OpenSSL and aborts on an invalid request, such as
27275 connecting to the port and then disconnecting.  This requires
27276 re-entering the passphrase each time some random client does this.
27277
27278 The third way is OCSP Stapling; in this, the server using a certificate
27279 issued by the CA periodically requests an OCSP proof of validity from
27280 the OCSP server, then serves it up inline as part of the TLS
27281 negotiation.   This approach adds no extra round trips, does not let the
27282 CA track users, scales well with number of certs issued by the CA and is
27283 resilient to temporary OCSP server failures, as long as the server
27284 starts retrying to fetch an OCSP proof some time before its current
27285 proof expires.  The downside is that it requires server support.
27286
27287 Unless Exim is built with the support disabled,
27288 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27289 support for OCSP stapling is included.
27290
27291 There is a global option called &%tls_ocsp_file%&.
27292 The file specified therein is expected to be in DER format, and contain
27293 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27294 option will be re-expanded for SNI, if the &%tls_certificate%& option
27295 contains &`tls_in_sni`&, as per other TLS options.
27296
27297 Exim does not at this time implement any support for fetching a new OCSP
27298 proof.  The burden is on the administrator to handle this, outside of
27299 Exim.  The file specified should be replaced atomically, so that the
27300 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27301 on each connection, so a new file will be handled transparently on the
27302 next connection.
27303
27304 When built with OpenSSL Exim will check for a valid next update timestamp
27305 in the OCSP proof; if not present, or if the proof has expired, it will be
27306 ignored.
27307
27308 For the client to be able to verify the stapled OCSP the server must
27309 also supply, in its stapled information, any intermediate
27310 certificates for the chain leading to the OCSP proof from the signer
27311 of the server certificate.  There may be zero or one such. These
27312 intermediate certificates should be added to the server OCSP stapling
27313 file named by &%tls_ocsp_file%&.
27314
27315 Note that the proof only covers the terminal server certificate,
27316 not any of the chain from CA to it.
27317
27318 There is no current way to staple a proof for a client certificate.
27319
27320 .code
27321   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27322   OCSP server is supplied.  The server URL may be included in the
27323   server certificate, if the CA is helpful.
27324
27325   One failure mode seen was the OCSP Signer cert expiring before the end
27326   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27327   noted this as invalid overall, but the re-fetch script did not.
27328 .endd
27329
27330
27331
27332
27333 .section "Configuring an Exim client to use TLS" "SECID185"
27334 .cindex "cipher" "logging"
27335 .cindex "log" "TLS cipher"
27336 .cindex "log" "distinguished name"
27337 .cindex "TLS" "configuring an Exim client"
27338 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27339 deliveries as well as to incoming, the latter one causing logging of the
27340 server certificate's DN. The remaining client configuration for TLS is all
27341 within the &(smtp)& transport.
27342
27343 It is not necessary to set any options to have TLS work in the &(smtp)&
27344 transport. If Exim is built with TLS support, and TLS is advertised by a
27345 server, the &(smtp)& transport always tries to start a TLS session. However,
27346 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27347 transport) to a list of server hosts for which TLS should not be used.
27348
27349 If you do not want Exim to attempt to send messages unencrypted when an attempt
27350 to set up an encrypted connection fails in any way, you can set
27351 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27352 those hosts, delivery is always deferred if an encrypted connection cannot be
27353 set up. If there are any other hosts for the address, they are tried in the
27354 usual way.
27355
27356 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27357 the message unencrypted. It always does this if the response to STARTTLS is
27358 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27359 session after a success response code, what happens is controlled by the
27360 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27361 delivery to this host is deferred, and other hosts (if available) are tried. If
27362 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27363 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27364 negotiation fails, Exim closes the current connection (because it is in an
27365 unknown state), opens a new one to the same host, and then tries the delivery
27366 unencrypted.
27367
27368 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27369 transport provide the client with a certificate, which is passed to the server
27370 if it requests it. If the server is Exim, it will request a certificate only if
27371 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27372
27373 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27374 specifies a collection of expected server certificates.
27375 These may be the system default set (depending on library version),
27376 a file or,
27377 depending on library version, a directory,
27378 must name a file or,
27379 for OpenSSL only (not GnuTLS), a directory.
27380 The client verifies the server's certificate
27381 against this collection, taking into account any revoked certificates that are
27382 in the list defined by &%tls_crl%&.
27383 Failure to verify fails the TLS connection unless either of the
27384 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27385
27386 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27387 certificate verification to the listed servers.  Verification either must
27388 or need not succeed respectively.
27389
27390 The &(smtp)& transport has two OCSP-related options:
27391 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27392 is requested and required for the connection to proceed.  The default
27393 value is empty.
27394 &%hosts_request_ocsp%&; a host-list for which (additionally)
27395 a Certificate Status is requested (but not necessarily verified).  The default
27396 value is "*" meaning that requests are made unless configured
27397 otherwise.
27398
27399 The host(s) should also be in &%hosts_require_tls%&, and
27400 &%tls_verify_certificates%& configured for the transport,
27401 for OCSP to be relevant.
27402
27403 If
27404 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27405 list of permitted cipher suites. If either of these checks fails, delivery to
27406 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27407 alternative hosts, if any.
27408
27409  &*Note*&:
27410 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27411 is operating as a client. Exim does not assume that a server certificate (set
27412 by the global options of the same name) should also be used when operating as a
27413 client.
27414
27415 .vindex "&$host$&"
27416 .vindex "&$host_address$&"
27417 All the TLS options in the &(smtp)& transport are expanded before use, with
27418 &$host$& and &$host_address$& containing the name and address of the server to
27419 which the client is connected. Forced failure of an expansion causes Exim to
27420 behave as if the relevant option were unset.
27421
27422 .vindex &$tls_out_bits$&
27423 .vindex &$tls_out_cipher$&
27424 .vindex &$tls_out_peerdn$&
27425 .vindex &$tls_out_sni$&
27426 Before an SMTP connection is established, the
27427 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27428 variables are emptied. (Until the first connection, they contain the values
27429 that were set when the message was received.) If STARTTLS is subsequently
27430 successfully obeyed, these variables are set to the relevant values for the
27431 outgoing connection.
27432
27433
27434
27435 .section "Use of TLS Server Name Indication" "SECTtlssni"
27436 .cindex "TLS" "Server Name Indication"
27437 .vindex "&$tls_in_sni$&"
27438 .oindex "&%tls_in_sni%&"
27439 With TLS1.0 or above, there is an extension mechanism by which extra
27440 information can be included at various points in the protocol.  One of these
27441 extensions, documented in RFC 6066 (and before that RFC 4366) is
27442 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27443 client in the initial handshake, so that the server can examine the servername
27444 within and possibly choose to use different certificates and keys (and more)
27445 for this session.
27446
27447 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27448 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27449 address.
27450
27451 With SMTP to MX, there are the same problems here as in choosing the identity
27452 against which to validate a certificate: you can't rely on insecure DNS to
27453 provide the identity which you then cryptographically verify.  So this will
27454 be of limited use in that environment.
27455
27456 With SMTP to Submission, there is a well-defined hostname which clients are
27457 connecting to and can validate certificates against.  Thus clients &*can*&
27458 choose to include this information in the TLS negotiation.  If this becomes
27459 wide-spread, then hosters can choose to present different certificates to
27460 different clients.  Or even negotiate different cipher suites.
27461
27462 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27463 if not empty, will be sent on a TLS session as part of the handshake.  There's
27464 nothing more to it.  Choosing a sensible value not derived insecurely is the
27465 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27466 for the lifetime of the client connection (including during authentication).
27467
27468 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27469 received from a client.
27470 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27471
27472 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27473 option (prior to expansion) then the following options will be re-expanded
27474 during TLS session handshake, to permit alternative values to be chosen:
27475
27476 .ilist
27477 .vindex "&%tls_certificate%&"
27478 &%tls_certificate%&
27479 .next
27480 .vindex "&%tls_crl%&"
27481 &%tls_crl%&
27482 .next
27483 .vindex "&%tls_privatekey%&"
27484 &%tls_privatekey%&
27485 .next
27486 .vindex "&%tls_verify_certificates%&"
27487 &%tls_verify_certificates%&
27488 .next
27489 .vindex "&%tls_ocsp_file%&"
27490 &%tls_ocsp_file%&
27491 .endlist
27492
27493 Great care should be taken to deal with matters of case, various injection
27494 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27495 can always be referenced; it is important to remember that &$tls_sni$& is
27496 arbitrary unverified data provided prior to authentication.
27497
27498 The Exim developers are proceeding cautiously and so far no other TLS options
27499 are re-expanded.
27500
27501 When Exim is built against OpenSSL, OpenSSL must have been built with support
27502 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27503 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27504 see &`-servername`& in the output, then OpenSSL has support.
27505
27506 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27507 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27508 built, then you have SNI support).
27509
27510
27511
27512 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27513          "SECTmulmessam"
27514 .cindex "multiple SMTP deliveries with TLS"
27515 .cindex "TLS" "multiple message deliveries"
27516 Exim sends multiple messages down the same TCP/IP connection by starting up
27517 an entirely new delivery process for each message, passing the socket from
27518 one process to the next. This implementation does not fit well with the use
27519 of TLS, because there is quite a lot of state information associated with a TLS
27520 connection, not just a socket identification. Passing all the state information
27521 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27522 session before passing the socket to a new process. The new process may then
27523 try to start a new TLS session, and if successful, may try to re-authenticate
27524 if AUTH is in use, before sending the next message.
27525
27526 The RFC is not clear as to whether or not an SMTP session continues in clear
27527 after TLS has been shut down, or whether TLS may be restarted again later, as
27528 just described. However, if the server is Exim, this shutdown and
27529 reinitialization works. It is not known which (if any) other servers operate
27530 successfully if the client closes a TLS session and continues with unencrypted
27531 SMTP, but there are certainly some that do not work. For such servers, Exim
27532 should not pass the socket to another process, because the failure of the
27533 subsequent attempt to use it would cause Exim to record a temporary host error,
27534 and delay other deliveries to that host.
27535
27536 To test for this case, Exim sends an EHLO command to the server after
27537 closing down the TLS session. If this fails in any way, the connection is
27538 closed instead of being passed to a new delivery process, but no retry
27539 information is recorded.
27540
27541 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27542 &(smtp)& transport to match those hosts for which Exim should not pass
27543 connections to new processes if TLS has been used.
27544
27545
27546
27547
27548 .section "Certificates and all that" "SECTcerandall"
27549 .cindex "certificate" "references to discussion"
27550 In order to understand fully how TLS works, you need to know about
27551 certificates, certificate signing, and certificate authorities. This is not the
27552 place to give a tutorial, especially as I do not know very much about it
27553 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27554 to Apache, currently at
27555 .display
27556 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27557 .endd
27558 Other parts of the &'modssl'& documentation are also helpful, and have
27559 links to further files.
27560 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27561 0-201-61598-3), contains both introductory and more in-depth descriptions.
27562 Some sample programs taken from the book are available from
27563 .display
27564 &url(http://www.rtfm.com/openssl-examples/)
27565 .endd
27566
27567
27568 .section "Certificate chains" "SECID186"
27569 The file named by &%tls_certificate%& may contain more than one
27570 certificate. This is useful in the case where the certificate that is being
27571 sent is validated by an intermediate certificate which the other end does
27572 not have. Multiple certificates must be in the correct order in the file.
27573 First the host's certificate itself, then the first intermediate
27574 certificate to validate the issuer of the host certificate, then the next
27575 intermediate certificate to validate the issuer of the first intermediate
27576 certificate, and so on, until finally (optionally) the root certificate.
27577 The root certificate must already be trusted by the recipient for
27578 validation to succeed, of course, but if it's not preinstalled, sending the
27579 root certificate along with the rest makes it available for the user to
27580 install if the receiving end is a client MUA that can interact with a user.
27581
27582 Note that certificates using MD5 are unlikely to work on today's Internet;
27583 even if your libraries allow loading them for use in Exim when acting as a
27584 server, increasingly clients will not accept such certificates.  The error
27585 diagnostics in such a case can be frustratingly vague.
27586
27587
27588
27589 .section "Self-signed certificates" "SECID187"
27590 .cindex "certificate" "self-signed"
27591 You can create a self-signed certificate using the &'req'& command provided
27592 with OpenSSL, like this:
27593 . ==== Do not shorten the duration here without reading and considering
27594 . ==== the text below.  Please leave it at 9999 days.
27595 .code
27596 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27597             -days 9999 -nodes
27598 .endd
27599 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27600 delimited and so can be identified independently. The &%-days%& option
27601 specifies a period for which the certificate is valid. The &%-nodes%& option is
27602 important: if you do not set it, the key is encrypted with a passphrase
27603 that you are prompted for, and any use that is made of the key causes more
27604 prompting for the passphrase. This is not helpful if you are going to use
27605 this certificate and key in an MTA, where prompting is not possible.
27606
27607 . ==== I expect to still be working 26 years from now.  The less technical
27608 . ==== debt I create, in terms of storing up trouble for my later years, the
27609 . ==== happier I will be then.  We really have reached the point where we
27610 . ==== should start, at the very least, provoking thought and making folks
27611 . ==== pause before proceeding, instead of leaving all the fixes until two
27612 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27613 . ==== -pdp, 2012
27614 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27615 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27616 the above command might produce a date in the past.  Think carefully about
27617 the lifetime of the systems you're deploying, and either reduce the duration
27618 of the certificate or reconsider your platform deployment.  (At time of
27619 writing, reducing the duration is the most likely choice, but the inexorable
27620 progression of time takes us steadily towards an era where this will not
27621 be a sensible resolution).
27622
27623 A self-signed certificate made in this way is sufficient for testing, and
27624 may be adequate for all your requirements if you are mainly interested in
27625 encrypting transfers, and not in secure identification.
27626
27627 However, many clients require that the certificate presented by the server be a
27628 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27629 certificate. In this situation, the self-signed certificate described above
27630 must be installed on the client host as a trusted root &'certification
27631 authority'& (CA), and the certificate used by Exim must be a user certificate
27632 signed with that self-signed certificate.
27633
27634 For information on creating self-signed CA certificates and using them to sign
27635 user certificates, see the &'General implementation overview'& chapter of the
27636 Open-source PKI book, available online at
27637 &url(http://ospkibook.sourceforge.net/).
27638 .ecindex IIDencsmtp1
27639 .ecindex IIDencsmtp2
27640
27641
27642
27643 . ////////////////////////////////////////////////////////////////////////////
27644 . ////////////////////////////////////////////////////////////////////////////
27645
27646 .chapter "Access control lists" "CHAPACL"
27647 .scindex IIDacl "&ACL;" "description"
27648 .cindex "control of incoming mail"
27649 .cindex "message" "controlling incoming"
27650 .cindex "policy control" "access control lists"
27651 Access Control Lists (ACLs) are defined in a separate section of the run time
27652 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27653 name, terminated by a colon. Here is a complete ACL section that contains just
27654 one very small ACL:
27655 .code
27656 begin acl
27657 small_acl:
27658   accept   hosts = one.host.only
27659 .endd
27660 You can have as many lists as you like in the ACL section, and the order in
27661 which they appear does not matter. The lists are self-terminating.
27662
27663 The majority of ACLs are used to control Exim's behaviour when it receives
27664 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27665 when a local process submits a message using SMTP by specifying the &%-bs%&
27666 option. The most common use is for controlling which recipients are accepted
27667 in incoming messages. In addition, you can define an ACL that is used to check
27668 local non-SMTP messages. The default configuration file contains an example of
27669 a realistic ACL for checking RCPT commands. This is discussed in chapter
27670 &<<CHAPdefconfil>>&.
27671
27672
27673 .section "Testing ACLs" "SECID188"
27674 The &%-bh%& command line option provides a way of testing your ACL
27675 configuration locally by running a fake SMTP session with which you interact.
27676
27677
27678 .section "Specifying when ACLs are used" "SECID189"
27679 .cindex "&ACL;" "options for specifying"
27680 In order to cause an ACL to be used, you have to name it in one of the relevant
27681 options in the main part of the configuration. These options are:
27682 .cindex "AUTH" "ACL for"
27683 .cindex "DATA" "ACLs for"
27684 .cindex "ETRN" "ACL for"
27685 .cindex "EXPN" "ACL for"
27686 .cindex "HELO" "ACL for"
27687 .cindex "EHLO" "ACL for"
27688 .cindex "DKIM" "ACL for"
27689 .cindex "MAIL" "ACL for"
27690 .cindex "QUIT, ACL for"
27691 .cindex "RCPT" "ACL for"
27692 .cindex "STARTTLS, ACL for"
27693 .cindex "VRFY" "ACL for"
27694 .cindex "SMTP" "connection, ACL for"
27695 .cindex "non-SMTP messages" "ACLs for"
27696 .cindex "MIME content scanning" "ACL for"
27697 .cindex "PRDR" "ACL for"
27698
27699 .table2 140pt
27700 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27701 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27702 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27703 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27704 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27705 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27706 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27707 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27708 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27709 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27710 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27711 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27712 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27713 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27714 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27715 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27716 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27717 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27718 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27719 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27720 .endtable
27721
27722 For example, if you set
27723 .code
27724 acl_smtp_rcpt = small_acl
27725 .endd
27726 the little ACL defined above is used whenever Exim receives a RCPT command
27727 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27728 done when RCPT commands arrive. A rejection of RCPT should cause the
27729 sending MTA to give up on the recipient address contained in the RCPT
27730 command, whereas rejection at other times may cause the client MTA to keep on
27731 trying to deliver the message. It is therefore recommended that you do as much
27732 testing as possible at RCPT time.
27733
27734
27735 .section "The non-SMTP ACLs" "SECID190"
27736 .cindex "non-SMTP messages" "ACLs for"
27737 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27738 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27739 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27740 the state of the SMTP connection such as encryption and authentication) are not
27741 relevant and are forbidden in these ACLs. However, the sender and recipients
27742 are known, so the &%senders%& and &%sender_domains%& conditions and the
27743 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27744 &$authenticated_sender$& are also available. You can specify added header lines
27745 in any of these ACLs.
27746
27747 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27748 non-SMTP message, before any of the message has been read. (This is the
27749 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27750 batched SMTP input, it runs after the DATA command has been reached. The
27751 result of this ACL is ignored; it cannot be used to reject a message. If you
27752 really need to, you could set a value in an ACL variable here and reject based
27753 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27754 controls, and in particular, it can be used to set
27755 .code
27756 control = suppress_local_fixups
27757 .endd
27758 This cannot be used in the other non-SMTP ACLs because by the time they are
27759 run, it is too late.
27760
27761 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27762 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27763
27764 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27765 kind of rejection is treated as permanent, because there is no way of sending a
27766 temporary error for these kinds of message.
27767
27768
27769 .section "The SMTP connect ACL" "SECID191"
27770 .cindex "SMTP" "connection, ACL for"
27771 .oindex &%smtp_banner%&
27772 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27773 session, after the test specified by &%host_reject_connection%& (which is now
27774 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27775 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27776 the message override the banner message that is otherwise specified by the
27777 &%smtp_banner%& option.
27778
27779
27780 .section "The EHLO/HELO ACL" "SECID192"
27781 .cindex "EHLO" "ACL for"
27782 .cindex "HELO" "ACL for"
27783 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27784 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27785 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27786 Note that a client may issue more than one EHLO or HELO command in an SMTP
27787 session, and indeed is required to issue a new EHLO or HELO after successfully
27788 setting up encryption following a STARTTLS command.
27789
27790 Note also that a deny neither forces the client to go away nor means that
27791 mail will be refused on the connection.  Consider checking for
27792 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27793
27794 If the command is accepted by an &%accept%& verb that has a &%message%&
27795 modifier, the message may not contain more than one line (it will be truncated
27796 at the first newline and a panic logged if it does). Such a message cannot
27797 affect the EHLO options that are listed on the second and subsequent lines of
27798 an EHLO response.
27799
27800
27801 .section "The DATA ACLs" "SECID193"
27802 .cindex "DATA" "ACLs for"
27803 Two ACLs are associated with the DATA command, because it is two-stage
27804 command, with two responses being sent to the client.
27805 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27806 is obeyed. This gives you control after all the RCPT commands, but before
27807 the message itself is received. It offers the opportunity to give a negative
27808 response to the DATA command before the data is transmitted. Header lines
27809 added by MAIL or RCPT ACLs are not visible at this time, but any that
27810 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27811
27812 You cannot test the contents of the message, for example, to verify addresses
27813 in the headers, at RCPT time or when the DATA command is received. Such
27814 tests have to appear in the ACL that is run after the message itself has been
27815 received, before the final response to the DATA command is sent. This is
27816 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27817 associated with the DATA command.
27818
27819 .new
27820 .cindex CHUNKING "BDAT command"
27821 .cindex BDAT "SMTP command"
27822 .cindex "RFC 3030" CHUNKING
27823 If CHUNKING was advertised and a BDAT command sequence is received,
27824 the &%acl_smtp_predata%& ACL is not run.
27825 . XXX why not?  It should be possible, for the first BDAT.
27826 The &%acl_smtp_data%& is run after the last BDAT command and all of
27827 the data specified is received.
27828 .wen
27829
27830 For both of these ACLs, it is not possible to reject individual recipients. An
27831 error response rejects the entire message. Unfortunately, it is known that some
27832 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27833 before or after the data) correctly &-- they keep the message on their queues
27834 and try again later, but that is their problem, though it does waste some of
27835 your resources.
27836
27837 The &%acl_smtp_data%& ACL is run after
27838 the &%acl_smtp_data_prdr%&,
27839 the &%acl_smtp_dkim%&
27840 and the &%acl_smtp_mime%& ACLs.
27841
27842 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27843 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27844 enabled (which is the default).
27845
27846 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27847 received, and is executed for each DKIM signature found in a message.  If not
27848 otherwise specified, the default action is to accept.
27849
27850 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27851
27852 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27853
27854
27855 .section "The SMTP MIME ACL" "SECID194"
27856 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27857 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27858
27859 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27860
27861
27862 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27863 .cindex "PRDR" "ACL for"
27864 .oindex "&%prdr_enable%&"
27865 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27866 with PRDR support enabled (which is the default).
27867 It becomes active only when the PRDR feature is negotiated between
27868 client and server for a message, and more than one recipient
27869 has been accepted.
27870
27871 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27872 has been received, and is executed once for each recipient of the message
27873 with &$local_part$& and &$domain$& valid.
27874 The test may accept, defer or deny for individual recipients.
27875 The &%acl_smtp_data%& will still be called after this ACL and
27876 can reject the message overall, even if this ACL has accepted it
27877 for some or all recipients.
27878
27879 PRDR may be used to support per-user content filtering.  Without it
27880 one must defer any recipient after the first that has a different
27881 content-filter configuration.  With PRDR, the RCPT-time check
27882 .cindex "PRDR" "variable for"
27883 for this can be disabled when the variable &$prdr_requested$&
27884 is &"yes"&.
27885 Any required difference in behaviour of the main DATA-time
27886 ACL should however depend on the PRDR-time ACL having run, as Exim
27887 will avoid doing so in some situations (e.g.  single-recipient mails).
27888
27889 See also the &%prdr_enable%& global option
27890 and the &%hosts_try_prdr%& smtp transport option.
27891
27892 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27893 If the ACL is not defined, processing completes as if
27894 the feature was not requested by the client.
27895
27896 .section "The QUIT ACL" "SECTQUITACL"
27897 .cindex "QUIT, ACL for"
27898 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27899 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27900 does not in fact control any access.
27901 For this reason, it may only accept
27902 or warn as its final result.
27903
27904 This ACL can be used for tasks such as custom logging at the end of an SMTP
27905 session. For example, you can use ACL variables in other ACLs to count
27906 messages, recipients, etc., and log the totals at QUIT time using one or
27907 more &%logwrite%& modifiers on a &%warn%& verb.
27908
27909 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27910 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27911
27912 You do not need to have a final &%accept%&, but if you do, you can use a
27913 &%message%& modifier to specify custom text that is sent as part of the 221
27914 response to QUIT.
27915
27916 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27917 failure (for example, failure to open a log file, or when Exim is bombing out
27918 because it has detected an unrecoverable error), all SMTP commands from the
27919 client are given temporary error responses until QUIT is received or the
27920 connection is closed. In these special cases, the QUIT ACL does not run.
27921
27922
27923 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27924 .vindex &$acl_smtp_notquit$&
27925 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27926 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27927 trouble, such as being unable to write to its log files, this ACL is not run,
27928 because it might try to do things (such as write to log files) that make the
27929 situation even worse.
27930
27931 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27932 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27933 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27934 and &%warn%&.
27935
27936 .vindex &$smtp_notquit_reason$&
27937 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27938 to a string that indicates the reason for the termination of the SMTP
27939 connection. The possible values are:
27940 .table2
27941 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27942 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27943 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27944 .irow &`connection-lost`&          "The SMTP connection has been lost"
27945 .irow &`data-timeout`&             "Timeout while reading message data"
27946 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27947 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27948 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27949 .irow &`synchronization-error`&    "SMTP synchronization error"
27950 .irow &`tls-failed`&               "TLS failed to start"
27951 .endtable
27952 In most cases when an SMTP connection is closed without having received QUIT,
27953 Exim sends an SMTP response message before actually closing the connection.
27954 With the exception of the &`acl-drop`& case, the default message can be
27955 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27956 &%drop%& verb in another ACL, it is the message from the other ACL that is
27957 used.
27958
27959
27960 .section "Finding an ACL to use" "SECID195"
27961 .cindex "&ACL;" "finding which to use"
27962 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27963 you can use different ACLs in different circumstances. For example,
27964 .code
27965 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27966                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27967 .endd
27968 In the default configuration file there are some example settings for
27969 providing an RFC 4409 message submission service on port 587 and a
27970 non-standard &"smtps"& service on port 465. You can use a string
27971 expansion like this to choose an ACL for MUAs on these ports which is
27972 more appropriate for this purpose than the default ACL on port 25.
27973
27974 The expanded string does not have to be the name of an ACL in the
27975 configuration file; there are other possibilities. Having expanded the
27976 string, Exim searches for an ACL as follows:
27977
27978 .ilist
27979 If the string begins with a slash, Exim uses it as a file name, and reads its
27980 contents as an ACL. The lines are processed in the same way as lines in the
27981 Exim configuration file. In particular, continuation lines are supported, blank
27982 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27983 If the file does not exist or cannot be read, an error occurs (typically
27984 causing a temporary failure of whatever caused the ACL to be run). For example:
27985 .code
27986 acl_smtp_data = /etc/acls/\
27987   ${lookup{$sender_host_address}lsearch\
27988   {/etc/acllist}{$value}{default}}
27989 .endd
27990 This looks up an ACL file to use on the basis of the host's IP address, falling
27991 back to a default if the lookup fails. If an ACL is successfully read from a
27992 file, it is retained in memory for the duration of the Exim process, so that it
27993 can be re-used without having to re-read the file.
27994 .next
27995 If the string does not start with a slash, and does not contain any spaces,
27996 Exim searches the ACL section of the configuration for an ACL whose name
27997 matches the string.
27998 .next
27999 If no named ACL is found, or if the string contains spaces, Exim parses
28000 the string as an inline ACL. This can save typing in cases where you just
28001 want to have something like
28002 .code
28003 acl_smtp_vrfy = accept
28004 .endd
28005 in order to allow free use of the VRFY command. Such a string may contain
28006 newlines; it is processed in the same way as an ACL that is read from a file.
28007 .endlist
28008
28009
28010
28011
28012 .section "ACL return codes" "SECID196"
28013 .cindex "&ACL;" "return codes"
28014 Except for the QUIT ACL, which does not affect the SMTP return code (see
28015 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28016 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28017 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28018 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28019 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28020 This also causes a 4&'xx'& return code.
28021
28022 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28023 &"deny"&, because there is no mechanism for passing temporary errors to the
28024 submitters of non-SMTP messages.
28025
28026
28027 ACLs that are relevant to message reception may also return &"discard"&. This
28028 has the effect of &"accept"&, but causes either the entire message or an
28029 individual recipient address to be discarded. In other words, it is a
28030 blackholing facility. Use it with care.
28031
28032 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28033 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28034 RCPT ACL is to discard just the one recipient address. If there are no
28035 recipients left when the message's data is received, the DATA ACL is not
28036 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28037 remaining recipients. The &"discard"& return is not permitted for the
28038 &%acl_smtp_predata%& ACL.
28039
28040
28041 .cindex "&[local_scan()]& function" "when all recipients discarded"
28042 The &[local_scan()]& function is always run, even if there are no remaining
28043 recipients; it may create new recipients.
28044
28045
28046
28047 .section "Unset ACL options" "SECID197"
28048 .cindex "&ACL;" "unset options"
28049 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28050 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28051 not defined at all. For any defined ACL, the default action when control
28052 reaches the end of the ACL statements is &"deny"&.
28053
28054 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28055 these two are ACLs that are used only for their side effects. They cannot be
28056 used to accept or reject anything.
28057
28058 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28059 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28060 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28061 when the ACL is not defined is &"accept"&.
28062
28063 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28064 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28065 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28066 messages over an SMTP connection. For an example, see the ACL in the default
28067 configuration file.
28068
28069
28070
28071
28072 .section "Data for message ACLs" "SECID198"
28073 .cindex "&ACL;" "data for message ACL"
28074 .vindex &$domain$&
28075 .vindex &$local_part$&
28076 .vindex &$sender_address$&
28077 .vindex &$sender_host_address$&
28078 .vindex &$smtp_command$&
28079 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28080 that contain information about the host and the message's sender (for example,
28081 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28082 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28083 &$local_part$& are set from the argument address. The entire SMTP command
28084 is available in &$smtp_command$&.
28085
28086 When an ACL for the AUTH parameter of MAIL is running, the variables that
28087 contain information about the host are set, but &$sender_address$& is not yet
28088 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28089 how it is used.
28090
28091 .vindex "&$message_size$&"
28092 The &$message_size$& variable is set to the value of the SIZE parameter on
28093 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28094 that parameter is not given. The value is updated to the true message size by
28095 the time the final DATA ACL is run (after the message data has been
28096 received).
28097
28098 .vindex "&$rcpt_count$&"
28099 .vindex "&$recipients_count$&"
28100 The &$rcpt_count$& variable increases by one for each RCPT command received.
28101 The &$recipients_count$& variable increases by one each time a RCPT command is
28102 accepted, so while an ACL for RCPT is being processed, it contains the number
28103 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28104 &$rcpt_count$& contains the total number of RCPT commands, and
28105 &$recipients_count$& contains the total number of accepted recipients.
28106
28107
28108
28109
28110
28111 .section "Data for non-message ACLs" "SECTdatfornon"
28112 .cindex "&ACL;" "data for non-message ACL"
28113 .vindex &$smtp_command_argument$&
28114 .vindex &$smtp_command$&
28115 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28116 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28117 and the entire SMTP command is available in &$smtp_command$&.
28118 These variables can be tested using a &%condition%& condition. For example,
28119 here is an ACL for use with AUTH, which insists that either the session is
28120 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28121 does not permit authentication methods that use cleartext passwords on
28122 unencrypted connections.
28123 .code
28124 acl_check_auth:
28125   accept encrypted = *
28126   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28127                      {CRAM-MD5}}
28128   deny   message   = TLS encryption or CRAM-MD5 required
28129 .endd
28130 (Another way of applying this restriction is to arrange for the authenticators
28131 that use cleartext passwords not to be advertised when the connection is not
28132 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28133 option to do this.)
28134
28135
28136
28137 .section "Format of an ACL" "SECID199"
28138 .cindex "&ACL;" "format of"
28139 .cindex "&ACL;" "verbs, definition of"
28140 An individual ACL consists of a number of statements. Each statement starts
28141 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28142 Modifiers can change the way the verb operates, define error and log messages,
28143 set variables, insert delays, and vary the processing of accepted messages.
28144
28145 If all the conditions are met, the verb is obeyed. The same condition may be
28146 used (with different arguments) more than once in the same statement. This
28147 provides a means of specifying an &"and"& conjunction between conditions. For
28148 example:
28149 .code
28150 deny  dnslists = list1.example
28151       dnslists = list2.example
28152 .endd
28153 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28154 the conditions and modifiers when it reaches a condition that fails. What
28155 happens then depends on the verb (and in one case, on a special modifier). Not
28156 all the conditions make sense at every testing point. For example, you cannot
28157 test a sender address in the ACL that is run for a VRFY command.
28158
28159
28160 .section "ACL verbs" "SECID200"
28161 The ACL verbs are as follows:
28162
28163 .ilist
28164 .cindex "&%accept%& ACL verb"
28165 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28166 of the conditions are not met, what happens depends on whether &%endpass%&
28167 appears among the conditions (for syntax see below). If the failing condition
28168 is before &%endpass%&, control is passed to the next ACL statement; if it is
28169 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28170 check a RCPT command:
28171 .code
28172 accept domains = +local_domains
28173        endpass
28174        verify = recipient
28175 .endd
28176 If the recipient domain does not match the &%domains%& condition, control
28177 passes to the next statement. If it does match, the recipient is verified, and
28178 the command is accepted if verification succeeds. However, if verification
28179 fails, the ACL yields &"deny"&, because the failing condition is after
28180 &%endpass%&.
28181
28182 The &%endpass%& feature has turned out to be confusing to many people, so its
28183 use is not recommended nowadays. It is always possible to rewrite an ACL so
28184 that &%endpass%& is not needed, and it is no longer used in the default
28185 configuration.
28186
28187 .cindex "&%message%& ACL modifier" "with &%accept%&"
28188 If a &%message%& modifier appears on an &%accept%& statement, its action
28189 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28190 (when an &%accept%& verb either accepts or passes control to the next
28191 statement), &%message%& can be used to vary the message that is sent when an
28192 SMTP command is accepted. For example, in a RCPT ACL you could have:
28193 .display
28194 &`accept  `&<&'some conditions'&>
28195 &`        message = OK, I will allow you through today`&
28196 .endd
28197 You can specify an SMTP response code, optionally followed by an &"extended
28198 response code"& at the start of the message, but the first digit must be the
28199 same as would be sent by default, which is 2 for an &%accept%& verb.
28200
28201 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28202 an error message that is used when access is denied. This behaviour is retained
28203 for backward compatibility, but current &"best practice"& is to avoid the use
28204 of &%endpass%&.
28205
28206
28207 .next
28208 .cindex "&%defer%& ACL verb"
28209 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28210 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28211 &%defer%& is the same as &%deny%&, because there is no way of sending a
28212 temporary error. For a RCPT command, &%defer%& is much the same as using a
28213 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28214 be used in any ACL, and even for a recipient it might be a simpler approach.
28215
28216
28217 .next
28218 .cindex "&%deny%& ACL verb"
28219 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28220 the conditions are not met, control is passed to the next ACL statement. For
28221 example,
28222 .code
28223 deny dnslists = blackholes.mail-abuse.org
28224 .endd
28225 rejects commands from hosts that are on a DNS black list.
28226
28227
28228 .next
28229 .cindex "&%discard%& ACL verb"
28230 &%discard%&: This verb behaves like &%accept%&, except that it returns
28231 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28232 that are concerned with receiving messages. When all the conditions are true,
28233 the sending entity receives a &"success"& response. However, &%discard%& causes
28234 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28235 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28236 message's recipients are discarded. Recipients that are discarded before DATA
28237 do not appear in the log line when the &%received_recipients%& log selector is set.
28238
28239 If the &%log_message%& modifier is set when &%discard%& operates,
28240 its contents are added to the line that is automatically written to the log.
28241 The &%message%& modifier operates exactly as it does for &%accept%&.
28242
28243
28244 .next
28245 .cindex "&%drop%& ACL verb"
28246 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28247 forcibly closed after the 5&'xx'& error message has been sent. For example:
28248 .code
28249 drop   message   = I don't take more than 20 RCPTs
28250        condition = ${if > {$rcpt_count}{20}}
28251 .endd
28252 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28253 The connection is always dropped after sending a 550 response.
28254
28255 .next
28256 .cindex "&%require%& ACL verb"
28257 &%require%&: If all the conditions are met, control is passed to the next ACL
28258 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28259 example, when checking a RCPT command,
28260 .code
28261 require message = Sender did not verify
28262         verify  = sender
28263 .endd
28264 passes control to subsequent statements only if the message's sender can be
28265 verified. Otherwise, it rejects the command. Note the positioning of the
28266 &%message%& modifier, before the &%verify%& condition. The reason for this is
28267 discussed in section &<<SECTcondmodproc>>&.
28268
28269 .next
28270 .cindex "&%warn%& ACL verb"
28271 &%warn%&: If all the conditions are true, a line specified by the
28272 &%log_message%& modifier is written to Exim's main log. Control always passes
28273 to the next ACL statement. If any condition is false, the log line is not
28274 written. If an identical log line is requested several times in the same
28275 message, only one copy is actually written to the log. If you want to force
28276 duplicates to be written, use the &%logwrite%& modifier instead.
28277
28278 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28279 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28280 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28281 first failing condition. There is more about adding header lines in section
28282 &<<SECTaddheadacl>>&.
28283
28284 If any condition on a &%warn%& statement cannot be completed (that is, there is
28285 some sort of defer), the log line specified by &%log_message%& is not written.
28286 This does not include the case of a forced failure from a lookup, which
28287 is considered to be a successful completion. After a defer, no further
28288 conditions or modifiers in the &%warn%& statement are processed. The incident
28289 is logged, and the ACL continues to be processed, from the next statement
28290 onwards.
28291
28292
28293 .vindex "&$acl_verify_message$&"
28294 When one of the &%warn%& conditions is an address verification that fails, the
28295 text of the verification failure message is in &$acl_verify_message$&. If you
28296 want this logged, you must set it up explicitly. For example:
28297 .code
28298 warn   !verify = sender
28299        log_message = sender verify failed: $acl_verify_message
28300 .endd
28301 .endlist
28302
28303 At the end of each ACL there is an implicit unconditional &%deny%&.
28304
28305 As you can see from the examples above, the conditions and modifiers are
28306 written one to a line, with the first one on the same line as the verb, and
28307 subsequent ones on following lines. If you have a very long condition, you can
28308 continue it onto several physical lines by the usual backslash continuation
28309 mechanism. It is conventional to align the conditions vertically.
28310
28311
28312
28313 .section "ACL variables" "SECTaclvariables"
28314 .cindex "&ACL;" "variables"
28315 There are some special variables that can be set during ACL processing. They
28316 can be used to pass information between different ACLs, different invocations
28317 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28318 transports, and filters that are used to deliver a message. The names of these
28319 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28320 an underscore, but the remainder of the name can be any sequence of
28321 alphanumeric characters and underscores that you choose. There is no limit on
28322 the number of ACL variables. The two sets act as follows:
28323 .ilist
28324 The values of those variables whose names begin with &$acl_c$& persist
28325 throughout an SMTP connection. They are never reset. Thus, a value that is set
28326 while receiving one message is still available when receiving the next message
28327 on the same SMTP connection.
28328 .next
28329 The values of those variables whose names begin with &$acl_m$& persist only
28330 while a message is being received. They are reset afterwards. They are also
28331 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28332 .endlist
28333
28334 When a message is accepted, the current values of all the ACL variables are
28335 preserved with the message and are subsequently made available at delivery
28336 time. The ACL variables are set by a modifier called &%set%&. For example:
28337 .code
28338 accept hosts = whatever
28339        set acl_m4 = some value
28340 accept authenticated = *
28341        set acl_c_auth = yes
28342 .endd
28343 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28344 be set. If you want to set a variable without taking any action, you can use a
28345 &%warn%& verb without any other modifiers or conditions.
28346
28347 .oindex &%strict_acl_vars%&
28348 What happens if a syntactically valid but undefined ACL variable is
28349 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28350 false (the default), an empty string is substituted; if it is true, an
28351 error is generated.
28352
28353 Versions of Exim before 4.64 have a limited set of numbered variables, but
28354 their names are compatible, so there is no problem with upgrading.
28355
28356
28357 .section "Condition and modifier processing" "SECTcondmodproc"
28358 .cindex "&ACL;" "conditions; processing"
28359 .cindex "&ACL;" "modifiers; processing"
28360 An exclamation mark preceding a condition negates its result. For example:
28361 .code
28362 deny   domains = *.dom.example
28363       !verify  = recipient
28364 .endd
28365 causes the ACL to return &"deny"& if the recipient domain ends in
28366 &'dom.example'& and the recipient address cannot be verified. Sometimes
28367 negation can be used on the right-hand side of a condition. For example, these
28368 two statements are equivalent:
28369 .code
28370 deny  hosts = !192.168.3.4
28371 deny !hosts =  192.168.3.4
28372 .endd
28373 However, for many conditions (&%verify%& being a good example), only left-hand
28374 side negation of the whole condition is possible.
28375
28376 The arguments of conditions and modifiers are expanded. A forced failure
28377 of an expansion causes a condition to be ignored, that is, it behaves as if the
28378 condition is true. Consider these two statements:
28379 .code
28380 accept  senders = ${lookup{$host_name}lsearch\
28381                   {/some/file}{$value}fail}
28382 accept  senders = ${lookup{$host_name}lsearch\
28383                   {/some/file}{$value}{}}
28384 .endd
28385 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28386 the returned list is searched, but if the lookup fails the behaviour is
28387 different in the two cases. The &%fail%& in the first statement causes the
28388 condition to be ignored, leaving no further conditions. The &%accept%& verb
28389 therefore succeeds. The second statement, however, generates an empty list when
28390 the lookup fails. No sender can match an empty list, so the condition fails,
28391 and therefore the &%accept%& also fails.
28392
28393 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28394 specify actions that are taken as the conditions for a statement are checked;
28395 others specify text for messages that are used when access is denied or a
28396 warning is generated. The &%control%& modifier affects the way an incoming
28397 message is handled.
28398
28399 The positioning of the modifiers in an ACL statement is important, because the
28400 processing of a verb ceases as soon as its outcome is known. Only those
28401 modifiers that have already been encountered will take effect. For example,
28402 consider this use of the &%message%& modifier:
28403 .code
28404 require message = Can't verify sender
28405         verify  = sender
28406         message = Can't verify recipient
28407         verify  = recipient
28408         message = This message cannot be used
28409 .endd
28410 If sender verification fails, Exim knows that the result of the statement is
28411 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28412 so its text is used as the error message. If sender verification succeeds, but
28413 recipient verification fails, the second message is used. If recipient
28414 verification succeeds, the third message becomes &"current"&, but is never used
28415 because there are no more conditions to cause failure.
28416
28417 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28418 modifier that is used, because all the conditions must be true for rejection to
28419 happen. Specifying more than one &%message%& modifier does not make sense, and
28420 the message can even be specified after all the conditions. For example:
28421 .code
28422 deny   hosts = ...
28423       !senders = *@my.domain.example
28424        message = Invalid sender from client host
28425 .endd
28426 The &"deny"& result does not happen until the end of the statement is reached,
28427 by which time Exim has set up the message.
28428
28429
28430
28431 .section "ACL modifiers" "SECTACLmodi"
28432 .cindex "&ACL;" "modifiers; list of"
28433 The ACL modifiers are as follows:
28434
28435 .vlist
28436 .vitem &*add_header*&&~=&~<&'text'&>
28437 This modifier specifies one or more header lines that are to be added to an
28438 incoming message, assuming, of course, that the message is ultimately
28439 accepted. For details, see section &<<SECTaddheadacl>>&.
28440
28441 .vitem &*continue*&&~=&~<&'text'&>
28442 .cindex "&%continue%& ACL modifier"
28443 .cindex "database" "updating in ACL"
28444 This modifier does nothing of itself, and processing of the ACL always
28445 continues with the next condition or modifier. The value of &%continue%& is in
28446 the side effects of expanding its argument. Typically this could be used to
28447 update a database. It is really just a syntactic tidiness, to avoid having to
28448 write rather ugly lines like this:
28449 .display
28450 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28451 .endd
28452 Instead, all you need is
28453 .display
28454 &`continue = `&<&'some expansion'&>
28455 .endd
28456
28457 .vitem &*control*&&~=&~<&'text'&>
28458 .cindex "&%control%& ACL modifier"
28459 This modifier affects the subsequent processing of the SMTP connection or of an
28460 incoming message that is accepted. The effect of the first type of control
28461 lasts for the duration of the connection, whereas the effect of the second type
28462 lasts only until the current message has been received. The message-specific
28463 controls always apply to the whole message, not to individual recipients,
28464 even if the &%control%& modifier appears in a RCPT ACL.
28465
28466 As there are now quite a few controls that can be applied, they are described
28467 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28468 in several different ways. For example:
28469
28470 . ==== As this is a nested list, any displays it contains must be indented
28471 . ==== as otherwise they are too far to the left. That comment applies only
28472 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28473 . ==== way.
28474
28475 .ilist
28476 It can be at the end of an &%accept%& statement:
28477 .code
28478     accept  ...some conditions
28479             control = queue_only
28480 .endd
28481 In this case, the control is applied when this statement yields &"accept"&, in
28482 other words, when the conditions are all true.
28483
28484 .next
28485 It can be in the middle of an &%accept%& statement:
28486 .code
28487     accept  ...some conditions...
28488             control = queue_only
28489             ...some more conditions...
28490 .endd
28491 If the first set of conditions are true, the control is applied, even if the
28492 statement does not accept because one of the second set of conditions is false.
28493 In this case, some subsequent statement must yield &"accept"& for the control
28494 to be relevant.
28495
28496 .next
28497 It can be used with &%warn%& to apply the control, leaving the
28498 decision about accepting or denying to a subsequent verb. For
28499 example:
28500 .code
28501     warn    ...some conditions...
28502             control = freeze
28503     accept  ...
28504 .endd
28505 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28506 &%logwrite%&, so it does not add anything to the message and does not write a
28507 log entry.
28508
28509 .next
28510 If you want to apply a control unconditionally, you can use it with a
28511 &%require%& verb. For example:
28512 .code
28513     require  control = no_multiline_responses
28514 .endd
28515 .endlist
28516
28517 .vitem &*delay*&&~=&~<&'time'&>
28518 .cindex "&%delay%& ACL modifier"
28519 .oindex "&%-bh%&"
28520 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28521 the time interval before proceeding. However, when testing Exim using the
28522 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28523 output instead). The time is given in the usual Exim notation, and the delay
28524 happens as soon as the modifier is processed. In an SMTP session, pending
28525 output is flushed before the delay is imposed.
28526
28527 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28528 example:
28529 .code
28530 deny    ...some conditions...
28531         delay = 30s
28532 .endd
28533 The delay happens if all the conditions are true, before the statement returns
28534 &"deny"&. Compare this with:
28535 .code
28536 deny    delay = 30s
28537         ...some conditions...
28538 .endd
28539 which waits for 30s before processing the conditions. The &%delay%& modifier
28540 can also be used with &%warn%& and together with &%control%&:
28541 .code
28542 warn    ...some conditions...
28543         delay = 2m
28544         control = freeze
28545 accept  ...
28546 .endd
28547
28548 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28549 responses to several commands are no longer buffered and sent in one packet (as
28550 they would normally be) because all output is flushed before imposing the
28551 delay. This optimization is disabled so that a number of small delays do not
28552 appear to the client as one large aggregated delay that might provoke an
28553 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28554 using a &%control%& modifier to set &%no_delay_flush%&.
28555
28556
28557 .vitem &*endpass*&
28558 .cindex "&%endpass%& ACL modifier"
28559 This modifier, which has no argument, is recognized only in &%accept%& and
28560 &%discard%& statements. It marks the boundary between the conditions whose
28561 failure causes control to pass to the next statement, and the conditions whose
28562 failure causes the ACL to return &"deny"&. This concept has proved to be
28563 confusing to some people, so the use of &%endpass%& is no longer recommended as
28564 &"best practice"&. See the description of &%accept%& above for more details.
28565
28566
28567 .vitem &*log_message*&&~=&~<&'text'&>
28568 .cindex "&%log_message%& ACL modifier"
28569 This modifier sets up a message that is used as part of the log message if the
28570 ACL denies access or a &%warn%& statement's conditions are true. For example:
28571 .code
28572 require log_message = wrong cipher suite $tls_in_cipher
28573         encrypted   = DES-CBC3-SHA
28574 .endd
28575 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28576 example:
28577 .display
28578 &`discard `&<&'some conditions'&>
28579 &`        log_message = Discarded $local_part@$domain because...`&
28580 .endd
28581 When access is denied, &%log_message%& adds to any underlying error message
28582 that may exist because of a condition failure. For example, while verifying a
28583 recipient address, a &':fail:'& redirection might have already set up a
28584 message.
28585
28586 The message may be defined before the conditions to which it applies, because
28587 the string expansion does not happen until Exim decides that access is to be
28588 denied. This means that any variables that are set by the condition are
28589 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28590 variables are set after a DNS black list lookup succeeds. If the expansion of
28591 &%log_message%& fails, or if the result is an empty string, the modifier is
28592 ignored.
28593
28594 .vindex "&$acl_verify_message$&"
28595 If you want to use a &%warn%& statement to log the result of an address
28596 verification, you can use &$acl_verify_message$& to include the verification
28597 error message.
28598
28599 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28600 the start of the logged message. If the same warning log message is requested
28601 more than once while receiving  a single email message, only one copy is
28602 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28603 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28604 is logged for a successful &%warn%& statement.
28605
28606 If &%log_message%& is not present and there is no underlying error message (for
28607 example, from the failure of address verification), but &%message%& is present,
28608 the &%message%& text is used for logging rejections. However, if any text for
28609 logging contains newlines, only the first line is logged. In the absence of
28610 both &%log_message%& and &%message%&, a default built-in message is used for
28611 logging rejections.
28612
28613
28614 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28615 .cindex "&%log_reject_target%& ACL modifier"
28616 .cindex "logging in ACL" "specifying which log"
28617 This modifier makes it possible to specify which logs are used for messages
28618 about ACL rejections. Its argument is a colon-separated list of words that can
28619 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28620 may be empty, in which case a rejection is not logged at all. For example, this
28621 ACL fragment writes no logging information when access is denied:
28622 .display
28623 &`deny `&<&'some conditions'&>
28624 &`     log_reject_target =`&
28625 .endd
28626 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28627 permanent and temporary rejections. Its effect lasts for the rest of the
28628 current ACL.
28629
28630
28631 .vitem &*logwrite*&&~=&~<&'text'&>
28632 .cindex "&%logwrite%& ACL modifier"
28633 .cindex "logging in ACL" "immediate"
28634 This modifier writes a message to a log file as soon as it is encountered when
28635 processing an ACL. (Compare &%log_message%&, which, except in the case of
28636 &%warn%& and &%discard%&, is used only if the ACL statement denies
28637 access.) The &%logwrite%& modifier can be used to log special incidents in
28638 ACLs. For example:
28639 .display
28640 &`accept `&<&'some special conditions'&>
28641 &`       control  = freeze`&
28642 &`       logwrite = froze message because ...`&
28643 .endd
28644 By default, the message is written to the main log. However, it may begin
28645 with a colon, followed by a comma-separated list of log names, and then
28646 another colon, to specify exactly which logs are to be written. For
28647 example:
28648 .code
28649 logwrite = :main,reject: text for main and reject logs
28650 logwrite = :panic: text for panic log only
28651 .endd
28652
28653
28654 .vitem &*message*&&~=&~<&'text'&>
28655 .cindex "&%message%& ACL modifier"
28656 This modifier sets up a text string that is expanded and used as a response
28657 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28658 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28659 there is some complication if &%endpass%& is involved; see the description of
28660 &%accept%& for details.)
28661
28662 The expansion of the message happens at the time Exim decides that the ACL is
28663 to end, not at the time it processes &%message%&. If the expansion fails, or
28664 generates an empty string, the modifier is ignored. Here is an example where
28665 &%message%& must be specified first, because the ACL ends with a rejection if
28666 the &%hosts%& condition fails:
28667 .code
28668 require  message = Host not recognized
28669          hosts = 10.0.0.0/8
28670 .endd
28671 (Once a condition has failed, no further conditions or modifiers are
28672 processed.)
28673
28674 .cindex "SMTP" "error codes"
28675 .oindex "&%smtp_banner%&
28676 For ACLs that are triggered by SMTP commands, the message is returned as part
28677 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28678 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28679 is accepted. In the case of the connect ACL, accepting with a message modifier
28680 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28681 accept message may not contain more than one line (otherwise it will be
28682 truncated at the first newline and a panic logged), and it cannot affect the
28683 EHLO options.
28684
28685 When SMTP is involved, the message may begin with an overriding response code,
28686 consisting of three digits optionally followed by an &"extended response code"&
28687 of the form &'n.n.n'&, each code being followed by a space. For example:
28688 .code
28689 deny  message = 599 1.2.3 Host not welcome
28690       hosts = 192.168.34.0/24
28691 .endd
28692 The first digit of the supplied response code must be the same as would be sent
28693 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28694 access, but for the predata ACL, note that the default success code is 354, not
28695 2&'xx'&.
28696
28697 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28698 the message modifier cannot override the 221 response code.
28699
28700 The text in a &%message%& modifier is literal; any quotes are taken as
28701 literals, but because the string is expanded, backslash escapes are processed
28702 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28703 response.
28704
28705 .vindex "&$acl_verify_message$&"
28706 For ACLs that are called by an &%acl =%& ACL condition, the message is
28707 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28708
28709 If &%message%& is used on a statement that verifies an address, the message
28710 specified overrides any message that is generated by the verification process.
28711 However, the original message is available in the variable
28712 &$acl_verify_message$&, so you can incorporate it into your message if you
28713 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28714 routers to be passed back as part of the SMTP response, you should either not
28715 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28716
28717 For compatibility with previous releases of Exim, a &%message%& modifier that
28718 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28719 modifier, but this usage is now deprecated. However, &%message%& acts only when
28720 all the conditions are true, wherever it appears in an ACL command, whereas
28721 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28722 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28723 effect.
28724
28725
28726 .new
28727 .vitem &*queue*&&~=&~<&'text'&>
28728 This modifier specifies the use of a named queue for spool files
28729 for the message.
28730 It can only be used before the message is received (i.e. not in
28731 the DATA ACL).
28732 This could be used, for example, for known high-volume burst sources
28733 of traffic, or for quarantine of messages.
28734 Separate queue-runner processes will be needed for named queues.
28735 If the text after expansion is empty, the default queue is used.
28736 .wen
28737
28738
28739 .vitem &*remove_header*&&~=&~<&'text'&>
28740 This modifier specifies one or more header names in a colon-separated list
28741  that are to be removed from an incoming message, assuming, of course, that
28742 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28743
28744
28745 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28746 .cindex "&%set%& ACL modifier"
28747 This modifier puts a value into one of the ACL variables (see section
28748 &<<SECTaclvariables>>&).
28749
28750
28751 .vitem &*udpsend*&&~=&~<&'parameters'&>
28752 This modifier sends a UDP packet, for purposes such as statistics
28753 collection or behaviour monitoring. The parameters are expanded, and
28754 the result of the expansion must be a colon-separated list consisting
28755 of a destination server, port number, and the packet contents. The
28756 server can be specified as a host name or IPv4 or IPv6 address. The
28757 separator can be changed with the usual angle bracket syntax. For
28758 example, you might want to collect information on which hosts connect
28759 when:
28760 .code
28761 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28762              $tod_zulu $sender_host_address
28763 .endd
28764 .endlist
28765
28766
28767
28768
28769 .section "Use of the control modifier" "SECTcontrols"
28770 .cindex "&%control%& ACL modifier"
28771 The &%control%& modifier supports the following settings:
28772
28773 .vlist
28774 .vitem &*control&~=&~allow_auth_unadvertised*&
28775 This modifier allows a client host to use the SMTP AUTH command even when it
28776 has not been advertised in response to EHLO. Furthermore, because there are
28777 apparently some really broken clients that do this, Exim will accept AUTH after
28778 HELO (rather than EHLO) when this control is set. It should be used only if you
28779 really need it, and you should limit its use to those broken clients that do
28780 not work without it. For example:
28781 .code
28782 warn hosts   = 192.168.34.25
28783      control = allow_auth_unadvertised
28784 .endd
28785 Normally, when an Exim server receives an AUTH command, it checks the name of
28786 the authentication mechanism that is given in the command to ensure that it
28787 matches an advertised mechanism. When this control is set, the check that a
28788 mechanism has been advertised is bypassed. Any configured mechanism can be used
28789 by the client. This control is permitted only in the connection and HELO ACLs.
28790
28791
28792 .vitem &*control&~=&~caseful_local_part*& &&&
28793        &*control&~=&~caselower_local_part*&
28794 .cindex "&ACL;" "case of local part in"
28795 .cindex "case of local parts"
28796 .vindex "&$local_part$&"
28797 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28798 (that is, during RCPT processing). By default, the contents of &$local_part$&
28799 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28800 any uppercase letters in the original local part are restored in &$local_part$&
28801 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28802 is encountered.
28803
28804 These controls affect only the current recipient. Moreover, they apply only to
28805 local part handling that takes place directly in the ACL (for example, as a key
28806 in lookups). If a test to verify the recipient is obeyed, the case-related
28807 handling of the local part during the verification is controlled by the router
28808 configuration (see the &%caseful_local_part%& generic router option).
28809
28810 This facility could be used, for example, to add a spam score to local parts
28811 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28812 spam score:
28813 .code
28814 warn  control = caseful_local_part
28815       set acl_m4 = ${eval:\
28816                      $acl_m4 + \
28817                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28818                     }
28819       control = caselower_local_part
28820 .endd
28821 Notice that we put back the lower cased version afterwards, assuming that
28822 is what is wanted for subsequent tests.
28823
28824
28825 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
28826 .cindex "&ACL;" "cutthrough routing"
28827 .cindex "cutthrough" "requesting"
28828 This option requests delivery be attempted while the item is being received.
28829
28830 The option is usable in the RCPT ACL.
28831 If enabled for a message received via smtp and routed to an smtp transport,
28832 and only one transport, interface, destination host and port combination
28833 is used for all recipients of the message,
28834 then the delivery connection is made while the receiving connection is open
28835 and data is copied from one to the other.
28836
28837 An attempt to set this option for any recipient but the first
28838 for a mail will be quietly ignored.
28839 If a recipient-verify callout
28840 (with use_sender)
28841 connection is subsequently
28842 requested in the same ACL it is held open and used for
28843 any subsequent recipients and the data,
28844 otherwise one is made after the initial RCPT ACL completes.
28845
28846 Note that routers are used in verify mode,
28847 and cannot depend on content of received headers.
28848 Note also that headers cannot be
28849 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28850 Headers may be modified by routers (subject to the above) and transports.
28851
28852 All the usual ACLs are called; if one results in the message being
28853 rejected, all effort spent in delivery (including the costs on
28854 the ultimate destination) will be wasted.
28855 Note that in the case of data-time ACLs this includes the entire
28856 message body.
28857
28858 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28859 of outgoing messages is done, because it sends data to the ultimate destination
28860 before the entire message has been received from the source.
28861 It is not supported for messages received with the SMTP PRDR option in use.
28862
28863 Should the ultimate destination system positively accept or reject the mail,
28864 a corresponding indication is given to the source system and nothing is queued.
28865 If the item is successfully delivered in cutthrough mode
28866 the delivery log lines are tagged with ">>" rather than "=>" and appear
28867 before the acceptance "<=" line.
28868
28869 .new
28870 If there is a temporary error the item is queued for later delivery in the
28871 usual fashion.
28872 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
28873 to the control; the default value is &"spool"& and the alternate value
28874 &"pass"& copies an SMTP defer response from the target back to the initiator
28875 and does not queue the message.
28876 Note that this is independent of any receipient verify conditions in the ACL.
28877 .wen
28878
28879 Delivery in this mode avoids the generation of a bounce mail to a
28880 (possibly faked)
28881 sender when the destination system is doing content-scan based rejection.
28882
28883
28884 .vitem &*control&~=&~debug/*&<&'options'&>
28885 .cindex "&ACL;" "enabling debug logging"
28886 .cindex "debugging" "enabling from an ACL"
28887 This control turns on debug logging, almost as though Exim had been invoked
28888 with &`-d`&, with the output going to a new logfile, by default called
28889 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28890 may access any variables already defined.  The logging may be adjusted with
28891 the &'opts'& option, which takes the same values as the &`-d`& command-line
28892 option.
28893 .new
28894 Logging may be stopped, and the file removed, with the &'kill'& option.
28895 .wen
28896 Some examples (which depend on variables that don't exist in all
28897 contexts):
28898 .code
28899       control = debug
28900       control = debug/tag=.$sender_host_address
28901       control = debug/opts=+expand+acl
28902       control = debug/tag=.$message_exim_id/opts=+expand
28903       control = debug/kill
28904 .endd
28905
28906
28907 .vitem &*control&~=&~dkim_disable_verify*&
28908 .cindex "disable DKIM verify"
28909 .cindex "DKIM" "disable verify"
28910 This control turns off DKIM verification processing entirely.  For details on
28911 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28912
28913
28914 .vitem &*control&~=&~dscp/*&<&'value'&>
28915 .cindex "&ACL;" "setting DSCP value"
28916 .cindex "DSCP" "inbound"
28917 This option causes the DSCP value associated with the socket for the inbound
28918 connection to be adjusted to a given value, given as one of a number of fixed
28919 strings or to numeric value.
28920 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28921 Common values include &`throughput`&, &`mincost`&, and on newer systems
28922 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28923
28924 The outbound packets from Exim will be marked with this value in the header
28925 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28926 that these values will have any effect, not be stripped by networking
28927 equipment, or do much of anything without cooperation with your Network
28928 Engineer and those of all network operators between the source and destination.
28929
28930
28931 .vitem &*control&~=&~enforce_sync*& &&&
28932        &*control&~=&~no_enforce_sync*&
28933 .cindex "SMTP" "synchronization checking"
28934 .cindex "synchronization checking in SMTP"
28935 These controls make it possible to be selective about when SMTP synchronization
28936 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28937 state of the switch (it is true by default). See the description of this option
28938 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28939
28940 The effect of these two controls lasts for the remainder of the SMTP
28941 connection. They can appear in any ACL except the one for the non-SMTP
28942 messages. The most straightforward place to put them is in the ACL defined by
28943 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28944 before the first synchronization check. The expected use is to turn off the
28945 synchronization checks for badly-behaved hosts that you nevertheless need to
28946 work with.
28947
28948
28949 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28950 .cindex "fake defer"
28951 .cindex "defer, fake"
28952 This control works in exactly the same way as &%fakereject%& (described below)
28953 except that it causes an SMTP 450 response after the message data instead of a
28954 550 response. You must take care when using &%fakedefer%& because it causes the
28955 messages to be duplicated when the sender retries. Therefore, you should not
28956 use &%fakedefer%& if the message is to be delivered normally.
28957
28958 .vitem &*control&~=&~fakereject/*&<&'message'&>
28959 .cindex "fake rejection"
28960 .cindex "rejection, fake"
28961 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28962 words, only when an SMTP message is being received. If Exim accepts the
28963 message, instead the final 250 response, a 550 rejection message is sent.
28964 However, Exim proceeds to deliver the message as normal. The control applies
28965 only to the current message, not to any subsequent ones that may be received in
28966 the same SMTP connection.
28967
28968 The text for the 550 response is taken from the &%control%& modifier. If no
28969 message is supplied, the following is used:
28970 .code
28971 550-Your message has been rejected but is being
28972 550-kept for evaluation.
28973 550-If it was a legitimate message, it may still be
28974 550 delivered to the target recipient(s).
28975 .endd
28976 This facility should be used with extreme caution.
28977
28978 .vitem &*control&~=&~freeze*&
28979 .cindex "frozen messages" "forcing in ACL"
28980 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28981 other words, only when a message is being received. If the message is accepted,
28982 it is placed on Exim's queue and frozen. The control applies only to the
28983 current message, not to any subsequent ones that may be received in the same
28984 SMTP connection.
28985
28986 This modifier can optionally be followed by &`/no_tell`&. If the global option
28987 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28988 is told about the freezing), provided all the &*control=freeze*& modifiers that
28989 are obeyed for the current message have the &`/no_tell`& option.
28990
28991 .vitem &*control&~=&~no_delay_flush*&
28992 .cindex "SMTP" "output flushing, disabling for delay"
28993 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28994 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28995 use. This control, as long as it is encountered before the &%delay%& modifier,
28996 disables such output flushing.
28997
28998 .vitem &*control&~=&~no_callout_flush*&
28999 .cindex "SMTP" "output flushing, disabling for callout"
29000 Exim normally flushes SMTP output before performing a callout in an ACL, to
29001 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29002 use. This control, as long as it is encountered before the &%verify%& condition
29003 that causes the callout, disables such output flushing.
29004
29005 .vitem &*control&~=&~no_mbox_unspool*&
29006 This control is available when Exim is compiled with the content scanning
29007 extension. Content scanning may require a copy of the current message, or parts
29008 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29009 or spam scanner. Normally, such copies are deleted when they are no longer
29010 needed. If this control is set, the copies are not deleted. The control applies
29011 only to the current message, not to any subsequent ones that may be received in
29012 the same SMTP connection. It is provided for debugging purposes and is unlikely
29013 to be useful in production.
29014
29015 .vitem &*control&~=&~no_multiline_responses*&
29016 .cindex "multiline responses, suppressing"
29017 This control is permitted for any ACL except the one for non-SMTP messages.
29018 It seems that there are broken clients in use that cannot handle multiline
29019 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29020
29021 If this control is set, multiline SMTP responses from ACL rejections are
29022 suppressed. One way of doing this would have been to put out these responses as
29023 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29024 (&"use multiline responses for more"& it says &-- ha!), and some of the
29025 responses might get close to that. So this facility, which is after all only a
29026 sop to broken clients, is implemented by doing two very easy things:
29027
29028 .ilist
29029 Extra information that is normally output as part of a rejection caused by
29030 sender verification failure is omitted. Only the final line (typically &"sender
29031 verification failed"&) is sent.
29032 .next
29033 If a &%message%& modifier supplies a multiline response, only the first
29034 line is output.
29035 .endlist
29036
29037 The setting of the switch can, of course, be made conditional on the
29038 calling host. Its effect lasts until the end of the SMTP connection.
29039
29040 .vitem &*control&~=&~no_pipelining*&
29041 .cindex "PIPELINING" "suppressing advertising"
29042 This control turns off the advertising of the PIPELINING extension to SMTP in
29043 the current session. To be useful, it must be obeyed before Exim sends its
29044 response to an EHLO command. Therefore, it should normally appear in an ACL
29045 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29046 &%pipelining_advertise_hosts%&.
29047
29048 .vitem &*control&~=&~queue_only*&
29049 .oindex "&%queue_only%&"
29050 .cindex "queueing incoming messages"
29051 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29052 other words, only when a message is being received. If the message is accepted,
29053 it is placed on Exim's queue and left there for delivery by a subsequent queue
29054 runner. No immediate delivery process is started. In other words, it has the
29055 effect as the &%queue_only%& global option. However, the control applies only
29056 to the current message, not to any subsequent ones that may be received in the
29057 same SMTP connection.
29058
29059 .vitem &*control&~=&~submission/*&<&'options'&>
29060 .cindex "message" "submission"
29061 .cindex "submission mode"
29062 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29063 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29064 the current message is a submission from a local MUA. In this case, Exim
29065 operates in &"submission mode"&, and applies certain fixups to the message if
29066 necessary. For example, it adds a &'Date:'& header line if one is not present.
29067 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29068 late (the message has already been created).
29069
29070 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29071 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29072 submission mode; the available options for this control are described there.
29073 The control applies only to the current message, not to any subsequent ones
29074 that may be received in the same SMTP connection.
29075
29076 .vitem &*control&~=&~suppress_local_fixups*&
29077 .cindex "submission fixups, suppressing"
29078 This control applies to locally submitted (non TCP/IP) messages, and is the
29079 complement of &`control = submission`&. It disables the fixups that are
29080 normally applied to locally-submitted messages. Specifically:
29081
29082 .ilist
29083 Any &'Sender:'& header line is left alone (in this respect, it is a
29084 dynamic version of &%local_sender_retain%&).
29085 .next
29086 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29087 .next
29088 There is no check that &'From:'& corresponds to the actual sender.
29089 .endlist ilist
29090
29091 This control may be useful when a remotely-originated message is accepted,
29092 passed to some scanning program, and then re-submitted for delivery. It can be
29093 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29094 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29095 data is read.
29096
29097 &*Note:*& This control applies only to the current message, not to any others
29098 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29099
29100 .vitem &*control&~=&~utf8_downconvert*&
29101 This control enables conversion of UTF-8 in message addresses
29102 to a-label form.
29103 For details see &<<SECTi18nMTA>>&.
29104 .endlist vlist
29105
29106
29107 .section "Summary of message fixup control" "SECTsummesfix"
29108 All four possibilities for message fixups can be specified:
29109
29110 .ilist
29111 Locally submitted, fixups applied: the default.
29112 .next
29113 Locally submitted, no fixups applied: use
29114 &`control = suppress_local_fixups`&.
29115 .next
29116 Remotely submitted, no fixups applied: the default.
29117 .next
29118 Remotely submitted, fixups applied: use &`control = submission`&.
29119 .endlist
29120
29121
29122
29123 .section "Adding header lines in ACLs" "SECTaddheadacl"
29124 .cindex "header lines" "adding in an ACL"
29125 .cindex "header lines" "position of added lines"
29126 .cindex "&%add_header%& ACL modifier"
29127 The &%add_header%& modifier can be used to add one or more extra header lines
29128 to an incoming message, as in this example:
29129 .code
29130 warn dnslists = sbl.spamhaus.org : \
29131                 dialup.mail-abuse.org
29132      add_header = X-blacklisted-at: $dnslist_domain
29133 .endd
29134 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29135 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29136 receiving a message). The message must ultimately be accepted for
29137 &%add_header%& to have any significant effect. You can use &%add_header%& with
29138 any ACL verb, including &%deny%& (though this is potentially useful only in a
29139 RCPT ACL).
29140
29141 Headers will not be added to the message if the modifier is used in
29142 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29143
29144 Leading and trailing newlines are removed from
29145 the data for the &%add_header%& modifier; if it then
29146 contains one or more newlines that
29147 are not followed by a space or a tab, it is assumed to contain multiple header
29148 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29149 front of any line that is not a valid header line.
29150
29151 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29152 They are added to the message before processing the DATA and MIME ACLs.
29153 However, if an identical header line is requested more than once, only one copy
29154 is actually added to the message. Further header lines may be accumulated
29155 during the DATA and MIME ACLs, after which they are added to the message, again
29156 with duplicates suppressed. Thus, it is possible to add two identical header
29157 lines to an SMTP message, but only if one is added before DATA and one after.
29158 In the case of non-SMTP messages, new headers are accumulated during the
29159 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29160 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29161 are included in the entry that is written to the reject log.
29162
29163 .cindex "header lines" "added; visibility of"
29164 Header lines are not visible in string expansions
29165 of message headers
29166 until they are added to the
29167 message. It follows that header lines defined in the MAIL, RCPT, and predata
29168 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29169 header lines that are added by the DATA or MIME ACLs are not visible in those
29170 ACLs. Because of this restriction, you cannot use header lines as a way of
29171 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29172 this, you can use ACL variables, as described in section
29173 &<<SECTaclvariables>>&.
29174
29175 The list of headers yet to be added is given by the &%$headers_added%& variable.
29176
29177 The &%add_header%& modifier acts immediately as it is encountered during the
29178 processing of an ACL. Notice the difference between these two cases:
29179 .display
29180 &`accept add_header = ADDED: some text`&
29181 &`       `&<&'some condition'&>
29182
29183 &`accept `&<&'some condition'&>
29184 &`       add_header = ADDED: some text`&
29185 .endd
29186 In the first case, the header line is always added, whether or not the
29187 condition is true. In the second case, the header line is added only if the
29188 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29189 ACL statement. All those that are encountered before a condition fails are
29190 honoured.
29191
29192 .cindex "&%warn%& ACL verb"
29193 For compatibility with previous versions of Exim, a &%message%& modifier for a
29194 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29195 effect only if all the conditions are true, even if it appears before some of
29196 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29197 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29198 are present on a &%warn%& verb, both are processed according to their
29199 specifications.
29200
29201 By default, new header lines are added to a message at the end of the existing
29202 header lines. However, you can specify that any particular header line should
29203 be added right at the start (before all the &'Received:'& lines), immediately
29204 after the first block of &'Received:'& lines, or immediately before any line
29205 that is not a &'Received:'& or &'Resent-something:'& header.
29206
29207 This is done by specifying &":at_start:"&, &":after_received:"&, or
29208 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29209 header line, respectively. (Header text cannot start with a colon, as there has
29210 to be a header name first.) For example:
29211 .code
29212 warn add_header = \
29213        :after_received:X-My-Header: something or other...
29214 .endd
29215 If more than one header line is supplied in a single &%add_header%& modifier,
29216 each one is treated independently and can therefore be placed differently. If
29217 you add more than one line at the start, or after the Received: block, they end
29218 up in reverse order.
29219
29220 &*Warning*&: This facility currently applies only to header lines that are
29221 added in an ACL. It does NOT work for header lines that are added in a
29222 system filter or in a router or transport.
29223
29224
29225
29226 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29227 .cindex "header lines" "removing in an ACL"
29228 .cindex "header lines" "position of removed lines"
29229 .cindex "&%remove_header%& ACL modifier"
29230 The &%remove_header%& modifier can be used to remove one or more header lines
29231 from an incoming message, as in this example:
29232 .code
29233 warn   message        = Remove internal headers
29234        remove_header  = x-route-mail1 : x-route-mail2
29235 .endd
29236 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29237 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29238 receiving a message). The message must ultimately be accepted for
29239 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29240 with any ACL verb, including &%deny%&, though this is really not useful for
29241 any verb that doesn't result in a delivered message.
29242
29243 Headers will not be removed from the message if the modifier is used in
29244 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29245
29246 More than one header can be removed at the same time by using a colon separated
29247 list of header names. The header matching is case insensitive. Wildcards are
29248 not permitted, nor is list expansion performed, so you cannot use hostlists to
29249 create a list of headers, however both connection and message variable expansion
29250 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29251 .code
29252 warn   hosts           = +internal_hosts
29253        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29254 warn   message         = Remove internal headers
29255        remove_header   = $acl_c_ihdrs
29256 .endd
29257 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29258 They are removed from the message before processing the DATA and MIME ACLs.
29259 There is no harm in attempting to remove the same header twice nor is removing
29260 a non-existent header. Further header lines to be removed may be accumulated
29261 during the DATA and MIME ACLs, after which they are removed from the message,
29262 if present. In the case of non-SMTP messages, headers to be removed are
29263 accumulated during the non-SMTP ACLs, and are removed from the message after
29264 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29265 ACL, there really is no effect because there is no logging of what headers
29266 would have been removed.
29267
29268 .cindex "header lines" "removed; visibility of"
29269 Header lines are not visible in string expansions until the DATA phase when it
29270 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29271 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29272 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29273 this restriction, you cannot use header lines as a way of controlling data
29274 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29275 you should instead use ACL variables, as described in section
29276 &<<SECTaclvariables>>&.
29277
29278 The &%remove_header%& modifier acts immediately as it is encountered during the
29279 processing of an ACL. Notice the difference between these two cases:
29280 .display
29281 &`accept remove_header = X-Internal`&
29282 &`       `&<&'some condition'&>
29283
29284 &`accept `&<&'some condition'&>
29285 &`       remove_header = X-Internal`&
29286 .endd
29287 In the first case, the header line is always removed, whether or not the
29288 condition is true. In the second case, the header line is removed only if the
29289 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29290 same ACL statement. All those that are encountered before a condition fails
29291 are honoured.
29292
29293 &*Warning*&: This facility currently applies only to header lines that are
29294 present during ACL processing. It does NOT remove header lines that are added
29295 in a system filter or in a router or transport.
29296
29297
29298
29299
29300 .section "ACL conditions" "SECTaclconditions"
29301 .cindex "&ACL;" "conditions; list of"
29302 Some of the conditions listed in this section are available only when Exim is
29303 compiled with the content-scanning extension. They are included here briefly
29304 for completeness. More detailed descriptions can be found in the discussion on
29305 content scanning in chapter &<<CHAPexiscan>>&.
29306
29307 Not all conditions are relevant in all circumstances. For example, testing
29308 senders and recipients does not make sense in an ACL that is being run as the
29309 result of the arrival of an ETRN command, and checks on message headers can be
29310 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29311 can use the same condition (with different parameters) more than once in the
29312 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29313 The conditions are as follows:
29314
29315
29316 .vlist
29317 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29318 .cindex "&ACL;" "nested"
29319 .cindex "&ACL;" "indirect"
29320 .cindex "&ACL;" "arguments"
29321 .cindex "&%acl%& ACL condition"
29322 The possible values of the argument are the same as for the
29323 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29324 &"accept"& the condition is true; if it returns &"deny"& the condition is
29325 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29326 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29327 condition false. This means that further processing of the &%warn%& verb
29328 ceases, but processing of the ACL continues.
29329
29330 If the argument is a named ACL, up to nine space-separated optional values
29331 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29332 and $acl_narg is set to the count of values.
29333 Previous values of these variables are restored after the call returns.
29334 The name and values are expanded separately.
29335 Note that spaces in complex expansions which are used as arguments
29336 will act as argument separators.
29337
29338 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29339 the connection is dropped. If it returns &"discard"&, the verb must be
29340 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29341 conditions are tested.
29342
29343 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29344 loops. This condition allows you to use different ACLs in different
29345 circumstances. For example, different ACLs can be used to handle RCPT commands
29346 for different local users or different local domains.
29347
29348 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29349 .cindex "&%authenticated%& ACL condition"
29350 .cindex "authentication" "ACL checking"
29351 .cindex "&ACL;" "testing for authentication"
29352 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29353 the name of the authenticator is tested against the list. To test for
29354 authentication by any authenticator, you can set
29355 .code
29356 authenticated = *
29357 .endd
29358
29359 .vitem &*condition&~=&~*&<&'string'&>
29360 .cindex "&%condition%& ACL condition"
29361 .cindex "customizing" "ACL condition"
29362 .cindex "&ACL;" "customized test"
29363 .cindex "&ACL;" "testing, customized"
29364 This feature allows you to make up custom conditions. If the result of
29365 expanding the string is an empty string, the number zero, or one of the strings
29366 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29367 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29368 any other value, some error is assumed to have occurred, and the ACL returns
29369 &"defer"&. However, if the expansion is forced to fail, the condition is
29370 ignored. The effect is to treat it as true, whether it is positive or
29371 negative.
29372
29373 .vitem &*decode&~=&~*&<&'location'&>
29374 .cindex "&%decode%& ACL condition"
29375 This condition is available only when Exim is compiled with the
29376 content-scanning extension, and it is allowed only in the ACL defined by
29377 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29378 If all goes well, the condition is true. It is false only if there are
29379 problems such as a syntax error or a memory shortage. For more details, see
29380 chapter &<<CHAPexiscan>>&.
29381
29382 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29383 .cindex "&%dnslists%& ACL condition"
29384 .cindex "DNS list" "in ACL"
29385 .cindex "black list (DNS)"
29386 .cindex "&ACL;" "testing a DNS list"
29387 This condition checks for entries in DNS black lists. These are also known as
29388 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29389 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29390 different variants of this condition to describe briefly here. See sections
29391 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29392
29393 .vitem &*domains&~=&~*&<&'domain&~list'&>
29394 .cindex "&%domains%& ACL condition"
29395 .cindex "domain" "ACL checking"
29396 .cindex "&ACL;" "testing a recipient domain"
29397 .vindex "&$domain_data$&"
29398 This condition is relevant only after a RCPT command. It checks that the domain
29399 of the recipient address is in the domain list. If percent-hack processing is
29400 enabled, it is done before this test is done. If the check succeeds with a
29401 lookup, the result of the lookup is placed in &$domain_data$& until the next
29402 &%domains%& test.
29403
29404 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29405 use &%domains%& in a DATA ACL.
29406
29407
29408 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29409 .cindex "&%encrypted%& ACL condition"
29410 .cindex "encryption" "checking in an ACL"
29411 .cindex "&ACL;" "testing for encryption"
29412 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29413 name of the cipher suite in use is tested against the list. To test for
29414 encryption without testing for any specific cipher suite(s), set
29415 .code
29416 encrypted = *
29417 .endd
29418
29419
29420 .vitem &*hosts&~=&~*&<&'host&~list'&>
29421 .cindex "&%hosts%& ACL condition"
29422 .cindex "host" "ACL checking"
29423 .cindex "&ACL;" "testing the client host"
29424 This condition tests that the calling host matches the host list. If you have
29425 name lookups or wildcarded host names and IP addresses in the same host list,
29426 you should normally put the IP addresses first. For example, you could have:
29427 .code
29428 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29429 .endd
29430 The lookup in this example uses the host name for its key. This is implied by
29431 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29432 and it wouldn't matter which way round you had these two items.)
29433
29434 The reason for the problem with host names lies in the left-to-right way that
29435 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29436 but when it reaches an item that requires a host name, it fails if it cannot
29437 find a host name to compare with the pattern. If the above list is given in the
29438 opposite order, the &%accept%& statement fails for a host whose name cannot be
29439 found, even if its IP address is 10.9.8.7.
29440
29441 If you really do want to do the name check first, and still recognize the IP
29442 address even if the name lookup fails, you can rewrite the ACL like this:
29443 .code
29444 accept hosts = dbm;/etc/friendly/hosts
29445 accept hosts = 10.9.8.7
29446 .endd
29447 The default action on failing to find the host name is to assume that the host
29448 is not in the list, so the first &%accept%& statement fails. The second
29449 statement can then check the IP address.
29450
29451 .vindex "&$host_data$&"
29452 If a &%hosts%& condition is satisfied by means of a lookup, the result
29453 of the lookup is made available in the &$host_data$& variable. This
29454 allows you, for example, to set up a statement like this:
29455 .code
29456 deny  hosts = net-lsearch;/some/file
29457 message = $host_data
29458 .endd
29459 which gives a custom error message for each denied host.
29460
29461 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29462 .cindex "&%local_parts%& ACL condition"
29463 .cindex "local part" "ACL checking"
29464 .cindex "&ACL;" "testing a local part"
29465 .vindex "&$local_part_data$&"
29466 This condition is relevant only after a RCPT command. It checks that the local
29467 part of the recipient address is in the list. If percent-hack processing is
29468 enabled, it is done before this test. If the check succeeds with a lookup, the
29469 result of the lookup is placed in &$local_part_data$&, which remains set until
29470 the next &%local_parts%& test.
29471
29472 .vitem &*malware&~=&~*&<&'option'&>
29473 .cindex "&%malware%& ACL condition"
29474 .cindex "&ACL;" "virus scanning"
29475 .cindex "&ACL;" "scanning for viruses"
29476 This condition is available only when Exim is compiled with the
29477 content-scanning extension. It causes the incoming message to be scanned for
29478 viruses. For details, see chapter &<<CHAPexiscan>>&.
29479
29480 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29481 .cindex "&%mime_regex%& ACL condition"
29482 .cindex "&ACL;" "testing by regex matching"
29483 This condition is available only when Exim is compiled with the
29484 content-scanning extension, and it is allowed only in the ACL defined by
29485 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29486 with any of the regular expressions. For details, see chapter
29487 &<<CHAPexiscan>>&.
29488
29489 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29490 .cindex "rate limiting"
29491 This condition can be used to limit the rate at which a user or host submits
29492 messages. Details are given in section &<<SECTratelimiting>>&.
29493
29494 .vitem &*recipients&~=&~*&<&'address&~list'&>
29495 .cindex "&%recipients%& ACL condition"
29496 .cindex "recipient" "ACL checking"
29497 .cindex "&ACL;" "testing a recipient"
29498 This condition is relevant only after a RCPT command. It checks the entire
29499 recipient address against a list of recipients.
29500
29501 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29502 .cindex "&%regex%& ACL condition"
29503 .cindex "&ACL;" "testing by regex matching"
29504 This condition is available only when Exim is compiled with the
29505 content-scanning extension, and is available only in the DATA, MIME, and
29506 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29507 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29508
29509 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29510 .cindex "&%sender_domains%& ACL condition"
29511 .cindex "sender" "ACL checking"
29512 .cindex "&ACL;" "testing a sender domain"
29513 .vindex "&$domain$&"
29514 .vindex "&$sender_address_domain$&"
29515 This condition tests the domain of the sender of the message against the given
29516 domain list. &*Note*&: The domain of the sender address is in
29517 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29518 of this condition. This is an exception to the general rule for testing domain
29519 lists. It is done this way so that, if this condition is used in an ACL for a
29520 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29521 influence the sender checking.
29522
29523 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29524 relaying, because sender addresses are easily, and commonly, forged.
29525
29526 .vitem &*senders&~=&~*&<&'address&~list'&>
29527 .cindex "&%senders%& ACL condition"
29528 .cindex "sender" "ACL checking"
29529 .cindex "&ACL;" "testing a sender"
29530 This condition tests the sender of the message against the given list. To test
29531 for a bounce message, which has an empty sender, set
29532 .code
29533 senders = :
29534 .endd
29535 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29536 relaying, because sender addresses are easily, and commonly, forged.
29537
29538 .vitem &*spam&~=&~*&<&'username'&>
29539 .cindex "&%spam%& ACL condition"
29540 .cindex "&ACL;" "scanning for spam"
29541 This condition is available only when Exim is compiled with the
29542 content-scanning extension. It causes the incoming message to be scanned by
29543 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29544
29545 .vitem &*verify&~=&~certificate*&
29546 .cindex "&%verify%& ACL condition"
29547 .cindex "TLS" "client certificate verification"
29548 .cindex "certificate" "verification of client"
29549 .cindex "&ACL;" "certificate verification"
29550 .cindex "&ACL;" "testing a TLS certificate"
29551 This condition is true in an SMTP session if the session is encrypted, and a
29552 certificate was received from the client, and the certificate was verified. The
29553 server requests a certificate only if the client matches &%tls_verify_hosts%&
29554 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29555
29556 .vitem &*verify&~=&~csa*&
29557 .cindex "CSA verification"
29558 This condition checks whether the sending host (the client) is authorized to
29559 send email. Details of how this works are given in section
29560 &<<SECTverifyCSA>>&.
29561
29562 .vitem &*verify&~=&~header_names_ascii*&
29563 .cindex "&%verify%& ACL condition"
29564 .cindex "&ACL;" "verifying header names only ASCII"
29565 .cindex "header lines" "verifying header names only ASCII"
29566 .cindex "verifying" "header names only ASCII"
29567 This condition is relevant only in an ACL that is run after a message has been
29568 received, that is, in an ACL specified by &%acl_smtp_data%& or
29569 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29570 there are no non-ASCII characters, also excluding control characters.  The
29571 allowable characters are decimal ASCII values 33 through 126.
29572
29573 Exim itself will handle headers with non-ASCII characters, but it can cause
29574 problems for downstream applications, so this option will allow their
29575 detection and rejection in the DATA ACL's.
29576
29577 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29578 .cindex "&%verify%& ACL condition"
29579 .cindex "&ACL;" "verifying sender in the header"
29580 .cindex "header lines" "verifying the sender in"
29581 .cindex "sender" "verifying in header"
29582 .cindex "verifying" "sender in header"
29583 This condition is relevant only in an ACL that is run after a message has been
29584 received, that is, in an ACL specified by &%acl_smtp_data%& or
29585 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29586 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29587 is loosely thought of as a &"sender"& address (hence the name of the test).
29588 However, an address that appears in one of these headers need not be an address
29589 that accepts bounce messages; only sender addresses in envelopes are required
29590 to accept bounces. Therefore, if you use the callout option on this check, you
29591 might want to arrange for a non-empty address in the MAIL command.
29592
29593 Details of address verification and the options are given later, starting at
29594 section &<<SECTaddressverification>>& (callouts are described in section
29595 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29596 condition to restrict it to bounce messages only:
29597 .code
29598 deny    senders = :
29599         message = A valid sender header is required for bounces
29600        !verify  = header_sender
29601 .endd
29602
29603 .vitem &*verify&~=&~header_syntax*&
29604 .cindex "&%verify%& ACL condition"
29605 .cindex "&ACL;" "verifying header syntax"
29606 .cindex "header lines" "verifying syntax"
29607 .cindex "verifying" "header syntax"
29608 This condition is relevant only in an ACL that is run after a message has been
29609 received, that is, in an ACL specified by &%acl_smtp_data%& or
29610 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29611 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29612 and &'Bcc:'&), returning true if there are no problems.
29613 Unqualified addresses (local parts without domains) are
29614 permitted only in locally generated messages and from hosts that match
29615 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29616 appropriate.
29617
29618 Note that this condition is a syntax check only. However, a common spamming
29619 ploy used to be to send syntactically invalid headers such as
29620 .code
29621 To: @
29622 .endd
29623 and this condition can be used to reject such messages, though they are not as
29624 common as they used to be.
29625
29626 .vitem &*verify&~=&~helo*&
29627 .cindex "&%verify%& ACL condition"
29628 .cindex "&ACL;" "verifying HELO/EHLO"
29629 .cindex "HELO" "verifying"
29630 .cindex "EHLO" "verifying"
29631 .cindex "verifying" "EHLO"
29632 .cindex "verifying" "HELO"
29633 This condition is true if a HELO or EHLO command has been received from the
29634 client host, and its contents have been verified. If there has been no previous
29635 attempt to verify the HELO/EHLO contents, it is carried out when this
29636 condition is encountered. See the description of the &%helo_verify_hosts%& and
29637 &%helo_try_verify_hosts%& options for details of how to request verification
29638 independently of this condition.
29639
29640 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29641 option), this condition is always true.
29642
29643
29644 .vitem &*verify&~=&~not_blind*&
29645 .cindex "verifying" "not blind"
29646 .cindex "bcc recipients, verifying none"
29647 This condition checks that there are no blind (bcc) recipients in the message.
29648 Every envelope recipient must appear either in a &'To:'& header line or in a
29649 &'Cc:'& header line for this condition to be true. Local parts are checked
29650 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29651 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29652 used only in a DATA or non-SMTP ACL.
29653
29654 There are, of course, many legitimate messages that make use of blind (bcc)
29655 recipients. This check should not be used on its own for blocking messages.
29656
29657
29658 .vitem &*verify&~=&~recipient/*&<&'options'&>
29659 .cindex "&%verify%& ACL condition"
29660 .cindex "&ACL;" "verifying recipient"
29661 .cindex "recipient" "verifying"
29662 .cindex "verifying" "recipient"
29663 .vindex "&$address_data$&"
29664 This condition is relevant only after a RCPT command. It verifies the current
29665 recipient. Details of address verification are given later, starting at section
29666 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29667 of &$address_data$& is the last value that was set while routing the address.
29668 This applies even if the verification fails. When an address that is being
29669 verified is redirected to a single address, verification continues with the new
29670 address, and in that case, the subsequent value of &$address_data$& is the
29671 value for the child address.
29672
29673 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29674 .cindex "&%verify%& ACL condition"
29675 .cindex "&ACL;" "verifying host reverse lookup"
29676 .cindex "host" "verifying reverse lookup"
29677 This condition ensures that a verified host name has been looked up from the IP
29678 address of the client host. (This may have happened already if the host name
29679 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29680 Verification ensures that the host name obtained from a reverse DNS lookup, or
29681 one of its aliases, does, when it is itself looked up in the DNS, yield the
29682 original IP address.
29683
29684 There is one possible option, &`defer_ok`&.  If this is present and a
29685 DNS operation returns a temporary error, the verify condition succeeds.
29686
29687 If this condition is used for a locally generated message (that is, when there
29688 is no client host involved), it always succeeds.
29689
29690 .vitem &*verify&~=&~sender/*&<&'options'&>
29691 .cindex "&%verify%& ACL condition"
29692 .cindex "&ACL;" "verifying sender"
29693 .cindex "sender" "verifying"
29694 .cindex "verifying" "sender"
29695 This condition is relevant only after a MAIL or RCPT command, or after a
29696 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29697 the message's sender is empty (that is, this is a bounce message), the
29698 condition is true. Otherwise, the sender address is verified.
29699
29700 .vindex "&$address_data$&"
29701 .vindex "&$sender_address_data$&"
29702 If there is data in the &$address_data$& variable at the end of routing, its
29703 value is placed in &$sender_address_data$& at the end of verification. This
29704 value can be used in subsequent conditions and modifiers in the same ACL
29705 statement. It does not persist after the end of the current statement. If you
29706 want to preserve the value for longer, you can save it in an ACL variable.
29707
29708 Details of verification are given later, starting at section
29709 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29710 to avoid doing it more than once per message.
29711
29712 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29713 .cindex "&%verify%& ACL condition"
29714 This is a variation of the previous option, in which a modified address is
29715 verified as a sender.
29716 .endlist
29717
29718
29719
29720 .section "Using DNS lists" "SECTmorednslists"
29721 .cindex "DNS list" "in ACL"
29722 .cindex "black list (DNS)"
29723 .cindex "&ACL;" "testing a DNS list"
29724 In its simplest form, the &%dnslists%& condition tests whether the calling host
29725 is on at least one of a number of DNS lists by looking up the inverted IP
29726 address in one or more DNS domains. (Note that DNS list domains are not mail
29727 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29728 special options instead.) For example, if the calling host's IP
29729 address is 192.168.62.43, and the ACL statement is
29730 .code
29731 deny dnslists = blackholes.mail-abuse.org : \
29732                 dialups.mail-abuse.org
29733 .endd
29734 the following records are looked up:
29735 .code
29736 43.62.168.192.blackholes.mail-abuse.org
29737 43.62.168.192.dialups.mail-abuse.org
29738 .endd
29739 As soon as Exim finds an existing DNS record, processing of the list stops.
29740 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29741 to test that a host is on more than one list (an &"and"& conjunction), you can
29742 use two separate conditions:
29743 .code
29744 deny dnslists = blackholes.mail-abuse.org
29745      dnslists = dialups.mail-abuse.org
29746 .endd
29747 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29748 behaves as if the host does not match the list item, that is, as if the DNS
29749 record does not exist. If there are further items in the DNS list, they are
29750 processed.
29751
29752 This is usually the required action when &%dnslists%& is used with &%deny%&
29753 (which is the most common usage), because it prevents a DNS failure from
29754 blocking mail. However, you can change this behaviour by putting one of the
29755 following special items in the list:
29756 .display
29757 &`+include_unknown `&   behave as if the item is on the list
29758 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29759 &`+defer_unknown   `&   give a temporary error
29760 .endd
29761 .cindex "&`+include_unknown`&"
29762 .cindex "&`+exclude_unknown`&"
29763 .cindex "&`+defer_unknown`&"
29764 Each of these applies to any subsequent items on the list. For example:
29765 .code
29766 deny dnslists = +defer_unknown : foo.bar.example
29767 .endd
29768 Testing the list of domains stops as soon as a match is found. If you want to
29769 warn for one list and block for another, you can use two different statements:
29770 .code
29771 deny  dnslists = blackholes.mail-abuse.org
29772 warn  message  = X-Warn: sending host is on dialups list
29773       dnslists = dialups.mail-abuse.org
29774 .endd
29775 .cindex cacheing "of dns lookup"
29776 .cindex DNS TTL
29777 DNS list lookups are cached by Exim for the duration of the SMTP session
29778 (but limited by the DNS return TTL value),
29779 so a lookup based on the IP address is done at most once for any incoming
29780 connection (assuming long-enough TTL).
29781 Exim does not share information between multiple incoming
29782 connections (but your local name server cache should be active).
29783
29784
29785
29786 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29787 .cindex "DNS list" "keyed by explicit IP address"
29788 By default, the IP address that is used in a DNS list lookup is the IP address
29789 of the calling host. However, you can specify another IP address by listing it
29790 after the domain name, introduced by a slash. For example:
29791 .code
29792 deny dnslists = black.list.tld/192.168.1.2
29793 .endd
29794 This feature is not very helpful with explicit IP addresses; it is intended for
29795 use with IP addresses that are looked up, for example, the IP addresses of the
29796 MX hosts or nameservers of an email sender address. For an example, see section
29797 &<<SECTmulkeyfor>>& below.
29798
29799
29800
29801
29802 .section "DNS lists keyed on domain names" "SECID202"
29803 .cindex "DNS list" "keyed by domain name"
29804 There are some lists that are keyed on domain names rather than inverted IP
29805 addresses (see for example the &'domain based zones'& link at
29806 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29807 with these lists. You can change the name that is looked up in a DNS list by
29808 listing it after the domain name, introduced by a slash. For example,
29809 .code
29810 deny  message  = Sender's domain is listed at $dnslist_domain
29811       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29812 .endd
29813 This particular example is useful only in ACLs that are obeyed after the
29814 RCPT or DATA commands, when a sender address is available. If (for
29815 example) the message's sender is &'user@tld.example'& the name that is looked
29816 up by this example is
29817 .code
29818 tld.example.dsn.rfc-ignorant.org
29819 .endd
29820 A single &%dnslists%& condition can contain entries for both names and IP
29821 addresses. For example:
29822 .code
29823 deny dnslists = sbl.spamhaus.org : \
29824                 dsn.rfc-ignorant.org/$sender_address_domain
29825 .endd
29826 The first item checks the sending host's IP address; the second checks a domain
29827 name. The whole condition is true if either of the DNS lookups succeeds.
29828
29829
29830
29831
29832 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29833 .cindex "DNS list" "multiple keys for"
29834 The syntax described above for looking up explicitly-defined values (either
29835 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29836 name for the DNS list, what follows the slash can in fact be a list of items.
29837 As with all lists in Exim, the default separator is a colon. However, because
29838 this is a sublist within the list of DNS blacklist domains, it is necessary
29839 either to double the separators like this:
29840 .code
29841 dnslists = black.list.tld/name.1::name.2
29842 .endd
29843 or to change the separator character, like this:
29844 .code
29845 dnslists = black.list.tld/<;name.1;name.2
29846 .endd
29847 If an item in the list is an IP address, it is inverted before the DNS
29848 blacklist domain is appended. If it is not an IP address, no inversion
29849 occurs. Consider this condition:
29850 .code
29851 dnslists = black.list.tld/<;192.168.1.2;a.domain
29852 .endd
29853 The DNS lookups that occur are:
29854 .code
29855 2.1.168.192.black.list.tld
29856 a.domain.black.list.tld
29857 .endd
29858 Once a DNS record has been found (that matches a specific IP return
29859 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29860 are done. If there is a temporary DNS error, the rest of the sublist of domains
29861 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29862 only if no other DNS lookup in this sublist succeeds. In other words, a
29863 successful lookup for any of the items in the sublist overrides a temporary
29864 error for a previous item.
29865
29866 The ability to supply a list of items after the slash is in some sense just a
29867 syntactic convenience. These two examples have the same effect:
29868 .code
29869 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29870 dnslists = black.list.tld/a.domain::b.domain
29871 .endd
29872 However, when the data for the list is obtained from a lookup, the second form
29873 is usually much more convenient. Consider this example:
29874 .code
29875 deny message  = The mail servers for the domain \
29876                 $sender_address_domain \
29877                 are listed at $dnslist_domain ($dnslist_value); \
29878                 see $dnslist_text.
29879      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29880                                    ${lookup dnsdb {>|mxh=\
29881                                    $sender_address_domain} }} }
29882 .endd
29883 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29884 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29885 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29886 of expanding the condition might be something like this:
29887 .code
29888 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29889 .endd
29890 Thus, this example checks whether or not the IP addresses of the sender
29891 domain's mail servers are on the Spamhaus black list.
29892
29893 The key that was used for a successful DNS list lookup is put into the variable
29894 &$dnslist_matched$& (see section &<<SECID204>>&).
29895
29896
29897
29898
29899 .section "Data returned by DNS lists" "SECID203"
29900 .cindex "DNS list" "data returned from"
29901 DNS lists are constructed using address records in the DNS. The original RBL
29902 just used the address 127.0.0.1 on the right hand side of each record, but the
29903 RBL+ list and some other lists use a number of values with different meanings.
29904 The values used on the RBL+ list are:
29905 .display
29906 127.1.0.1  RBL
29907 127.1.0.2  DUL
29908 127.1.0.3  DUL and RBL
29909 127.1.0.4  RSS
29910 127.1.0.5  RSS and RBL
29911 127.1.0.6  RSS and DUL
29912 127.1.0.7  RSS and DUL and RBL
29913 .endd
29914 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29915 different values. Some DNS lists may return more than one address record;
29916 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29917
29918
29919 .section "Variables set from DNS lists" "SECID204"
29920 .cindex "expansion" "variables, set from DNS list"
29921 .cindex "DNS list" "variables set from"
29922 .vindex "&$dnslist_domain$&"
29923 .vindex "&$dnslist_matched$&"
29924 .vindex "&$dnslist_text$&"
29925 .vindex "&$dnslist_value$&"
29926 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29927 the name of the overall domain that matched (for example,
29928 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29929 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29930 the DNS record. When the key is an IP address, it is not reversed in
29931 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29932 cases, for example:
29933 .code
29934 deny dnslists = spamhaus.example
29935 .endd
29936 the key is also available in another variable (in this case,
29937 &$sender_host_address$&). In more complicated cases, however, this is not true.
29938 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29939 might generate a dnslists lookup like this:
29940 .code
29941 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29942 .endd
29943 If this condition succeeds, the value in &$dnslist_matched$& might be
29944 &`192.168.6.7`& (for example).
29945
29946 If more than one address record is returned by the DNS lookup, all the IP
29947 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29948 The variable &$dnslist_text$& contains the contents of any associated TXT
29949 record. For lists such as RBL+ the TXT record for a merged entry is often not
29950 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29951 information.
29952
29953 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29954 &-- although these appear before the condition in the ACL, they are not
29955 expanded until after it has failed. For example:
29956 .code
29957 deny    hosts = !+local_networks
29958         message = $sender_host_address is listed \
29959                   at $dnslist_domain
29960         dnslists = rbl-plus.mail-abuse.example
29961 .endd
29962
29963
29964
29965 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29966 .cindex "DNS list" "matching specific returned data"
29967 You can add an equals sign and an IP address after a &%dnslists%& domain name
29968 in order to restrict its action to DNS records with a matching right hand side.
29969 For example,
29970 .code
29971 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29972 .endd
29973 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29974 any address record is considered to be a match. For the moment, we assume
29975 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29976 describes how multiple records are handled.
29977
29978 More than one IP address may be given for checking, using a comma as a
29979 separator. These are alternatives &-- if any one of them matches, the
29980 &%dnslists%& condition is true. For example:
29981 .code
29982 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29983 .endd
29984 If you want to specify a constraining address list and also specify names or IP
29985 addresses to be looked up, the constraining address list must be specified
29986 first. For example:
29987 .code
29988 deny dnslists = dsn.rfc-ignorant.org\
29989                 =127.0.0.2/$sender_address_domain
29990 .endd
29991
29992 If the character &`&&`& is used instead of &`=`&, the comparison for each
29993 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29994 In other words, the listed addresses are used as bit masks. The comparison is
29995 true if all the bits in the mask are present in the address that is being
29996 tested. For example:
29997 .code
29998 dnslists = a.b.c&0.0.0.3
29999 .endd
30000 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30001 want to test whether one bit or another bit is present (as opposed to both
30002 being present), you must use multiple values. For example:
30003 .code
30004 dnslists = a.b.c&0.0.0.1,0.0.0.2
30005 .endd
30006 matches if the final component of the address is an odd number or two times
30007 an odd number.
30008
30009
30010
30011 .section "Negated DNS matching conditions" "SECID205"
30012 You can supply a negative list of IP addresses as part of a &%dnslists%&
30013 condition. Whereas
30014 .code
30015 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30016 .endd
30017 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30018 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30019 .code
30020 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30021 .endd
30022 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30023 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30024 words, the result of the test is inverted if an exclamation mark appears before
30025 the &`=`& (or the &`&&`&) sign.
30026
30027 &*Note*&: This kind of negation is not the same as negation in a domain,
30028 host, or address list (which is why the syntax is different).
30029
30030 If you are using just one list, the negation syntax does not gain you much. The
30031 previous example is precisely equivalent to
30032 .code
30033 deny  dnslists = a.b.c
30034      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30035 .endd
30036 However, if you are using multiple lists, the negation syntax is clearer.
30037 Consider this example:
30038 .code
30039 deny  dnslists = sbl.spamhaus.org : \
30040                  list.dsbl.org : \
30041                  dnsbl.njabl.org!=127.0.0.3 : \
30042                  relays.ordb.org
30043 .endd
30044 Using only positive lists, this would have to be:
30045 .code
30046 deny  dnslists = sbl.spamhaus.org : \
30047                  list.dsbl.org
30048 deny  dnslists = dnsbl.njabl.org
30049      !dnslists = dnsbl.njabl.org=127.0.0.3
30050 deny  dnslists = relays.ordb.org
30051 .endd
30052 which is less clear, and harder to maintain.
30053
30054
30055
30056
30057 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30058 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30059 thereby providing more than one IP address. When an item in a &%dnslists%& list
30060 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30061 the match to specific results from the DNS lookup, there are two ways in which
30062 the checking can be handled. For example, consider the condition:
30063 .code
30064 dnslists = a.b.c=127.0.0.1
30065 .endd
30066 What happens if the DNS lookup for the incoming IP address yields both
30067 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30068 condition true because at least one given value was found, or is it false
30069 because at least one of the found values was not listed? And how does this
30070 affect negated conditions? Both possibilities are provided for with the help of
30071 additional separators &`==`& and &`=&&`&.
30072
30073 .ilist
30074 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30075 IP addresses matches one of the listed addresses. For the example above, the
30076 condition is true because 127.0.0.1 matches.
30077 .next
30078 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30079 looked up IP addresses matches one of the listed addresses. If the condition is
30080 changed to:
30081 .code
30082 dnslists = a.b.c==127.0.0.1
30083 .endd
30084 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30085 false because 127.0.0.2 is not listed. You would need to have:
30086 .code
30087 dnslists = a.b.c==127.0.0.1,127.0.0.2
30088 .endd
30089 for the condition to be true.
30090 .endlist
30091
30092 When &`!`& is used to negate IP address matching, it inverts the result, giving
30093 the precise opposite of the behaviour above. Thus:
30094 .ilist
30095 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30096 addresses matches one of the listed addresses. Consider:
30097 .code
30098 dnslists = a.b.c!&0.0.0.1
30099 .endd
30100 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30101 false because 127.0.0.1 matches.
30102 .next
30103 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30104 looked up IP address that does not match. Consider:
30105 .code
30106 dnslists = a.b.c!=&0.0.0.1
30107 .endd
30108 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30109 true, because 127.0.0.2 does not match. You would need to have:
30110 .code
30111 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30112 .endd
30113 for the condition to be false.
30114 .endlist
30115 When the DNS lookup yields only a single IP address, there is no difference
30116 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30117
30118
30119
30120
30121 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30122 .cindex "DNS list" "information from merged"
30123 When the facility for restricting the matching IP values in a DNS list is used,
30124 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30125 the true reason for rejection. This happens when lists are merged and the IP
30126 address in the A record is used to distinguish them; unfortunately there is
30127 only one TXT record. One way round this is not to use merged lists, but that
30128 can be inefficient because it requires multiple DNS lookups where one would do
30129 in the vast majority of cases when the host of interest is not on any of the
30130 lists.
30131
30132 A less inefficient way of solving this problem is available. If
30133 two domain names, comma-separated, are given, the second is used first to
30134 do an initial check, making use of any IP value restrictions that are set.
30135 If there is a match, the first domain is used, without any IP value
30136 restrictions, to get the TXT record. As a byproduct of this, there is also
30137 a check that the IP being tested is indeed on the first list. The first
30138 domain is the one that is put in &$dnslist_domain$&. For example:
30139 .code
30140 reject message  = \
30141          rejected because $sender_host_address is blacklisted \
30142          at $dnslist_domain\n$dnslist_text
30143        dnslists = \
30144          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30145          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30146 .endd
30147 For the first blacklist item, this starts by doing a lookup in
30148 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30149 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30150 value, and as long as something is found, it looks for the corresponding TXT
30151 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30152 The second blacklist item is processed similarly.
30153
30154 If you are interested in more than one merged list, the same list must be
30155 given several times, but because the results of the DNS lookups are cached,
30156 the DNS calls themselves are not repeated. For example:
30157 .code
30158 reject dnslists = \
30159          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30160          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30161          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30162          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30163 .endd
30164 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30165 values matches (or if no record is found), this is the only lookup that is
30166 done. Only if there is a match is one of the more specific lists consulted.
30167
30168
30169
30170 .section "DNS lists and IPv6" "SECTmorednslistslast"
30171 .cindex "IPv6" "DNS black lists"
30172 .cindex "DNS list" "IPv6 usage"
30173 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30174 nibble by nibble. For example, if the calling host's IP address is
30175 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30176 .code
30177 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30178   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30179 .endd
30180 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30181 lists contain wildcard records, intended for IPv4, that interact badly with
30182 IPv6. For example, the DNS entry
30183 .code
30184 *.3.some.list.example.    A    127.0.0.1
30185 .endd
30186 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30187 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30188
30189 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30190 &%condition%& condition, as in this example:
30191 .code
30192 deny   condition = ${if isip4{$sender_host_address}}
30193        dnslists  = some.list.example
30194 .endd
30195
30196 If an explicit key is being used for a DNS lookup and it may be an IPv6
30197 address you should specify alternate list separators for both the outer
30198 (DNS list name) list and inner (lookup keys) list:
30199 .code
30200        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30201 .endd
30202
30203 .section "Rate limiting incoming messages" "SECTratelimiting"
30204 .cindex "rate limiting" "client sending"
30205 .cindex "limiting client sending rates"
30206 .oindex "&%smtp_ratelimit_*%&"
30207 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30208 which clients can send email. This is more powerful than the
30209 &%smtp_ratelimit_*%& options, because those options control the rate of
30210 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30211 works across all connections (concurrent and sequential) from the same client
30212 host. The syntax of the &%ratelimit%& condition is:
30213 .display
30214 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30215 .endd
30216 If the average client sending rate is less than &'m'& messages per time
30217 period &'p'& then the condition is false; otherwise it is true.
30218
30219 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30220 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30221 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30222 of &'p'&.
30223
30224 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30225 time interval, for example, &`8h`& for eight hours. A larger time constant
30226 means that it takes Exim longer to forget a client's past behaviour. The
30227 parameter &'m'& is the maximum number of messages that a client is permitted to
30228 send in each time interval. It also specifies the number of messages permitted
30229 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30230 constant, you can allow a client to send more messages in a burst without
30231 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30232 both small, messages must be sent at an even rate.
30233
30234 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30235 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30236 when deploying the &%ratelimit%& ACL condition. The script prints usage
30237 instructions when it is run with no arguments.
30238
30239 The key is used to look up the data for calculating the client's average
30240 sending rate. This data is stored in Exim's spool directory, alongside the
30241 retry and other hints databases. The default key is &$sender_host_address$&,
30242 which means Exim computes the sending rate of each client host IP address.
30243 By changing the key you can change how Exim identifies clients for the purpose
30244 of ratelimiting. For example, to limit the sending rate of each authenticated
30245 user, independent of the computer they are sending from, set the key to
30246 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30247 example, &$authenticated_id$& is only meaningful if the client has
30248 authenticated (which you can check with the &%authenticated%& ACL condition).
30249
30250 The lookup key does not have to identify clients: If you want to limit the
30251 rate at which a recipient receives messages, you can use the key
30252 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30253 ACL.
30254
30255 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30256 specifies what Exim measures the rate of, for example messages or recipients
30257 or bytes. You can adjust the measurement using the &%unique=%& and/or
30258 &%count=%& options. You can also control when Exim updates the recorded rate
30259 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30260 separated by a slash, like the other parameters. They may appear in any order.
30261
30262 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30263 any options that alter the meaning of the stored data. The limit &'m'& is not
30264 stored, so you can alter the configured maximum rate and Exim will still
30265 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30266 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30267 behaviour. The lookup key is not affected by changes to the update mode and
30268 the &%count=%& option.
30269
30270
30271 .section "Ratelimit options for what is being measured" "ratoptmea"
30272 .cindex "rate limiting" "per_* options"
30273 The &%per_conn%& option limits the client's connection rate. It is not
30274 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30275 &%acl_not_smtp_start%& ACLs.
30276
30277 The &%per_mail%& option limits the client's rate of sending messages. This is
30278 the default if none of the &%per_*%& options is specified. It can be used in
30279 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30280 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30281
30282 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30283 the same ACLs as the &%per_mail%& option, though it is best to use this option
30284 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30285 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30286 in its MAIL command, which may be inaccurate or completely missing. You can
30287 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30288 in kilobytes, megabytes, or gigabytes, respectively.
30289
30290 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30291 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30292 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30293 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30294 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30295 in either case the rate limiting engine will see a message with many
30296 recipients as a large high-speed burst.
30297
30298 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30299 number of different recipients that the client has sent messages to in the
30300 last time period. That is, if the client repeatedly sends messages to the same
30301 recipient, its measured rate is not increased. This option can only be used in
30302 &%acl_smtp_rcpt%&.
30303
30304 The &%per_cmd%& option causes Exim to recompute the rate every time the
30305 condition is processed. This can be used to limit the rate of any SMTP
30306 command. If it is used in multiple ACLs it can limit the aggregate rate of
30307 multiple different commands.
30308
30309 The &%count=%& option can be used to alter how much Exim adds to the client's
30310 measured rate. For example, the &%per_byte%& option is equivalent to
30311 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30312 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30313 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30314
30315 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30316
30317
30318 .section "Ratelimit update modes" "ratoptupd"
30319 .cindex "rate limiting" "reading data without updating"
30320 You can specify one of three options with the &%ratelimit%& condition to
30321 control when its database is updated. This section describes the &%readonly%&
30322 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30323
30324 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30325 previously-computed rate to check against the limit.
30326
30327 For example, you can test the client's sending rate and deny it access (when
30328 it is too fast) in the connect ACL. If the client passes this check then it
30329 can go on to send a message, in which case its recorded rate will be updated
30330 in the MAIL ACL. Subsequent connections from the same client will check this
30331 new rate.
30332 .code
30333 acl_check_connect:
30334  deny ratelimit = 100 / 5m / readonly
30335     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30336                   (max $sender_rate_limit)
30337 # ...
30338 acl_check_mail:
30339  warn ratelimit = 100 / 5m / strict
30340     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30341                   (max $sender_rate_limit)
30342 .endd
30343
30344 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30345 processing a message then it may increase the client's measured rate more than
30346 it should. For example, this will happen if you check the &%per_rcpt%& option
30347 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30348 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30349 multiple update problems by using the &%readonly%& option on later ratelimit
30350 checks.
30351
30352 The &%per_*%& options described above do not make sense in some ACLs. If you
30353 use a &%per_*%& option in an ACL where it is not normally permitted then the
30354 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30355 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30356 next section) so you must specify the &%readonly%& option explicitly.
30357
30358
30359 .section "Ratelimit options for handling fast clients" "ratoptfast"
30360 .cindex "rate limiting" "strict and leaky modes"
30361 If a client's average rate is greater than the maximum, the rate limiting
30362 engine can react in two possible ways, depending on the presence of the
30363 &%strict%& or &%leaky%& update modes. This is independent of the other
30364 counter-measures (such as rejecting the message) that may be specified by the
30365 rest of the ACL.
30366
30367 The &%leaky%& (default) option means that the client's recorded rate is not
30368 updated if it is above the limit. The effect of this is that Exim measures the
30369 client's average rate of successfully sent email, which cannot be greater than
30370 the maximum allowed. If the client is over the limit it may suffer some
30371 counter-measures (as specified in the ACL), but it will still be able to send
30372 email at the configured maximum rate, whatever the rate of its attempts. This
30373 is generally the better choice if you have clients that retry automatically.
30374 For example, it does not prevent a sender with an over-aggressive retry rate
30375 from getting any email through.
30376
30377 The &%strict%& option means that the client's recorded rate is always
30378 updated. The effect of this is that Exim measures the client's average rate
30379 of attempts to send email, which can be much higher than the maximum it is
30380 actually allowed. If the client is over the limit it may be subjected to
30381 counter-measures by the ACL. It must slow down and allow sufficient time to
30382 pass that its computed rate falls below the maximum before it can send email
30383 again. The time (the number of smoothing periods) it must wait and not
30384 attempt to send mail can be calculated with this formula:
30385 .code
30386         ln(peakrate/maxrate)
30387 .endd
30388
30389
30390 .section "Limiting the rate of different events" "ratoptuniq"
30391 .cindex "rate limiting" "counting unique events"
30392 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30393 rate of different events. For example, the &%per_addr%& option uses this
30394 mechanism to count the number of different recipients that the client has
30395 sent messages to in the last time period; it is equivalent to
30396 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30397 measure the rate that a client uses different sender addresses with the
30398 options &`per_mail/unique=$sender_address`&.
30399
30400 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30401 has seen for that key. The whole set is thrown away when it is older than the
30402 rate smoothing period &'p'&, so each different event is counted at most once
30403 per period. In the &%leaky%& update mode, an event that causes the client to
30404 go over the limit is not added to the set, in the same way that the client's
30405 recorded rate is not updated in the same situation.
30406
30407 When you combine the &%unique=%& and &%readonly%& options, the specific
30408 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30409 rate.
30410
30411 The &%unique=%& mechanism needs more space in the ratelimit database than the
30412 other &%ratelimit%& options in order to store the event set. The number of
30413 unique values is potentially as large as the rate limit, so the extra space
30414 required increases with larger limits.
30415
30416 The uniqueification is not perfect: there is a small probability that Exim
30417 will think a new event has happened before. If the sender's rate is less than
30418 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30419 the measured rate can go above the limit, in which case Exim may under-count
30420 events by a significant margin. Fortunately, if the rate is high enough (2.7
30421 times the limit) that the false positive rate goes above 9%, then Exim will
30422 throw away the over-full event set before the measured rate falls below the
30423 limit. Therefore the only harm should be that exceptionally high sending rates
30424 are logged incorrectly; any countermeasures you configure will be as effective
30425 as intended.
30426
30427
30428 .section "Using rate limiting" "useratlim"
30429 Exim's other ACL facilities are used to define what counter-measures are taken
30430 when the rate limit is exceeded. This might be anything from logging a warning
30431 (for example, while measuring existing sending rates in order to define
30432 policy), through time delays to slow down fast senders, up to rejecting the
30433 message. For example:
30434 .code
30435 # Log all senders' rates
30436 warn ratelimit = 0 / 1h / strict
30437      log_message = Sender rate $sender_rate / $sender_rate_period
30438
30439 # Slow down fast senders; note the need to truncate $sender_rate
30440 # at the decimal point.
30441 warn ratelimit = 100 / 1h / per_rcpt / strict
30442      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30443                    $sender_rate_limit }s
30444
30445 # Keep authenticated users under control
30446 deny authenticated = *
30447      ratelimit = 100 / 1d / strict / $authenticated_id
30448
30449 # System-wide rate limit
30450 defer message = Sorry, too busy. Try again later.
30451      ratelimit = 10 / 1s / $primary_hostname
30452
30453 # Restrict incoming rate from each host, with a default
30454 # set using a macro and special cases looked up in a table.
30455 defer message = Sender rate exceeds $sender_rate_limit \
30456                messages per $sender_rate_period
30457      ratelimit = ${lookup {$sender_host_address} \
30458                    cdb {DB/ratelimits.cdb} \
30459                    {$value} {RATELIMIT} }
30460 .endd
30461 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30462 especially with the &%per_rcpt%& option, you may suffer from a performance
30463 bottleneck caused by locking on the ratelimit hints database. Apart from
30464 making your ACLs less complicated, you can reduce the problem by using a
30465 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30466 this means that Exim will lose its hints data after a reboot (including retry
30467 hints, the callout cache, and ratelimit data).
30468
30469
30470
30471 .section "Address verification" "SECTaddressverification"
30472 .cindex "verifying address" "options for"
30473 .cindex "policy control" "address verification"
30474 Several of the &%verify%& conditions described in section
30475 &<<SECTaclconditions>>& cause addresses to be verified. Section
30476 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30477 The verification conditions can be followed by options that modify the
30478 verification process. The options are separated from the keyword and from each
30479 other by slashes, and some of them contain parameters. For example:
30480 .code
30481 verify = sender/callout
30482 verify = recipient/defer_ok/callout=10s,defer_ok
30483 .endd
30484 The first stage of address verification, which always happens, is to run the
30485 address through the routers, in &"verify mode"&. Routers can detect the
30486 difference between verification and routing for delivery, and their actions can
30487 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30488 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30489 The available options are as follows:
30490
30491 .ilist
30492 If the &%callout%& option is specified, successful routing to one or more
30493 remote hosts is followed by a &"callout"& to those hosts as an additional
30494 check. Callouts and their sub-options are discussed in the next section.
30495 .next
30496 If there is a defer error while doing verification routing, the ACL
30497 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30498 options, the condition is forced to be true instead. Note that this is a main
30499 verification option as well as a suboption for callouts.
30500 .next
30501 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30502 discusses the reporting of sender address verification failures.
30503 .next
30504 The &%success_on_redirect%& option causes verification always to succeed
30505 immediately after a successful redirection. By default, if a redirection
30506 generates just one address, that address is also verified. See further
30507 discussion in section &<<SECTredirwhilveri>>&.
30508 .endlist
30509
30510 .cindex "verifying address" "differentiating failures"
30511 .vindex "&$recipient_verify_failure$&"
30512 .vindex "&$sender_verify_failure$&"
30513 .vindex "&$acl_verify_message$&"
30514 After an address verification failure, &$acl_verify_message$& contains the
30515 error message that is associated with the failure. It can be preserved by
30516 coding like this:
30517 .code
30518 warn  !verify = sender
30519        set acl_m0 = $acl_verify_message
30520 .endd
30521 If you are writing your own custom rejection message or log message when
30522 denying access, you can use this variable to include information about the
30523 verification failure.
30524
30525 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30526 appropriate) contains one of the following words:
30527
30528 .ilist
30529 &%qualify%&: The address was unqualified (no domain), and the message
30530 was neither local nor came from an exempted host.
30531 .next
30532 &%route%&: Routing failed.
30533 .next
30534 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30535 occurred at or before the MAIL command (that is, on initial
30536 connection, HELO, or MAIL).
30537 .next
30538 &%recipient%&: The RCPT command in a callout was rejected.
30539 .next
30540 &%postmaster%&: The postmaster check in a callout was rejected.
30541 .endlist
30542
30543 The main use of these variables is expected to be to distinguish between
30544 rejections of MAIL and rejections of RCPT in callouts.
30545
30546
30547
30548
30549 .section "Callout verification" "SECTcallver"
30550 .cindex "verifying address" "by callout"
30551 .cindex "callout" "verification"
30552 .cindex "SMTP" "callout verification"
30553 For non-local addresses, routing verifies the domain, but is unable to do any
30554 checking of the local part. There are situations where some means of verifying
30555 the local part is desirable. One way this can be done is to make an SMTP
30556 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30557 a subsequent host for a recipient address, to see if the host accepts the
30558 address. We use the term &'callout'& to cover both cases. Note that for a
30559 sender address, the callback is not to the client host that is trying to
30560 deliver the message, but to one of the hosts that accepts incoming mail for the
30561 sender's domain.
30562
30563 Exim does not do callouts by default. If you want them to happen, you must
30564 request them by setting appropriate options on the &%verify%& condition, as
30565 described below. This facility should be used with care, because it can add a
30566 lot of resource usage to the cost of verifying an address. However, Exim does
30567 cache the results of callouts, which helps to reduce the cost. Details of
30568 caching are in section &<<SECTcallvercache>>&.
30569
30570 Recipient callouts are usually used only between hosts that are controlled by
30571 the same administration. For example, a corporate gateway host could use
30572 callouts to check for valid recipients on an internal mailserver. A successful
30573 callout does not guarantee that a real delivery to the address would succeed;
30574 on the other hand, a failing callout does guarantee that a delivery would fail.
30575
30576 If the &%callout%& option is present on a condition that verifies an address, a
30577 second stage of verification occurs if the address is successfully routed to
30578 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30579 &(manualroute)& router, where the router specifies the hosts. However, if a
30580 router that does not set up hosts routes to an &(smtp)& transport with a
30581 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30582 &%hosts_override%& set, its hosts are always used, whether or not the router
30583 supplies a host list.
30584 Callouts are only supported on &(smtp)& transports.
30585
30586 The port that is used is taken from the transport, if it is specified and is a
30587 remote transport. (For routers that do verification only, no transport need be
30588 specified.) Otherwise, the default SMTP port is used. If a remote transport
30589 specifies an outgoing interface, this is used; otherwise the interface is not
30590 specified. Likewise, the text that is used for the HELO command is taken from
30591 the transport's &%helo_data%& option; if there is no transport, the value of
30592 &$smtp_active_hostname$& is used.
30593
30594 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30595 test whether a bounce message could be delivered to the sender address. The
30596 following SMTP commands are sent:
30597 .display
30598 &`HELO `&<&'local host name'&>
30599 &`MAIL FROM:<>`&
30600 &`RCPT TO:`&<&'the address to be tested'&>
30601 &`QUIT`&
30602 .endd
30603 LHLO is used instead of HELO if the transport's &%protocol%& option is
30604 set to &"lmtp"&.
30605
30606 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30607 settings.
30608
30609 A recipient callout check is similar. By default, it also uses an empty address
30610 for the sender. This default is chosen because most hosts do not make use of
30611 the sender address when verifying a recipient. Using the same address means
30612 that a single cache entry can be used for each recipient. Some sites, however,
30613 do make use of the sender address when verifying. These are catered for by the
30614 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30615
30616 If the response to the RCPT command is a 2&'xx'& code, the verification
30617 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30618 Exim tries the next host, if any. If there is a problem with all the remote
30619 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30620 &%callout%& option is given, in which case the condition is forced to succeed.
30621
30622 .cindex "SMTP" "output flushing, disabling for callout"
30623 A callout may take a little time. For this reason, Exim normally flushes SMTP
30624 output before performing a callout in an ACL, to avoid unexpected timeouts in
30625 clients when the SMTP PIPELINING extension is in use. The flushing can be
30626 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30627
30628
30629
30630
30631 .section "Additional parameters for callouts" "CALLaddparcall"
30632 .cindex "callout" "additional parameters for"
30633 The &%callout%& option can be followed by an equals sign and a number of
30634 optional parameters, separated by commas. For example:
30635 .code
30636 verify = recipient/callout=10s,defer_ok
30637 .endd
30638 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30639 separate verify options, is retained for backwards compatibility, but is now
30640 deprecated. The additional parameters for &%callout%& are as follows:
30641
30642
30643 .vlist
30644 .vitem <&'a&~time&~interval'&>
30645 .cindex "callout" "timeout, specifying"
30646 This specifies the timeout that applies for the callout attempt to each host.
30647 For example:
30648 .code
30649 verify = sender/callout=5s
30650 .endd
30651 The default is 30 seconds. The timeout is used for each response from the
30652 remote host. It is also used for the initial connection, unless overridden by
30653 the &%connect%& parameter.
30654
30655
30656 .vitem &*connect&~=&~*&<&'time&~interval'&>
30657 .cindex "callout" "connection timeout, specifying"
30658 This parameter makes it possible to set a different (usually smaller) timeout
30659 for making the SMTP connection. For example:
30660 .code
30661 verify = sender/callout=5s,connect=1s
30662 .endd
30663 If not specified, this timeout defaults to the general timeout value.
30664
30665 .vitem &*defer_ok*&
30666 .cindex "callout" "defer, action on"
30667 When this parameter is present, failure to contact any host, or any other kind
30668 of temporary error, is treated as success by the ACL. However, the cache is not
30669 updated in this circumstance.
30670
30671 .vitem &*fullpostmaster*&
30672 .cindex "callout" "full postmaster check"
30673 This operates like the &%postmaster%& option (see below), but if the check for
30674 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30675 accordance with the specification in RFC 2821. The RFC states that the
30676 unqualified address &'postmaster'& should be accepted.
30677
30678
30679 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30680 .cindex "callout" "sender when verifying header"
30681 When verifying addresses in header lines using the &%header_sender%&
30682 verification option, Exim behaves by default as if the addresses are envelope
30683 sender addresses from a message. Callout verification therefore tests to see
30684 whether a bounce message could be delivered, by using an empty address in the
30685 MAIL command. However, it is arguable that these addresses might never be used
30686 as envelope senders, and could therefore justifiably reject bounce messages
30687 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30688 address to use in the MAIL command. For example:
30689 .code
30690 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30691 .endd
30692 This parameter is available only for the &%header_sender%& verification option.
30693
30694
30695 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30696 .cindex "callout" "overall timeout, specifying"
30697 This parameter sets an overall timeout for performing a callout verification.
30698 For example:
30699 .code
30700 verify = sender/callout=5s,maxwait=30s
30701 .endd
30702 This timeout defaults to four times the callout timeout for individual SMTP
30703 commands. The overall timeout applies when there is more than one host that can
30704 be tried. The timeout is checked before trying the next host. This prevents
30705 very long delays if there are a large number of hosts and all are timing out
30706 (for example, when network connections are timing out).
30707
30708
30709 .vitem &*no_cache*&
30710 .cindex "callout" "cache, suppressing"
30711 .cindex "caching callout, suppressing"
30712 When this parameter is given, the callout cache is neither read nor updated.
30713
30714 .vitem &*postmaster*&
30715 .cindex "callout" "postmaster; checking"
30716 When this parameter is set, a successful callout check is followed by a similar
30717 check for the local part &'postmaster'& at the same domain. If this address is
30718 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30719 the postmaster check is recorded in a cache record; if it is a failure, this is
30720 used to fail subsequent callouts for the domain without a connection being
30721 made, until the cache record expires.
30722
30723 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30724 The postmaster check uses an empty sender in the MAIL command by default.
30725 You can use this parameter to do a postmaster check using a different address.
30726 For example:
30727 .code
30728 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30729 .endd
30730 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30731 one overrides. The &%postmaster%& parameter is equivalent to this example:
30732 .code
30733 require  verify = sender/callout=postmaster_mailfrom=
30734 .endd
30735 &*Warning*&: The caching arrangements for postmaster checking do not take
30736 account of the sender address. It is assumed that either the empty address or
30737 a fixed non-empty address will be used. All that Exim remembers is that the
30738 postmaster check for the domain succeeded or failed.
30739
30740
30741 .vitem &*random*&
30742 .cindex "callout" "&""random""& check"
30743 When this parameter is set, before doing the normal callout check, Exim does a
30744 check for a &"random"& local part at the same domain. The local part is not
30745 really random &-- it is defined by the expansion of the option
30746 &%callout_random_local_part%&, which defaults to
30747 .code
30748 $primary_hostname-$tod_epoch-testing
30749 .endd
30750 The idea here is to try to determine whether the remote host accepts all local
30751 parts without checking. If it does, there is no point in doing callouts for
30752 specific local parts. If the &"random"& check succeeds, the result is saved in
30753 a cache record, and used to force the current and subsequent callout checks to
30754 succeed without a connection being made, until the cache record expires.
30755
30756 .vitem &*use_postmaster*&
30757 .cindex "callout" "sender for recipient check"
30758 This parameter applies to recipient callouts only. For example:
30759 .code
30760 deny  !verify = recipient/callout=use_postmaster
30761 .endd
30762 .vindex "&$qualify_domain$&"
30763 It causes a non-empty postmaster address to be used in the MAIL command when
30764 performing the callout for the recipient, and also for a &"random"& check if
30765 that is configured. The local part of the address is &`postmaster`& and the
30766 domain is the contents of &$qualify_domain$&.
30767
30768 .vitem &*use_sender*&
30769 This option applies to recipient callouts only. For example:
30770 .code
30771 require  verify = recipient/callout=use_sender
30772 .endd
30773 It causes the message's actual sender address to be used in the MAIL
30774 command when performing the callout, instead of an empty address. There is no
30775 need to use this option unless you know that the called hosts make use of the
30776 sender when checking recipients. If used indiscriminately, it reduces the
30777 usefulness of callout caching.
30778 .endlist
30779
30780 If you use any of the parameters that set a non-empty sender for the MAIL
30781 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30782 &%use_sender%&), you should think about possible loops. Recipient checking is
30783 usually done between two hosts that are under the same management, and the host
30784 that receives the callouts is not normally configured to do callouts itself.
30785 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30786 these circumstances.
30787
30788 However, if you use a non-empty sender address for a callout to an arbitrary
30789 host, there is the likelihood that the remote host will itself initiate a
30790 callout check back to your host. As it is checking what appears to be a message
30791 sender, it is likely to use an empty address in MAIL, thus avoiding a
30792 callout loop. However, to be on the safe side it would be best to set up your
30793 own ACLs so that they do not do sender verification checks when the recipient
30794 is the address you use for header sender or postmaster callout checking.
30795
30796 Another issue to think about when using non-empty senders for callouts is
30797 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30798 by the sender/recipient combination; thus, for any given recipient, many more
30799 actual callouts are performed than when an empty sender or postmaster is used.
30800
30801
30802
30803
30804 .section "Callout caching" "SECTcallvercache"
30805 .cindex "hints database" "callout cache"
30806 .cindex "callout" "cache, description of"
30807 .cindex "caching" "callout"
30808 Exim caches the results of callouts in order to reduce the amount of resources
30809 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30810 option. A hints database called &"callout"& is used for the cache. Two
30811 different record types are used: one records the result of a callout check for
30812 a specific address, and the other records information that applies to the
30813 entire domain (for example, that it accepts the local part &'postmaster'&).
30814
30815 When an original callout fails, a detailed SMTP error message is given about
30816 the failure. However, for subsequent failures use the cache data, this message
30817 is not available.
30818
30819 The expiry times for negative and positive address cache records are
30820 independent, and can be set by the global options &%callout_negative_expire%&
30821 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30822
30823 If a host gives a negative response to an SMTP connection, or rejects any
30824 commands up to and including
30825 .code
30826 MAIL FROM:<>
30827 .endd
30828 (but not including the MAIL command with a non-empty address),
30829 any callout attempt is bound to fail. Exim remembers such failures in a
30830 domain cache record, which it uses to fail callouts for the domain without
30831 making new connections, until the domain record times out. There are two
30832 separate expiry times for domain cache records:
30833 &%callout_domain_negative_expire%& (default 3h) and
30834 &%callout_domain_positive_expire%& (default 7d).
30835
30836 Domain records expire when the negative expiry time is reached if callouts
30837 cannot be made for the domain, or if the postmaster check failed.
30838 Otherwise, they expire when the positive expiry time is reached. This
30839 ensures that, for example, a host that stops accepting &"random"& local parts
30840 will eventually be noticed.
30841
30842 The callout caching mechanism is based on the domain of the address that is
30843 being tested. If the domain routes to several hosts, it is assumed that their
30844 behaviour will be the same.
30845
30846
30847
30848 .section "Sender address verification reporting" "SECTsenaddver"
30849 .cindex "verifying" "suppressing error details"
30850 See section &<<SECTaddressverification>>& for a general discussion of
30851 verification. When sender verification fails in an ACL, the details of the
30852 failure are given as additional output lines before the 550 response to the
30853 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30854 you might see:
30855 .code
30856 MAIL FROM:<xyz@abc.example>
30857 250 OK
30858 RCPT TO:<pqr@def.example>
30859 550-Verification failed for <xyz@abc.example>
30860 550-Called:   192.168.34.43
30861 550-Sent:     RCPT TO:<xyz@abc.example>
30862 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30863 550 Sender verification failed
30864 .endd
30865 If more than one RCPT command fails in the same way, the details are given
30866 only for the first of them. However, some administrators do not want to send
30867 out this much information. You can suppress the details by adding
30868 &`/no_details`& to the ACL statement that requests sender verification. For
30869 example:
30870 .code
30871 verify = sender/no_details
30872 .endd
30873
30874 .section "Redirection while verifying" "SECTredirwhilveri"
30875 .cindex "verifying" "redirection while"
30876 .cindex "address redirection" "while verifying"
30877 A dilemma arises when a local address is redirected by aliasing or forwarding
30878 during verification: should the generated addresses themselves be verified,
30879 or should the successful expansion of the original address be enough to verify
30880 it? By default, Exim takes the following pragmatic approach:
30881
30882 .ilist
30883 When an incoming address is redirected to just one child address, verification
30884 continues with the child address, and if that fails to verify, the original
30885 verification also fails.
30886 .next
30887 When an incoming address is redirected to more than one child address,
30888 verification does not continue. A success result is returned.
30889 .endlist
30890
30891 This seems the most reasonable behaviour for the common use of aliasing as a
30892 way of redirecting different local parts to the same mailbox. It means, for
30893 example, that a pair of alias entries of the form
30894 .code
30895 A.Wol:   aw123
30896 aw123:   :fail: Gone away, no forwarding address
30897 .endd
30898 work as expected, with both local parts causing verification failure. When a
30899 redirection generates more than one address, the behaviour is more like a
30900 mailing list, where the existence of the alias itself is sufficient for
30901 verification to succeed.
30902
30903 It is possible, however, to change the default behaviour so that all successful
30904 redirections count as successful verifications, however many new addresses are
30905 generated. This is specified by the &%success_on_redirect%& verification
30906 option. For example:
30907 .code
30908 require verify = recipient/success_on_redirect/callout=10s
30909 .endd
30910 In this example, verification succeeds if a router generates a new address, and
30911 the callout does not occur, because no address was routed to a remote host.
30912
30913 When verification is being tested via the &%-bv%& option, the treatment of
30914 redirections is as just described, unless the &%-v%& or any debugging option is
30915 also specified. In that case, full verification is done for every generated
30916 address and a report is output for each of them.
30917
30918
30919
30920 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30921 .cindex "CSA" "verifying"
30922 Client SMTP Authorization is a system that allows a site to advertise
30923 which machines are and are not permitted to send email. This is done by placing
30924 special SRV records in the DNS; these are looked up using the client's HELO
30925 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30926 Authorization checks in Exim are performed by the ACL condition:
30927 .code
30928 verify = csa
30929 .endd
30930 This fails if the client is not authorized. If there is a DNS problem, or if no
30931 valid CSA SRV record is found, or if the client is authorized, the condition
30932 succeeds. These three cases can be distinguished using the expansion variable
30933 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30934 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30935 be likely to cause problems for legitimate email.
30936
30937 The error messages produced by the CSA code include slightly more
30938 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30939 looking up the CSA SRV record, or problems looking up the CSA target
30940 address record. There are four reasons for &$csa_status$& being &"fail"&:
30941
30942 .ilist
30943 The client's host name is explicitly not authorized.
30944 .next
30945 The client's IP address does not match any of the CSA target IP addresses.
30946 .next
30947 The client's host name is authorized but it has no valid target IP addresses
30948 (for example, the target's addresses are IPv6 and the client is using IPv4).
30949 .next
30950 The client's host name has no CSA SRV record but a parent domain has asserted
30951 that all subdomains must be explicitly authorized.
30952 .endlist
30953
30954 The &%csa%& verification condition can take an argument which is the domain to
30955 use for the DNS query. The default is:
30956 .code
30957 verify = csa/$sender_helo_name
30958 .endd
30959 This implementation includes an extension to CSA. If the query domain
30960 is an address literal such as [192.0.2.95], or if it is a bare IP
30961 address, Exim searches for CSA SRV records in the reverse DNS as if
30962 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30963 meaningful to say:
30964 .code
30965 verify = csa/$sender_host_address
30966 .endd
30967 In fact, this is the check that Exim performs if the client does not say HELO.
30968 This extension can be turned off by setting the main configuration option
30969 &%dns_csa_use_reverse%& to be false.
30970
30971 If a CSA SRV record is not found for the domain itself, a search
30972 is performed through its parent domains for a record which might be
30973 making assertions about subdomains. The maximum depth of this search is limited
30974 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30975 default. Exim does not look for CSA SRV records in a top level domain, so the
30976 default settings handle HELO domains as long as seven
30977 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30978 of legitimate HELO domains.
30979
30980 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30981 direct SRV lookups, this is not sufficient because of the extra parent domain
30982 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30983 addresses into lookups in the reverse DNS space. The result of a successful
30984 lookup such as:
30985 .code
30986 ${lookup dnsdb {csa=$sender_helo_name}}
30987 .endd
30988 has two space-separated fields: an authorization code and a target host name.
30989 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30990 authorization required but absent, or &"?"& for unknown.
30991
30992
30993
30994
30995 .section "Bounce address tag validation" "SECTverifyPRVS"
30996 .cindex "BATV, verifying"
30997 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30998 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30999 Genuine incoming bounce messages should therefore always be addressed to
31000 recipients that have a valid tag. This scheme is a way of detecting unwanted
31001 bounce messages caused by sender address forgeries (often called &"collateral
31002 spam"&), because the recipients of such messages do not include valid tags.
31003
31004 There are two expansion items to help with the implementation of the BATV
31005 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31006 the original envelope sender address by using a simple key to add a hash of the
31007 address and some time-based randomizing information. The &%prvs%& expansion
31008 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31009 The syntax of these expansion items is described in section
31010 &<<SECTexpansionitems>>&.
31011
31012 As an example, suppose the secret per-address keys are stored in an MySQL
31013 database. A query to look up the key for an address could be defined as a macro
31014 like this:
31015 .code
31016 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31017                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31018                 }{$value}}
31019 .endd
31020 Suppose also that the senders who make use of BATV are defined by an address
31021 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31022 use this:
31023 .code
31024 # Bounces: drop unsigned addresses for BATV senders
31025 deny message = This address does not send an unsigned reverse path
31026      senders = :
31027      recipients = +batv_senders
31028
31029 # Bounces: In case of prvs-signed address, check signature.
31030 deny message = Invalid reverse path signature.
31031      senders = :
31032      condition  = ${prvscheck {$local_part@$domain}\
31033                   {PRVSCHECK_SQL}{1}}
31034      !condition = $prvscheck_result
31035 .endd
31036 The first statement rejects recipients for bounce messages that are addressed
31037 to plain BATV sender addresses, because it is known that BATV senders do not
31038 send out messages with plain sender addresses. The second statement rejects
31039 recipients that are prvs-signed, but with invalid signatures (either because
31040 the key is wrong, or the signature has timed out).
31041
31042 A non-prvs-signed address is not rejected by the second statement, because the
31043 &%prvscheck%& expansion yields an empty string if its first argument is not a
31044 prvs-signed address, thus causing the &%condition%& condition to be false. If
31045 the first argument is a syntactically valid prvs-signed address, the yield is
31046 the third string (in this case &"1"&), whether or not the cryptographic and
31047 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31048 of the checks (empty for failure, &"1"& for success).
31049
31050 There is one more issue you must consider when implementing prvs-signing:
31051 you have to ensure that the routers accept prvs-signed addresses and
31052 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31053 router to remove the signature with a configuration along these lines:
31054 .code
31055 batv_redirect:
31056   driver = redirect
31057   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31058 .endd
31059 This works because, if the third argument of &%prvscheck%& is empty, the result
31060 of the expansion of a prvs-signed address is the decoded value of the original
31061 address. This router should probably be the first of your routers that handles
31062 local addresses.
31063
31064 To create BATV-signed addresses in the first place, a transport of this form
31065 can be used:
31066 .code
31067 external_smtp_batv:
31068   driver = smtp
31069   return_path = ${prvs {$return_path} \
31070                        {${lookup mysql{SELECT \
31071                        secret FROM batv_prvs WHERE \
31072                        sender='${quote_mysql:$sender_address}'} \
31073                        {$value}fail}}}
31074 .endd
31075 If no key can be found for the existing return path, no signing takes place.
31076
31077
31078
31079 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31080 .cindex "&ACL;" "relay control"
31081 .cindex "relaying" "control by ACL"
31082 .cindex "policy control" "relay control"
31083 An MTA is said to &'relay'& a message if it receives it from some host and
31084 delivers it directly to another host as a result of a remote address contained
31085 within it. Redirecting a local address via an alias or forward file and then
31086 passing the message on to another host is not relaying,
31087 .cindex "&""percent hack""&"
31088 but a redirection as a result of the &"percent hack"& is.
31089
31090 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31091 A host which is acting as a gateway or an MX backup is concerned with incoming
31092 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31093 a host which is acting as a smart host for a number of clients is concerned
31094 with outgoing relaying from those clients to the Internet at large. Often the
31095 same host is fulfilling both functions,
31096 . ///
31097 . as illustrated in the diagram below,
31098 . ///
31099 but in principle these two kinds of relaying are entirely independent. What is
31100 not wanted is the transmission of mail from arbitrary remote hosts through your
31101 system to arbitrary domains.
31102
31103
31104 You can implement relay control by means of suitable statements in the ACL that
31105 runs for each RCPT command. For convenience, it is often easiest to use
31106 Exim's named list facility to define the domains and hosts involved. For
31107 example, suppose you want to do the following:
31108
31109 .ilist
31110 Deliver a number of domains to mailboxes on the local host (or process them
31111 locally in some other way). Let's say these are &'my.dom1.example'& and
31112 &'my.dom2.example'&.
31113 .next
31114 Relay mail for a number of other domains for which you are the secondary MX.
31115 These might be &'friend1.example'& and &'friend2.example'&.
31116 .next
31117 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31118 Suppose your LAN is 192.168.45.0/24.
31119 .endlist
31120
31121
31122 In the main part of the configuration, you put the following definitions:
31123 .code
31124 domainlist local_domains    = my.dom1.example : my.dom2.example
31125 domainlist relay_to_domains = friend1.example : friend2.example
31126 hostlist   relay_from_hosts = 192.168.45.0/24
31127 .endd
31128 Now you can use these definitions in the ACL that is run for every RCPT
31129 command:
31130 .code
31131 acl_check_rcpt:
31132   accept domains = +local_domains : +relay_to_domains
31133   accept hosts   = +relay_from_hosts
31134 .endd
31135 The first statement accepts any RCPT command that contains an address in
31136 the local or relay domains. For any other domain, control passes to the second
31137 statement, which accepts the command only if it comes from one of the relay
31138 hosts. In practice, you will probably want to make your ACL more sophisticated
31139 than this, for example, by including sender and recipient verification. The
31140 default configuration includes a more comprehensive example, which is described
31141 in chapter &<<CHAPdefconfil>>&.
31142
31143
31144
31145 .section "Checking a relay configuration" "SECTcheralcon"
31146 .cindex "relaying" "checking control of"
31147 You can check the relay characteristics of your configuration in the same way
31148 that you can test any ACL behaviour for an incoming SMTP connection, by using
31149 the &%-bh%& option to run a fake SMTP session with which you interact.
31150 .ecindex IIDacl
31151
31152
31153
31154 . ////////////////////////////////////////////////////////////////////////////
31155 . ////////////////////////////////////////////////////////////////////////////
31156
31157 .chapter "Content scanning at ACL time" "CHAPexiscan"
31158 .scindex IIDcosca "content scanning" "at ACL time"
31159 The extension of Exim to include content scanning at ACL time, formerly known
31160 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31161 was integrated into the main source for Exim release 4.50, and Tom continues to
31162 maintain it. Most of the wording of this chapter is taken from Tom's
31163 specification.
31164
31165 It is also possible to scan the content of messages at other times. The
31166 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31167 scanning after all the ACLs have run. A transport filter can be used to scan
31168 messages at delivery time (see the &%transport_filter%& option, described in
31169 chapter &<<CHAPtransportgeneric>>&).
31170
31171 If you want to include the ACL-time content-scanning features when you compile
31172 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31173 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31174
31175 .ilist
31176 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31177 for all MIME parts for SMTP and non-SMTP messages, respectively.
31178 .next
31179 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31180 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31181 run at the end of message reception (the &%acl_smtp_data%& ACL).
31182 .next
31183 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31184 of messages, or parts of messages, for debugging purposes.
31185 .next
31186 Additional expansion variables that are set in the new ACL and by the new
31187 conditions.
31188 .next
31189 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31190 .endlist
31191
31192 Content-scanning is continually evolving, and new features are still being
31193 added. While such features are still unstable and liable to incompatible
31194 changes, they are made available in Exim by setting options whose names begin
31195 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31196 this manual. You can find out about them by reading the file called
31197 &_doc/experimental.txt_&.
31198
31199 All the content-scanning facilities work on a MBOX copy of the message that is
31200 temporarily created in a file called:
31201 .display
31202 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31203 .endd
31204 The &_.eml_& extension is a friendly hint to virus scanners that they can
31205 expect an MBOX-like structure inside that file. The file is created when the
31206 first content scanning facility is called. Subsequent calls to content
31207 scanning conditions open the same file again. The directory is recursively
31208 removed when the &%acl_smtp_data%& ACL has finished running, unless
31209 .code
31210 control = no_mbox_unspool
31211 .endd
31212 has been encountered. When the MIME ACL decodes files, they are put into the
31213 same directory by default.
31214
31215
31216
31217 .section "Scanning for viruses" "SECTscanvirus"
31218 .cindex "virus scanning"
31219 .cindex "content scanning" "for viruses"
31220 .cindex "content scanning" "the &%malware%& condition"
31221 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31222 It supports a &"generic"& interface to scanners called via the shell, and
31223 specialized interfaces for &"daemon"& type virus scanners, which are resident
31224 in memory and thus are much faster.
31225
31226 A timeout of 2 minutes is applied to a scanner call (by default);
31227 if it expires then a defer action is taken.
31228
31229 .oindex "&%av_scanner%&"
31230 You can set the &%av_scanner%& option in the main part of the configuration
31231 to specify which scanner to use, together with any additional options that
31232 are needed. The basic syntax is as follows:
31233 .display
31234 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31235 .endd
31236 If you do not set &%av_scanner%&, it defaults to
31237 .code
31238 av_scanner = sophie:/var/run/sophie
31239 .endd
31240 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31241 before use.
31242 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31243 The following scanner types are supported in this release:
31244
31245 .vlist
31246 .vitem &%avast%&
31247 .cindex "virus scanners" "avast"
31248 This is the scanner daemon of Avast. It has been tested with Avast Core
31249 Security (currently at version 1.1.7).
31250 You can get a trial version at &url(http://www.avast.com) or for Linux
31251 at &url(http://www.avast.com/linux-server-antivirus).
31252 This scanner type takes one option,
31253 which can be either a full path to a UNIX socket,
31254 or host and port specifiers separated by white space.
31255 The host may be a name or an IP address; the port is either a
31256 single number or a pair of numbers with a dash between.
31257 Any further options are given, on separate lines,
31258 to the daemon as options before the main scan command.
31259 For example:
31260 .code
31261 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31262 av_scanner = avast:192.168.2.22 5036
31263 .endd
31264 If you omit the argument, the default path
31265 &_/var/run/avast/scan.sock_&
31266 is used.
31267 If you use a remote host,
31268 you need to make Exim's spool directory available to it,
31269 as the scanner is passed a file path, not file contents.
31270 For information about available commands and their options you may use
31271 .code
31272 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31273     FLAGS
31274     SENSITIVITY
31275     PACK
31276 .endd
31277
31278
31279 .vitem &%aveserver%&
31280 .cindex "virus scanners" "Kaspersky"
31281 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31282 at &url(http://www.kaspersky.com). This scanner type takes one option,
31283 which is the path to the daemon's UNIX socket. The default is shown in this
31284 example:
31285 .code
31286 av_scanner = aveserver:/var/run/aveserver
31287 .endd
31288
31289
31290 .vitem &%clamd%&
31291 .cindex "virus scanners" "clamd"
31292 This daemon-type scanner is GPL and free. You can get it at
31293 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31294 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31295 in the MIME ACL. This is no longer believed to be necessary.
31296
31297 The options are a list of server specifiers, which may be
31298 a UNIX socket specification,
31299 a TCP socket specification,
31300 or a (global) option.
31301
31302 A socket specification consists of a space-separated list.
31303 For a Unix socket the first element is a full path for the socket,
31304 for a TCP socket the first element is the IP address
31305 and the second a port number,
31306 Any further elements are per-server (non-global) options.
31307 These per-server options are supported:
31308 .code
31309 retry=<timespec>        Retry on connect fail
31310 .endd
31311
31312 The &`retry`& option specifies a time after which a single retry for
31313 a failed connect is made.  The default is to not retry.
31314
31315 If a Unix socket file is specified, only one server is supported.
31316
31317 Examples:
31318 .code
31319 av_scanner = clamd:/opt/clamd/socket
31320 av_scanner = clamd:192.0.2.3 1234
31321 av_scanner = clamd:192.0.2.3 1234:local
31322 av_scanner = clamd:192.0.2.3 1234 retry=10s
31323 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31324 .endd
31325 If the value of av_scanner points to a UNIX socket file or contains the
31326 &`local`&
31327 option, then the ClamAV interface will pass a filename containing the data
31328 to be scanned, which will should normally result in less I/O happening and be
31329 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31330 Exim does not assume that there is a common filesystem with the remote host.
31331 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31332 you be running a version of ClamAV prior to 0.95.
31333
31334 The final example shows that multiple TCP targets can be specified.  Exim will
31335 randomly use one for each incoming email (i.e. it load balances them).  Note
31336 that only TCP targets may be used if specifying a list of scanners; a UNIX
31337 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31338 unavailable, Exim will try the remaining one(s) until it finds one that works.
31339 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31340 not keep track of scanner state between multiple messages, and the scanner
31341 selection is random, so the message will get logged in the mainlog for each
31342 email that the down scanner gets chosen first (message wrapped to be readable):
31343 .code
31344 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31345    clamd: connection to localhost, port 3310 failed
31346    (Connection refused)
31347 .endd
31348
31349 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31350 contributing the code for this scanner.
31351
31352 .vitem &%cmdline%&
31353 .cindex "virus scanners" "command line interface"
31354 This is the keyword for the generic command line scanner interface. It can be
31355 used to attach virus scanners that are invoked from the shell. This scanner
31356 type takes 3 mandatory options:
31357
31358 .olist
31359 The full path and name of the scanner binary, with all command line options,
31360 and a placeholder (&`%s`&) for the directory to scan.
31361
31362 .next
31363 A regular expression to match against the STDOUT and STDERR output of the
31364 virus scanner. If the expression matches, a virus was found. You must make
31365 absolutely sure that this expression matches on &"virus found"&. This is called
31366 the &"trigger"& expression.
31367
31368 .next
31369 Another regular expression, containing exactly one pair of parentheses, to
31370 match the name of the virus found in the scanners output. This is called the
31371 &"name"& expression.
31372 .endlist olist
31373
31374 For example, Sophos Sweep reports a virus on a line like this:
31375 .code
31376 Virus 'W32/Magistr-B' found in file ./those.bat
31377 .endd
31378 For the trigger expression, we can match the phrase &"found in file"&. For the
31379 name expression, we want to extract the W32/Magistr-B string, so we can match
31380 for the single quotes left and right of it. Altogether, this makes the
31381 configuration setting:
31382 .code
31383 av_scanner = cmdline:\
31384              /path/to/sweep -ss -all -rec -archive %s:\
31385              found in file:'(.+)'
31386 .endd
31387 .vitem &%drweb%&
31388 .cindex "virus scanners" "DrWeb"
31389 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31390 takes one option,
31391 either a full path to a UNIX socket,
31392 or host and port specifiers separated by white space.
31393 The host may be a name or an IP address; the port is either a
31394 single number or a pair of numbers with a dash between.
31395 For example:
31396 .code
31397 av_scanner = drweb:/var/run/drwebd.sock
31398 av_scanner = drweb:192.168.2.20 31337
31399 .endd
31400 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31401 is used. Thanks to Alex Miller for contributing the code for this scanner.
31402
31403 .vitem &%f-protd%&
31404 .cindex "virus scanners" "f-protd"
31405 The f-protd scanner is accessed via HTTP over TCP.
31406 One argument is taken, being a space-separated hostname and port number
31407 (or port-range).
31408 For example:
31409 .code
31410 av_scanner = f-protd:localhost 10200-10204
31411 .endd
31412 If you omit the argument, the default values show above are used.
31413
31414 .vitem &%fsecure%&
31415 .cindex "virus scanners" "F-Secure"
31416 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31417 argument which is the path to a UNIX socket. For example:
31418 .code
31419 av_scanner = fsecure:/path/to/.fsav
31420 .endd
31421 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31422 Thelmen for contributing the code for this scanner.
31423
31424 .vitem &%kavdaemon%&
31425 .cindex "virus scanners" "Kaspersky"
31426 This is the scanner daemon of Kaspersky Version 4. This version of the
31427 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31428 scanner type takes one option, which is the path to the daemon's UNIX socket.
31429 For example:
31430 .code
31431 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31432 .endd
31433 The default path is &_/var/run/AvpCtl_&.
31434
31435 .vitem &%mksd%&
31436 .cindex "virus scanners" "mksd"
31437 This is a daemon type scanner that is aimed mainly at Polish users, though some
31438 parts of documentation are now available in English. You can get it at
31439 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31440 the maximum number of processes used simultaneously to scan the attachments,
31441 provided that mksd has
31442 been run with at least the same number of child processes. For example:
31443 .code
31444 av_scanner = mksd:2
31445 .endd
31446 You can safely omit this option (the default value is 1).
31447
31448 .vitem &%sock%&
31449 .cindex "virus scanners" "simple socket-connected"
31450 This is a general-purpose way of talking to simple scanner daemons
31451 running on the local machine.
31452 There are four options:
31453 an address (which may be an IP address and port, or the path of a Unix socket),
31454 a commandline to send (may include a single %s which will be replaced with
31455 the path to the mail file to be scanned),
31456 an RE to trigger on from the returned data,
31457 an RE to extract malware_name from the returned data.
31458 For example:
31459 .code
31460 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31461 .endd
31462 Default for the socket specifier is &_/tmp/malware.sock_&.
31463 Default for the commandline is &_%s\n_&.
31464 Both regular-expressions are required.
31465
31466 .vitem &%sophie%&
31467 .cindex "virus scanners" "Sophos and Sophie"
31468 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31469 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31470 for this scanner type is the path to the UNIX socket that Sophie uses for
31471 client communication. For example:
31472 .code
31473 av_scanner = sophie:/tmp/sophie
31474 .endd
31475 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31476 the option.
31477 .endlist
31478
31479 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31480 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31481 ACL.
31482
31483 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31484 makes it possible to use different scanners. See further below for an example.
31485 The &%malware%& condition caches its results, so when you use it multiple times
31486 for the same message, the actual scanning process is only carried out once.
31487 However, using expandable items in &%av_scanner%& disables this caching, in
31488 which case each use of the &%malware%& condition causes a new scan of the
31489 message.
31490
31491 The &%malware%& condition takes a right-hand argument that is expanded before
31492 use and taken as a list, slash-separated by default.
31493 The first element can then be one of
31494
31495 .ilist
31496 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31497 The condition succeeds if a virus was found, and fail otherwise. This is the
31498 recommended usage.
31499 .next
31500 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31501 the condition fails immediately.
31502 .next
31503 A regular expression, in which case the message is scanned for viruses. The
31504 condition succeeds if a virus is found and its name matches the regular
31505 expression. This allows you to take special actions on certain types of virus.
31506 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31507 unless the separator is changed (in the usual way).
31508 .endlist
31509
31510 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31511 messages even if there is a problem with the virus scanner.
31512 Otherwise, such a problem causes the ACL to defer.
31513
31514 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31515 specify a non-default timeout.  The default is two minutes.
31516 For example:
31517 .code
31518 malware = * / defer_ok / tmo=10s
31519 .endd
31520 A timeout causes the ACL to defer.
31521
31522 .vindex "&$callout_address$&"
31523 When a connection is made to the scanner the expansion variable &$callout_address$&
31524 is set to record the actual address used.
31525
31526 .vindex "&$malware_name$&"
31527 When a virus is found, the condition sets up an expansion variable called
31528 &$malware_name$& that contains the name of the virus. You can use it in a
31529 &%message%& modifier that specifies the error returned to the sender, and/or in
31530 logging data.
31531
31532 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31533 imposed by your anti-virus scanner.
31534
31535 Here is a very simple scanning example:
31536 .code
31537 deny message = This message contains malware ($malware_name)
31538      malware = *
31539 .endd
31540 The next example accepts messages when there is a problem with the scanner:
31541 .code
31542 deny message = This message contains malware ($malware_name)
31543      malware = */defer_ok
31544 .endd
31545 The next example shows how to use an ACL variable to scan with both sophie and
31546 aveserver. It assumes you have set:
31547 .code
31548 av_scanner = $acl_m0
31549 .endd
31550 in the main Exim configuration.
31551 .code
31552 deny message = This message contains malware ($malware_name)
31553      set acl_m0 = sophie
31554      malware = *
31555
31556 deny message = This message contains malware ($malware_name)
31557      set acl_m0 = aveserver
31558      malware = *
31559 .endd
31560
31561
31562 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31563 .cindex "content scanning" "for spam"
31564 .cindex "spam scanning"
31565 .cindex "SpamAssassin"
31566 .cindex "Rspamd"
31567 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31568 score and a report for the message.
31569 Support is also provided for Rspamd.
31570
31571 For more information about installation and configuration of SpamAssassin or
31572 Rspamd refer to their respective websites at
31573 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31574
31575 SpamAssassin can be installed with CPAN by running:
31576 .code
31577 perl -MCPAN -e 'install Mail::SpamAssassin'
31578 .endd
31579 SpamAssassin has its own set of configuration files. Please review its
31580 documentation to see how you can tweak it. The default installation should work
31581 nicely, however.
31582
31583 .oindex "&%spamd_address%&"
31584 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31585 intend to use an instance running on the local host you do not need to set
31586 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31587 you must set the &%spamd_address%& option in the global part of the Exim
31588 configuration as follows (example):
31589 .code
31590 spamd_address = 192.168.99.45 387
31591 .endd
31592
31593 To use Rspamd (which by default listens on all local addresses
31594 on TCP port 11333)
31595 you should add &%variant=rspamd%& after the address/port pair, for example:
31596 .code
31597 spamd_address = 127.0.0.1 11333 variant=rspamd
31598 .endd
31599
31600 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31601 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31602 file name instead of an address/port pair:
31603 .code
31604 spamd_address = /var/run/spamd_socket
31605 .endd
31606 You can have multiple &%spamd%& servers to improve scalability. These can
31607 reside on other hardware reachable over the network. To specify multiple
31608 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31609 option, separated with colons (the separator can be changed in the usual way):
31610 .code
31611 spamd_address = 192.168.2.10 783 : \
31612                 192.168.2.11 783 : \
31613                 192.168.2.12 783
31614 .endd
31615 Up to 32 &%spamd%& servers are supported.
31616 When a server fails to respond to the connection attempt, all other
31617 servers are tried until one succeeds. If no server responds, the &%spam%&
31618 condition defers.
31619
31620 Unix and TCP socket specifications may be mixed in any order.
31621 Each element of the list is a list itself, space-separated by default
31622 and changeable in the usual way; take care to not double the separator.
31623
31624 For TCP socket specifications a host name or IP (v4 or v6, but
31625 subject to list-separator quoting rules) address can be used,
31626 and the port can be one or a dash-separated pair.
31627 In the latter case, the range is tried in strict order.
31628
31629 Elements after the first for Unix sockets, or second for TCP socket,
31630 are options.
31631 The supported options are:
31632 .code
31633 pri=<priority>      Selection priority
31634 weight=<value>      Selection bias
31635 time=<start>-<end>  Use only between these times of day
31636 retry=<timespec>    Retry on connect fail
31637 tmo=<timespec>      Connection time limit
31638 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31639 .endd
31640
31641 The &`pri`& option specifies a priority for the server within the list,
31642 higher values being tried first.
31643 The default priority is 1.
31644
31645 The &`weight`& option specifies a selection bias.
31646 Within a priority set
31647 servers are queried in a random fashion, weighted by this value.
31648 The default value for selection bias is 1.
31649
31650 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31651 in the local time zone; each element being one or more digits.
31652 Either the seconds or both minutes and seconds, plus the leading &`.`&
31653 characters, may be omitted and will be taken as zero.
31654
31655 Timeout specifications for the &`retry`& and &`tmo`& options
31656 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31657
31658 The &`tmo`& option specifies an overall timeout for communication.
31659 The default value is two minutes.
31660
31661 The &`retry`& option specifies a time after which a single retry for
31662 a failed connect is made.
31663 The default is to not retry.
31664
31665 The &%spamd_address%& variable is expanded before use if it starts with
31666 a dollar sign. In this case, the expansion may return a string that is
31667 used as the list so that multiple spamd servers can be the result of an
31668 expansion.
31669
31670 .vindex "&$callout_address$&"
31671 When a connection is made to the server the expansion variable &$callout_address$&
31672 is set to record the actual address used.
31673
31674 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31675 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31676 .code
31677 deny message = This message was classified as SPAM
31678      spam = joe
31679 .endd
31680 The right-hand side of the &%spam%& condition specifies a name. This is
31681 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31682 to scan using a specific profile, but rather use the SpamAssassin system-wide
31683 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31684 Rspamd does not use this setting. However, you must put something on the
31685 right-hand side.
31686
31687 The name allows you to use per-domain or per-user antispam profiles in
31688 principle, but this is not straightforward in practice, because a message may
31689 have multiple recipients, not necessarily all in the same domain. Because the
31690 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31691 read the contents of the message, the variables &$local_part$& and &$domain$&
31692 are not set.
31693 Careful enforcement of single-recipient messages
31694 (e.g. by responding with defer in the recipient ACL for all recipients
31695 after the first),
31696 or the use of PRDR,
31697 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31698 are needed to use this feature.
31699
31700 The right-hand side of the &%spam%& condition is expanded before being used, so
31701 you can put lookups or conditions there. When the right-hand side evaluates to
31702 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31703
31704
31705 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31706 large ones may cause significant performance degradation. As most spam messages
31707 are quite small, it is recommended that you do not scan the big ones. For
31708 example:
31709 .code
31710 deny message = This message was classified as SPAM
31711      condition = ${if < {$message_size}{10K}}
31712      spam = nobody
31713 .endd
31714
31715 The &%spam%& condition returns true if the threshold specified in the user's
31716 SpamAssassin profile has been matched or exceeded. If you want to use the
31717 &%spam%& condition for its side effects (see the variables below), you can make
31718 it always return &"true"& by appending &`:true`& to the username.
31719
31720 .cindex "spam scanning" "returned variables"
31721 When the &%spam%& condition is run, it sets up a number of expansion
31722 variables.
31723 Except for &$spam_report$&,
31724 these variables are saved with the received message so are
31725 available for use at delivery time.
31726
31727 .vlist
31728 .vitem &$spam_score$&
31729 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31730 for inclusion in log or reject messages.
31731
31732 .vitem &$spam_score_int$&
31733 The spam score of the message, multiplied by ten, as an integer value. For
31734 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31735 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31736 The integer value is useful for numeric comparisons in conditions.
31737
31738 .vitem &$spam_bar$&
31739 A string consisting of a number of &"+"& or &"-"& characters, representing the
31740 integer part of the spam score value. A spam score of 4.4 would have a
31741 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31742 headers, since MUAs can match on such strings. The maximum length of the
31743 spam bar is 50 characters.
31744
31745 .vitem &$spam_report$&
31746 A multiline text table, containing the full SpamAssassin report for the
31747 message. Useful for inclusion in headers or reject messages.
31748 This variable is only usable in a DATA-time ACL.
31749 .new
31750 Beware that SpamAssassin may return non-ASCII characters, especially
31751 when running in country-specific locales, which are not legal
31752 unencoded in headers.
31753 .wen
31754
31755 .vitem &$spam_action$&
31756 For SpamAssassin either 'reject' or 'no action' depending on the
31757 spam score versus threshold.
31758 For Rspamd, the recommended action.
31759
31760 .endlist
31761
31762 The &%spam%& condition caches its results unless expansion in
31763 spamd_address was used. If you call it again with the same user name, it
31764 does not scan again, but rather returns the same values as before.
31765
31766 The &%spam%& condition returns DEFER if there is any error while running
31767 the message through SpamAssassin or if the expansion of spamd_address
31768 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31769 statement block), append &`/defer_ok`& to the right-hand side of the
31770 spam condition, like this:
31771 .code
31772 deny message = This message was classified as SPAM
31773      spam    = joe/defer_ok
31774 .endd
31775 This causes messages to be accepted even if there is a problem with &%spamd%&.
31776
31777 Here is a longer, commented example of the use of the &%spam%&
31778 condition:
31779 .code
31780 # put headers in all messages (no matter if spam or not)
31781 warn  spam = nobody:true
31782       add_header = X-Spam-Score: $spam_score ($spam_bar)
31783       add_header = X-Spam-Report: $spam_report
31784
31785 # add second subject line with *SPAM* marker when message
31786 # is over threshold
31787 warn  spam = nobody
31788       add_header = Subject: *SPAM* $h_Subject:
31789
31790 # reject spam at high scores (> 12)
31791 deny  message = This message scored $spam_score spam points.
31792       spam = nobody:true
31793       condition = ${if >{$spam_score_int}{120}{1}{0}}
31794 .endd
31795
31796
31797
31798 .section "Scanning MIME parts" "SECTscanmimepart"
31799 .cindex "content scanning" "MIME parts"
31800 .cindex "MIME content scanning"
31801 .oindex "&%acl_smtp_mime%&"
31802 .oindex "&%acl_not_smtp_mime%&"
31803 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31804 each MIME part of an SMTP message, including multipart types, in the sequence
31805 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31806 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31807 options may both refer to the same ACL if you want the same processing in both
31808 cases.
31809
31810 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31811 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31812 the case of a non-SMTP message. However, a MIME ACL is called only if the
31813 message contains a &'Content-Type:'& header line. When a call to a MIME
31814 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31815 result code is sent to the client. In the case of an SMTP message, the
31816 &%acl_smtp_data%& ACL is not called when this happens.
31817
31818 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31819 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31820 condition to match against the raw MIME part. You can also use the
31821 &%mime_regex%& condition to match against the decoded MIME part (see section
31822 &<<SECTscanregex>>&).
31823
31824 At the start of a MIME ACL, a number of variables are set from the header
31825 information for the relevant MIME part. These are described below. The contents
31826 of the MIME part are not by default decoded into a disk file except for MIME
31827 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31828 part into a disk file, you can use the &%decode%& condition. The general
31829 syntax is:
31830 .display
31831 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31832 .endd
31833 The right hand side is expanded before use. After expansion,
31834 the value can be:
31835
31836 .olist
31837 &"0"& or &"false"&, in which case no decoding is done.
31838 .next
31839 The string &"default"&. In that case, the file is put in the temporary
31840 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31841 a sequential file name consisting of the message id and a sequence number. The
31842 full path and name is available in &$mime_decoded_filename$& after decoding.
31843 .next
31844 A full path name starting with a slash. If the full name is an existing
31845 directory, it is used as a replacement for the default directory. The filename
31846 is then sequentially assigned. If the path does not exist, it is used as
31847 the full path and file name.
31848 .next
31849 If the string does not start with a slash, it is used as the
31850 filename, and the default path is then used.
31851 .endlist
31852 The &%decode%& condition normally succeeds. It is only false for syntax
31853 errors or unusual circumstances such as memory shortages. You can easily decode
31854 a file with its original, proposed filename using
31855 .code
31856 decode = $mime_filename
31857 .endd
31858 However, you should keep in mind that &$mime_filename$& might contain
31859 anything. If you place files outside of the default path, they are not
31860 automatically unlinked.
31861
31862 For RFC822 attachments (these are messages attached to messages, with a
31863 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31864 as for the primary message, only that the &$mime_is_rfc822$& expansion
31865 variable is set (see below). Attached messages are always decoded to disk
31866 before being checked, and the files are unlinked once the check is done.
31867
31868 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31869 used to match regular expressions against raw and decoded MIME parts,
31870 respectively. They are described in section &<<SECTscanregex>>&.
31871
31872 .cindex "MIME content scanning" "returned variables"
31873 The following list describes all expansion variables that are
31874 available in the MIME ACL:
31875
31876 .vlist
31877 .vitem &$mime_boundary$&
31878 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31879 have a boundary string, which is stored in this variable. If the current part
31880 has no boundary parameter in the &'Content-Type:'& header, this variable
31881 contains the empty string.
31882
31883 .vitem &$mime_charset$&
31884 This variable contains the character set identifier, if one was found in the
31885 &'Content-Type:'& header. Examples for charset identifiers are:
31886 .code
31887 us-ascii
31888 gb2312 (Chinese)
31889 iso-8859-1
31890 .endd
31891 Please note that this value is not normalized, so you should do matches
31892 case-insensitively.
31893
31894 .vitem &$mime_content_description$&
31895 This variable contains the normalized content of the &'Content-Description:'&
31896 header. It can contain a human-readable description of the parts content. Some
31897 implementations repeat the filename for attachments here, but they are usually
31898 only used for display purposes.
31899
31900 .vitem &$mime_content_disposition$&
31901 This variable contains the normalized content of the &'Content-Disposition:'&
31902 header. You can expect strings like &"attachment"& or &"inline"& here.
31903
31904 .vitem &$mime_content_id$&
31905 This variable contains the normalized content of the &'Content-ID:'& header.
31906 This is a unique ID that can be used to reference a part from another part.
31907
31908 .vitem &$mime_content_size$&
31909 This variable is set only after the &%decode%& modifier (see above) has been
31910 successfully run. It contains the size of the decoded part in kilobytes. The
31911 size is always rounded up to full kilobytes, so only a completely empty part
31912 has a &$mime_content_size$& of zero.
31913
31914 .vitem &$mime_content_transfer_encoding$&
31915 This variable contains the normalized content of the
31916 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31917 type. Typical values are &"base64"& and &"quoted-printable"&.
31918
31919 .vitem &$mime_content_type$&
31920 If the MIME part has a &'Content-Type:'& header, this variable contains its
31921 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31922 are some examples of popular MIME types, as they may appear in this variable:
31923 .code
31924 text/plain
31925 text/html
31926 application/octet-stream
31927 image/jpeg
31928 audio/midi
31929 .endd
31930 If the MIME part has no &'Content-Type:'& header, this variable contains the
31931 empty string.
31932
31933 .vitem &$mime_decoded_filename$&
31934 This variable is set only after the &%decode%& modifier (see above) has been
31935 successfully run. It contains the full path and file name of the file
31936 containing the decoded data.
31937 .endlist
31938
31939 .cindex "RFC 2047"
31940 .vlist
31941 .vitem &$mime_filename$&
31942 This is perhaps the most important of the MIME variables. It contains a
31943 proposed filename for an attachment, if one was found in either the
31944 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31945 RFC2047
31946 or RFC2231
31947 decoded, but no additional sanity checks are done.
31948  If no filename was
31949 found, this variable contains the empty string.
31950
31951 .vitem &$mime_is_coverletter$&
31952 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31953 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31954 content in the cover letter, while not restricting attachments at all.
31955
31956 The variable contains 1 (true) for a MIME part believed to be part of the
31957 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31958 follows:
31959
31960 .olist
31961 The outermost MIME part of a message is always a cover letter.
31962
31963 .next
31964 If a multipart/alternative or multipart/related MIME part is a cover letter,
31965 so are all MIME subparts within that multipart.
31966
31967 .next
31968 If any other multipart is a cover letter, the first subpart is a cover letter,
31969 and the rest are attachments.
31970
31971 .next
31972 All parts contained within an attachment multipart are attachments.
31973 .endlist olist
31974
31975 As an example, the following will ban &"HTML mail"& (including that sent with
31976 alternative plain text), while allowing HTML files to be attached. HTML
31977 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31978 .code
31979 deny message = HTML mail is not accepted here
31980 !condition = $mime_is_rfc822
31981 condition = $mime_is_coverletter
31982 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31983 .endd
31984 .vitem &$mime_is_multipart$&
31985 This variable has the value 1 (true) when the current part has the main type
31986 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31987 Since multipart entities only serve as containers for other parts, you may not
31988 want to carry out specific actions on them.
31989
31990 .vitem &$mime_is_rfc822$&
31991 This variable has the value 1 (true) if the current part is not a part of the
31992 checked message itself, but part of an attached message. Attached message
31993 decoding is fully recursive.
31994
31995 .vitem &$mime_part_count$&
31996 This variable is a counter that is raised for each processed MIME part. It
31997 starts at zero for the very first part (which is usually a multipart). The
31998 counter is per-message, so it is reset when processing RFC822 attachments (see
31999 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32000 complete, so you can use it in the DATA ACL to determine the number of MIME
32001 parts of a message. For non-MIME messages, this variable contains the value -1.
32002 .endlist
32003
32004
32005
32006 .section "Scanning with regular expressions" "SECTscanregex"
32007 .cindex "content scanning" "with regular expressions"
32008 .cindex "regular expressions" "content scanning with"
32009 You can specify your own custom regular expression matches on the full body of
32010 the message, or on individual MIME parts.
32011
32012 The &%regex%& condition takes one or more regular expressions as arguments and
32013 matches them against the full message (when called in the DATA ACL) or a raw
32014 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32015 linewise, with a maximum line length of 32K characters. That means you cannot
32016 have multiline matches with the &%regex%& condition.
32017
32018 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32019 to 32K of decoded content (the whole content at once, not linewise). If the
32020 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32021 is decoded automatically when &%mime_regex%& is executed (using default path
32022 and filename values). If the decoded data is larger than  32K, only the first
32023 32K characters are checked.
32024
32025 The regular expressions are passed as a colon-separated list. To include a
32026 literal colon, you must double it. Since the whole right-hand side string is
32027 expanded before being used, you must also escape dollar signs and backslashes
32028 with more backslashes, or use the &`\N`& facility to disable expansion.
32029 Here is a simple example that contains two regular expressions:
32030 .code
32031 deny message = contains blacklisted regex ($regex_match_string)
32032      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32033 .endd
32034 The conditions returns true if any one of the regular expressions matches. The
32035 &$regex_match_string$& expansion variable is then set up and contains the
32036 matching regular expression.
32037 The expansion variables &$regex1$& &$regex2$& etc
32038 are set to any substrings captured by the regular expression.
32039
32040 &*Warning*&: With large messages, these conditions can be fairly
32041 CPU-intensive.
32042
32043 .ecindex IIDcosca
32044
32045
32046
32047
32048 . ////////////////////////////////////////////////////////////////////////////
32049 . ////////////////////////////////////////////////////////////////////////////
32050
32051 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32052          "Local scan function"
32053 .scindex IIDlosca "&[local_scan()]& function" "description of"
32054 .cindex "customizing" "input scan using C function"
32055 .cindex "policy control" "by local scan function"
32056 In these days of email worms, viruses, and ever-increasing spam, some sites
32057 want to apply a lot of checking to messages before accepting them.
32058
32059 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32060 passing messages to external virus and spam scanning software. You can also do
32061 a certain amount in Exim itself through string expansions and the &%condition%&
32062 condition in the ACL that runs after the SMTP DATA command or the ACL for
32063 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32064
32065 To allow for further customization to a site's own requirements, there is the
32066 possibility of linking Exim with a private message scanning function, written
32067 in C. If you want to run code that is written in something other than C, you
32068 can of course use a little C stub to call it.
32069
32070 The local scan function is run once for every incoming message, at the point
32071 when Exim is just about to accept the message.
32072 It can therefore be used to control non-SMTP messages from local processes as
32073 well as messages arriving via SMTP.
32074
32075 Exim applies a timeout to calls of the local scan function, and there is an
32076 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32077 Zero means &"no timeout"&.
32078 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32079 before calling the local scan function, so that the most common types of crash
32080 are caught. If the timeout is exceeded or one of those signals is caught, the
32081 incoming message is rejected with a temporary error if it is an SMTP message.
32082 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32083 code. The incident is logged on the main and reject logs.
32084
32085
32086
32087 .section "Building Exim to use a local scan function" "SECID207"
32088 .cindex "&[local_scan()]& function" "building Exim to use"
32089 To make use of the local scan function feature, you must tell Exim where your
32090 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32091 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32092 directory, so you might set
32093 .code
32094 LOCAL_SCAN_SOURCE=Local/local_scan.c
32095 .endd
32096 for example. The function must be called &[local_scan()]&. It is called by
32097 Exim after it has received a message, when the success return code is about to
32098 be sent. This is after all the ACLs have been run. The return code from your
32099 function controls whether the message is actually accepted or not. There is a
32100 commented template function (that just accepts the message) in the file
32101 _src/local_scan.c_.
32102
32103 If you want to make use of Exim's run time configuration file to set options
32104 for your &[local_scan()]& function, you must also set
32105 .code
32106 LOCAL_SCAN_HAS_OPTIONS=yes
32107 .endd
32108 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32109
32110
32111
32112
32113 .section "API for local_scan()" "SECTapiforloc"
32114 .cindex "&[local_scan()]& function" "API description"
32115 You must include this line near the start of your code:
32116 .code
32117 #include "local_scan.h"
32118 .endd
32119 This header file defines a number of variables and other values, and the
32120 prototype for the function itself. Exim is coded to use unsigned char values
32121 almost exclusively, and one of the things this header defines is a shorthand
32122 for &`unsigned char`& called &`uschar`&.
32123 It also contains the following macro definitions, to simplify casting character
32124 strings and pointers to character strings:
32125 .code
32126 #define CS   (char *)
32127 #define CCS  (const char *)
32128 #define CSS  (char **)
32129 #define US   (unsigned char *)
32130 #define CUS  (const unsigned char *)
32131 #define USS  (unsigned char **)
32132 .endd
32133 The function prototype for &[local_scan()]& is:
32134 .code
32135 extern int local_scan(int fd, uschar **return_text);
32136 .endd
32137 The arguments are as follows:
32138
32139 .ilist
32140 &%fd%& is a file descriptor for the file that contains the body of the message
32141 (the -D file). The file is open for reading and writing, but updating it is not
32142 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32143
32144 The descriptor is positioned at character 19 of the file, which is the first
32145 character of the body itself, because the first 19 characters are the message
32146 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32147 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32148 case this changes in some future version.
32149 .next
32150 &%return_text%& is an address which you can use to return a pointer to a text
32151 string at the end of the function. The value it points to on entry is NULL.
32152 .endlist
32153
32154 The function must return an &%int%& value which is one of the following macros:
32155
32156 .vlist
32157 .vitem &`LOCAL_SCAN_ACCEPT`&
32158 .vindex "&$local_scan_data$&"
32159 The message is accepted. If you pass back a string of text, it is saved with
32160 the message, and made available in the variable &$local_scan_data$&. No
32161 newlines are permitted (if there are any, they are turned into spaces) and the
32162 maximum length of text is 1000 characters.
32163
32164 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32165 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32166 queued without immediate delivery, and is frozen.
32167
32168 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32169 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32170 queued without immediate delivery.
32171
32172 .vitem &`LOCAL_SCAN_REJECT`&
32173 The message is rejected; the returned text is used as an error message which is
32174 passed back to the sender and which is also logged. Newlines are permitted &--
32175 they cause a multiline response for SMTP rejections, but are converted to
32176 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32177 used.
32178
32179 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32180 The message is temporarily rejected; the returned text is used as an error
32181 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32182 problem"& is used.
32183
32184 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32185 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32186 message is not written to the reject log. It has the effect of unsetting the
32187 &%rejected_header%& log selector for just this rejection. If
32188 &%rejected_header%& is already unset (see the discussion of the
32189 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32190 same as LOCAL_SCAN_REJECT.
32191
32192 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32193 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32194 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32195 .endlist
32196
32197 If the message is not being received by interactive SMTP, rejections are
32198 reported by writing to &%stderr%& or by sending an email, as configured by the
32199 &%-oe%& command line options.
32200
32201
32202
32203 .section "Configuration options for local_scan()" "SECTconoptloc"
32204 .cindex "&[local_scan()]& function" "configuration options"
32205 It is possible to have option settings in the main configuration file
32206 that set values in static variables in the &[local_scan()]& module. If you
32207 want to do this, you must have the line
32208 .code
32209 LOCAL_SCAN_HAS_OPTIONS=yes
32210 .endd
32211 in your &_Local/Makefile_& when you build Exim. (This line is in
32212 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32213 file, you must define static variables to hold the option values, and a table
32214 to define them.
32215
32216 The table must be a vector called &%local_scan_options%&, of type
32217 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32218 and a pointer to the variable that holds the value. The entries must appear in
32219 alphabetical order. Following &%local_scan_options%& you must also define a
32220 variable called &%local_scan_options_count%& that contains the number of
32221 entries in the table. Here is a short example, showing two kinds of option:
32222 .code
32223 static int my_integer_option = 42;
32224 static uschar *my_string_option = US"a default string";
32225
32226 optionlist local_scan_options[] = {
32227   { "my_integer", opt_int,       &my_integer_option },
32228   { "my_string",  opt_stringptr, &my_string_option }
32229 };
32230
32231 int local_scan_options_count =
32232   sizeof(local_scan_options)/sizeof(optionlist);
32233 .endd
32234 The values of the variables can now be changed from Exim's runtime
32235 configuration file by including a local scan section as in this example:
32236 .code
32237 begin local_scan
32238 my_integer = 99
32239 my_string = some string of text...
32240 .endd
32241 The available types of option data are as follows:
32242
32243 .vlist
32244 .vitem &*opt_bool*&
32245 This specifies a boolean (true/false) option. The address should point to a
32246 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32247 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32248 whether such a variable has been set at all, you can initialize it to
32249 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32250 values.)
32251
32252 .vitem &*opt_fixed*&
32253 This specifies a fixed point number, such as is used for load averages.
32254 The address should point to a variable of type &`int`&. The value is stored
32255 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32256
32257 .vitem &*opt_int*&
32258 This specifies an integer; the address should point to a variable of type
32259 &`int`&. The value may be specified in any of the integer formats accepted by
32260 Exim.
32261
32262 .vitem &*opt_mkint*&
32263 This is the same as &%opt_int%&, except that when such a value is output in a
32264 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32265 printed with the suffix K or M.
32266
32267 .vitem &*opt_octint*&
32268 This also specifies an integer, but the value is always interpreted as an
32269 octal integer, whether or not it starts with the digit zero, and it is
32270 always output in octal.
32271
32272 .vitem &*opt_stringptr*&
32273 This specifies a string value; the address must be a pointer to a
32274 variable that points to a string (for example, of type &`uschar *`&).
32275
32276 .vitem &*opt_time*&
32277 This specifies a time interval value. The address must point to a variable of
32278 type &`int`&. The value that is placed there is a number of seconds.
32279 .endlist
32280
32281 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32282 out the values of all the &[local_scan()]& options.
32283
32284
32285
32286 .section "Available Exim variables" "SECID208"
32287 .cindex "&[local_scan()]& function" "available Exim variables"
32288 The header &_local_scan.h_& gives you access to a number of C variables. These
32289 are the only ones that are guaranteed to be maintained from release to release.
32290 Note, however, that you can obtain the value of any Exim expansion variable,
32291 including &$recipients$&, by calling &'expand_string()'&. The exported
32292 C variables are as follows:
32293
32294 .vlist
32295 .vitem &*int&~body_linecount*&
32296 This variable contains the number of lines in the message's body.
32297
32298 .vitem &*int&~body_zerocount*&
32299 This variable contains the number of binary zero bytes in the message's body.
32300
32301 .vitem &*unsigned&~int&~debug_selector*&
32302 This variable is set to zero when no debugging is taking place. Otherwise, it
32303 is a bitmap of debugging selectors. Two bits are identified for use in
32304 &[local_scan()]&; they are defined as macros:
32305
32306 .ilist
32307 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32308 testing option that is not privileged &-- any caller may set it. All the
32309 other selector bits can be set only by admin users.
32310
32311 .next
32312 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32313 by the &`+local_scan`& debug selector. It is not included in the default set
32314 of debugging bits.
32315 .endlist ilist
32316
32317 Thus, to write to the debugging output only when &`+local_scan`& has been
32318 selected, you should use code like this:
32319 .code
32320 if ((debug_selector & D_local_scan) != 0)
32321   debug_printf("xxx", ...);
32322 .endd
32323 .vitem &*uschar&~*expand_string_message*&
32324 After a failing call to &'expand_string()'& (returned value NULL), the
32325 variable &%expand_string_message%& contains the error message, zero-terminated.
32326
32327 .vitem &*header_line&~*header_list*&
32328 A pointer to a chain of header lines. The &%header_line%& structure is
32329 discussed below.
32330
32331 .vitem &*header_line&~*header_last*&
32332 A pointer to the last of the header lines.
32333
32334 .vitem &*uschar&~*headers_charset*&
32335 The value of the &%headers_charset%& configuration option.
32336
32337 .vitem &*BOOL&~host_checking*&
32338 This variable is TRUE during a host checking session that is initiated by the
32339 &%-bh%& command line option.
32340
32341 .vitem &*uschar&~*interface_address*&
32342 The IP address of the interface that received the message, as a string. This
32343 is NULL for locally submitted messages.
32344
32345 .vitem &*int&~interface_port*&
32346 The port on which this message was received. When testing with the &%-bh%&
32347 command line option, the value of this variable is -1 unless a port has been
32348 specified via the &%-oMi%& option.
32349
32350 .vitem &*uschar&~*message_id*&
32351 This variable contains Exim's message id for the incoming message (the value of
32352 &$message_exim_id$&) as a zero-terminated string.
32353
32354 .vitem &*uschar&~*received_protocol*&
32355 The name of the protocol by which the message was received.
32356
32357 .vitem &*int&~recipients_count*&
32358 The number of accepted recipients.
32359
32360 .vitem &*recipient_item&~*recipients_list*&
32361 .cindex "recipient" "adding in local scan"
32362 .cindex "recipient" "removing in local scan"
32363 The list of accepted recipients, held in a vector of length
32364 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32365 can add additional recipients by calling &'receive_add_recipient()'& (see
32366 below). You can delete recipients by removing them from the vector and
32367 adjusting the value in &%recipients_count%&. In particular, by setting
32368 &%recipients_count%& to zero you remove all recipients. If you then return the
32369 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32370 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32371 and then call &'receive_add_recipient()'& as often as needed.
32372
32373 .vitem &*uschar&~*sender_address*&
32374 The envelope sender address. For bounce messages this is the empty string.
32375
32376 .vitem &*uschar&~*sender_host_address*&
32377 The IP address of the sending host, as a string. This is NULL for
32378 locally-submitted messages.
32379
32380 .vitem &*uschar&~*sender_host_authenticated*&
32381 The name of the authentication mechanism that was used, or NULL if the message
32382 was not received over an authenticated SMTP connection.
32383
32384 .vitem &*uschar&~*sender_host_name*&
32385 The name of the sending host, if known.
32386
32387 .vitem &*int&~sender_host_port*&
32388 The port on the sending host.
32389
32390 .vitem &*BOOL&~smtp_input*&
32391 This variable is TRUE for all SMTP input, including BSMTP.
32392
32393 .vitem &*BOOL&~smtp_batched_input*&
32394 This variable is TRUE for BSMTP input.
32395
32396 .vitem &*int&~store_pool*&
32397 The contents of this variable control which pool of memory is used for new
32398 requests. See section &<<SECTmemhanloc>>& for details.
32399 .endlist
32400
32401
32402 .section "Structure of header lines" "SECID209"
32403 The &%header_line%& structure contains the members listed below.
32404 You can add additional header lines by calling the &'header_add()'& function
32405 (see below). You can cause header lines to be ignored (deleted) by setting
32406 their type to *.
32407
32408
32409 .vlist
32410 .vitem &*struct&~header_line&~*next*&
32411 A pointer to the next header line, or NULL for the last line.
32412
32413 .vitem &*int&~type*&
32414 A code identifying certain headers that Exim recognizes. The codes are printing
32415 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32416 Notice in particular that any header line whose type is * is not transmitted
32417 with the message. This flagging is used for header lines that have been
32418 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32419 lines.) Effectively, * means &"deleted"&.
32420
32421 .vitem &*int&~slen*&
32422 The number of characters in the header line, including the terminating and any
32423 internal newlines.
32424
32425 .vitem &*uschar&~*text*&
32426 A pointer to the text of the header. It always ends with a newline, followed by
32427 a zero byte. Internal newlines are preserved.
32428 .endlist
32429
32430
32431
32432 .section "Structure of recipient items" "SECID210"
32433 The &%recipient_item%& structure contains these members:
32434
32435 .vlist
32436 .vitem &*uschar&~*address*&
32437 This is a pointer to the recipient address as it was received.
32438
32439 .vitem &*int&~pno*&
32440 This is used in later Exim processing when top level addresses are created by
32441 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32442 and must always contain -1 at this stage.
32443
32444 .vitem &*uschar&~*errors_to*&
32445 If this value is not NULL, bounce messages caused by failing to deliver to the
32446 recipient are sent to the address it contains. In other words, it overrides the
32447 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32448 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32449 an unqualified address, Exim qualifies it using the domain from
32450 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32451 is NULL for all recipients.
32452 .endlist
32453
32454
32455
32456 .section "Available Exim functions" "SECID211"
32457 .cindex "&[local_scan()]& function" "available Exim functions"
32458 The header &_local_scan.h_& gives you access to a number of Exim functions.
32459 These are the only ones that are guaranteed to be maintained from release to
32460 release:
32461
32462 .vlist
32463 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32464        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32465
32466 This function creates a child process that runs the command specified by
32467 &%argv%&. The environment for the process is specified by &%envp%&, which can
32468 be NULL if no environment variables are to be passed. A new umask is supplied
32469 for the process in &%newumask%&.
32470
32471 Pipes to the standard input and output of the new process are set up
32472 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32473 standard error is cloned to the standard output. If there are any file
32474 descriptors &"in the way"& in the new process, they are closed. If the final
32475 argument is TRUE, the new process is made into a process group leader.
32476
32477 The function returns the pid of the new process, or -1 if things go wrong.
32478
32479 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32480 This function waits for a child process to terminate, or for a timeout (in
32481 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32482 return value is as follows:
32483
32484 .ilist
32485 >= 0
32486
32487 The process terminated by a normal exit and the value is the process
32488 ending status.
32489
32490 .next
32491 < 0 and > &--256
32492
32493 The process was terminated by a signal and the value is the negation of the
32494 signal number.
32495
32496 .next
32497 &--256
32498
32499 The process timed out.
32500 .next
32501 &--257
32502
32503 The was some other error in wait(); &%errno%& is still set.
32504 .endlist
32505
32506 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32507 This function provide you with a means of submitting a new message to
32508 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32509 want, but this packages it all up for you.) The function creates a pipe,
32510 forks a subprocess that is running
32511 .code
32512 exim -t -oem -oi -f <>
32513 .endd
32514 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32515 that is connected to the standard input. The yield of the function is the PID
32516 of the subprocess. You can then write a message to the file descriptor, with
32517 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32518
32519 When you have finished, call &'child_close()'& to wait for the process to
32520 finish and to collect its ending status. A timeout value of zero is usually
32521 fine in this circumstance. Unless you have made a mistake with the recipient
32522 addresses, you should get a return code of zero.
32523
32524
32525 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32526        *sender_authentication)*&
32527 This function is a more sophisticated version of &'child_open()'&. The command
32528 that it runs is:
32529 .display
32530 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32531 .endd
32532 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32533
32534
32535 .vitem &*void&~debug_printf(char&~*,&~...)*&
32536 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32537 output is written to the standard error stream. If no debugging is selected,
32538 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32539 conditional on the &`local_scan`& debug selector by coding like this:
32540 .code
32541 if ((debug_selector & D_local_scan) != 0)
32542   debug_printf("xxx", ...);
32543 .endd
32544
32545 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32546 This is an interface to Exim's string expansion code. The return value is the
32547 expanded string, or NULL if there was an expansion failure.
32548 The C variable &%expand_string_message%& contains an error message after an
32549 expansion failure. If expansion does not change the string, the return value is
32550 the pointer to the input string. Otherwise, the return value points to a new
32551 block of memory that was obtained by a call to &'store_get()'&. See section
32552 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32553
32554 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32555 This function allows you to an add additional header line at the end of the
32556 existing ones. The first argument is the type, and should normally be a space
32557 character. The second argument is a format string and any number of
32558 substitution arguments as for &[sprintf()]&. You may include internal newlines
32559 if you want, and you must ensure that the string ends with a newline.
32560
32561 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32562         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32563 This function adds a new header line at a specified point in the header
32564 chain. The header itself is specified as for &'header_add()'&.
32565
32566 If &%name%& is NULL, the new header is added at the end of the chain if
32567 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32568 NULL, the header lines are searched for the first non-deleted header that
32569 matches the name. If one is found, the new header is added before it if
32570 &%after%& is false. If &%after%& is true, the new header is added after the
32571 found header and any adjacent subsequent ones with the same name (even if
32572 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32573 option controls where the header is added. If it is true, addition is at the
32574 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32575 headers, or at the top if there are no &'Received:'& headers, you could use
32576 .code
32577 header_add_at_position(TRUE, US"Received", TRUE,
32578   ' ', "X-xxx: ...");
32579 .endd
32580 Normally, there is always at least one non-deleted &'Received:'& header, but
32581 there may not be if &%received_header_text%& expands to an empty string.
32582
32583
32584 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32585 This function removes header lines. If &%occurrence%& is zero or negative, all
32586 occurrences of the header are removed. If occurrence is greater than zero, that
32587 particular instance of the header is removed. If no header(s) can be found that
32588 match the specification, the function does nothing.
32589
32590
32591 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32592         int&~length,&~BOOL&~notdel)*&"
32593 This function tests whether the given header has the given name. It is not just
32594 a string comparison, because white space is permitted between the name and the
32595 colon. If the &%notdel%& argument is true, a false return is forced for all
32596 &"deleted"& headers; otherwise they are not treated specially. For example:
32597 .code
32598 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32599 .endd
32600 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32601 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32602 This function base64-encodes a string, which is passed by address and length.
32603 The text may contain bytes of any value, including zero. The result is passed
32604 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32605 zero-terminated.
32606
32607 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32608 This function decodes a base64-encoded string. Its arguments are a
32609 zero-terminated base64-encoded string and the address of a variable that is set
32610 to point to the result, which is in dynamic memory. The length of the decoded
32611 string is the yield of the function. If the input is invalid base64 data, the
32612 yield is -1. A zero byte is added to the end of the output string to make it
32613 easy to interpret as a C string (assuming it contains no zeros of its own). The
32614 added zero byte is not included in the returned count.
32615
32616 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32617 This function checks for a match in a domain list. Domains are always
32618 matched caselessly. The return value is one of the following:
32619 .display
32620 &`OK     `& match succeeded
32621 &`FAIL   `& match failed
32622 &`DEFER  `& match deferred
32623 .endd
32624 DEFER is usually caused by some kind of lookup defer, such as the
32625 inability to contact a database.
32626
32627 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32628         BOOL&~caseless)*&"
32629 This function checks for a match in a local part list. The third argument
32630 controls case-sensitivity. The return values are as for
32631 &'lss_match_domain()'&.
32632
32633 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32634         BOOL&~caseless)*&"
32635 This function checks for a match in an address list. The third argument
32636 controls the case-sensitivity of the local part match. The domain is always
32637 matched caselessly. The return values are as for &'lss_match_domain()'&.
32638
32639 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32640         uschar&~*list)*&"
32641 This function checks for a match in a host list. The most common usage is
32642 expected to be
32643 .code
32644 lss_match_host(sender_host_name, sender_host_address, ...)
32645 .endd
32646 .vindex "&$sender_host_address$&"
32647 An empty address field matches an empty item in the host list. If the host name
32648 is NULL, the name corresponding to &$sender_host_address$& is automatically
32649 looked up if a host name is required to match an item in the list. The return
32650 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32651 returns ERROR in the case when it had to look up a host name, but the lookup
32652 failed.
32653
32654 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32655         *format,&~...)*&"
32656 This function writes to Exim's log files. The first argument should be zero (it
32657 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32658 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32659 them. It specifies to which log or logs the message is written. The remaining
32660 arguments are a format and relevant insertion arguments. The string should not
32661 contain any newlines, not even at the end.
32662
32663
32664 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32665 This function adds an additional recipient to the message. The first argument
32666 is the recipient address. If it is unqualified (has no domain), it is qualified
32667 with the &%qualify_recipient%& domain. The second argument must always be -1.
32668
32669 This function does not allow you to specify a private &%errors_to%& address (as
32670 described with the structure of &%recipient_item%& above), because it pre-dates
32671 the addition of that field to the structure. However, it is easy to add such a
32672 value afterwards. For example:
32673 .code
32674  receive_add_recipient(US"monitor@mydom.example", -1);
32675  recipients_list[recipients_count-1].errors_to =
32676    US"postmaster@mydom.example";
32677 .endd
32678
32679 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32680 This is a convenience function to remove a named recipient from the list of
32681 recipients. It returns true if a recipient was removed, and false if no
32682 matching recipient could be found. The argument must be a complete email
32683 address.
32684 .endlist
32685
32686
32687 .cindex "RFC 2047"
32688 .vlist
32689 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32690   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32691 This function decodes strings that are encoded according to RFC 2047. Typically
32692 these are the contents of header lines. First, each &"encoded word"& is decoded
32693 from the Q or B encoding into a byte-string. Then, if provided with the name of
32694 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32695 made  to translate the result to the named character set. If this fails, the
32696 binary string is returned with an error message.
32697
32698 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32699 maximum MIME word length is enforced. The third argument is the target
32700 encoding, or NULL if no translation is wanted.
32701
32702 .cindex "binary zero" "in RFC 2047 decoding"
32703 .cindex "RFC 2047" "binary zero in"
32704 If a binary zero is encountered in the decoded string, it is replaced by the
32705 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32706 not be 0 because header lines are handled as zero-terminated strings.
32707
32708 The function returns the result of processing the string, zero-terminated; if
32709 &%lenptr%& is not NULL, the length of the result is set in the variable to
32710 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32711
32712 If an error is encountered, the function returns NULL and uses the &%error%&
32713 argument to return an error message. The variable pointed to by &%error%& is
32714 set to NULL if there is no error; it may be set non-NULL even when the function
32715 returns a non-NULL value if decoding was successful, but there was a problem
32716 with translation.
32717
32718
32719 .vitem &*int&~smtp_fflush(void)*&
32720 This function is used in conjunction with &'smtp_printf()'&, as described
32721 below.
32722
32723 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32724 The arguments of this function are like &[printf()]&; it writes to the SMTP
32725 output stream. You should use this function only when there is an SMTP output
32726 stream, that is, when the incoming message is being received via interactive
32727 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32728 is FALSE. If you want to test for an incoming message from another host (as
32729 opposed to a local process that used the &%-bs%& command line option), you can
32730 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32731 is involved.
32732
32733 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32734 output function, so it can be used for all forms of SMTP connection.
32735
32736 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32737 must start with an appropriate response code: 550 if you are going to return
32738 LOCAL_SCAN_REJECT, 451 if you are going to return
32739 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32740 initial lines of a multi-line response, the code must be followed by a hyphen
32741 to indicate that the line is not the final response line. You must also ensure
32742 that the lines you write terminate with CRLF. For example:
32743 .code
32744 smtp_printf("550-this is some extra info\r\n");
32745 return LOCAL_SCAN_REJECT;
32746 .endd
32747 Note that you can also create multi-line responses by including newlines in
32748 the data returned via the &%return_text%& argument. The added value of using
32749 &'smtp_printf()'& is that, for instance, you could introduce delays between
32750 multiple output lines.
32751
32752 The &'smtp_printf()'& function does not return any error indication, because it
32753 does not automatically flush pending output, and therefore does not test
32754 the state of the stream. (In the main code of Exim, flushing and error
32755 detection is done when Exim is ready for the next SMTP input command.) If
32756 you want to flush the output and check for an error (for example, the
32757 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32758 arguments. It flushes the output stream, and returns a non-zero value if there
32759 is an error.
32760
32761 .vitem &*void&~*store_get(int)*&
32762 This function accesses Exim's internal store (memory) manager. It gets a new
32763 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32764 runs out of memory. See the next section for a discussion of memory handling.
32765
32766 .vitem &*void&~*store_get_perm(int)*&
32767 This function is like &'store_get()'&, but it always gets memory from the
32768 permanent pool. See the next section for a discussion of memory handling.
32769
32770 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32771 See below.
32772
32773 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32774 See below.
32775
32776 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32777 These three functions create strings using Exim's dynamic memory facilities.
32778 The first makes a copy of an entire string. The second copies up to a maximum
32779 number of characters, indicated by the second argument. The third uses a format
32780 and insertion arguments to create a new string. In each case, the result is a
32781 pointer to a new string in the current memory pool. See the next section for
32782 more discussion.
32783 .endlist
32784
32785
32786
32787 .section "More about Exim's memory handling" "SECTmemhanloc"
32788 .cindex "&[local_scan()]& function" "memory handling"
32789 No function is provided for freeing memory, because that is never needed.
32790 The dynamic memory that Exim uses when receiving a message is automatically
32791 recycled if another message is received by the same process (this applies only
32792 to incoming SMTP connections &-- other input methods can supply only one
32793 message at a time). After receiving the last message, a reception process
32794 terminates.
32795
32796 Because it is recycled, the normal dynamic memory cannot be used for holding
32797 data that must be preserved over a number of incoming messages on the same SMTP
32798 connection. However, Exim in fact uses two pools of dynamic memory; the second
32799 one is not recycled, and can be used for this purpose.
32800
32801 If you want to allocate memory that remains available for subsequent messages
32802 in the same SMTP connection, you should set
32803 .code
32804 store_pool = POOL_PERM
32805 .endd
32806 before calling the function that does the allocation. There is no need to
32807 restore the value if you do not need to; however, if you do want to revert to
32808 the normal pool, you can either restore the previous value of &%store_pool%& or
32809 set it explicitly to POOL_MAIN.
32810
32811 The pool setting applies to all functions that get dynamic memory, including
32812 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32813 There is also a convenience function called &'store_get_perm()'& that gets a
32814 block of memory from the permanent pool while preserving the value of
32815 &%store_pool%&.
32816 .ecindex IIDlosca
32817
32818
32819
32820
32821 . ////////////////////////////////////////////////////////////////////////////
32822 . ////////////////////////////////////////////////////////////////////////////
32823
32824 .chapter "System-wide message filtering" "CHAPsystemfilter"
32825 .scindex IIDsysfil1 "filter" "system filter"
32826 .scindex IIDsysfil2 "filtering all mail"
32827 .scindex IIDsysfil3 "system filter"
32828 The previous chapters (on ACLs and the local scan function) describe checks
32829 that can be applied to messages before they are accepted by a host. There is
32830 also a mechanism for checking messages once they have been received, but before
32831 they are delivered. This is called the &'system filter'&.
32832
32833 The system filter operates in a similar manner to users' filter files, but it
32834 is run just once per message (however many recipients the message has).
32835 It should not normally be used as a substitute for routing, because &%deliver%&
32836 commands in a system router provide new envelope recipient addresses.
32837 The system filter must be an Exim filter. It cannot be a Sieve filter.
32838
32839 The system filter is run at the start of a delivery attempt, before any routing
32840 is done. If a message fails to be completely delivered at the first attempt,
32841 the system filter is run again at the start of every retry.
32842 If you want your filter to do something only once per message, you can make use
32843 of the &%first_delivery%& condition in an &%if%& command in the filter to
32844 prevent it happening on retries.
32845
32846 .vindex "&$domain$&"
32847 .vindex "&$local_part$&"
32848 &*Warning*&: Because the system filter runs just once, variables that are
32849 specific to individual recipient addresses, such as &$local_part$& and
32850 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32851 you want to run a centrally-specified filter for each recipient address
32852 independently, you can do so by setting up a suitable &(redirect)& router, as
32853 described in section &<<SECTperaddfil>>& below.
32854
32855
32856 .section "Specifying a system filter" "SECID212"
32857 .cindex "uid (user id)" "system filter"
32858 .cindex "gid (group id)" "system filter"
32859 The name of the file that contains the system filter must be specified by
32860 setting &%system_filter%&. If you want the filter to run under a uid and gid
32861 other than root, you must also set &%system_filter_user%& and
32862 &%system_filter_group%& as appropriate. For example:
32863 .code
32864 system_filter = /etc/mail/exim.filter
32865 system_filter_user = exim
32866 .endd
32867 If a system filter generates any deliveries directly to files or pipes (via the
32868 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32869 specified by setting &%system_filter_file_transport%& and
32870 &%system_filter_pipe_transport%&, respectively. Similarly,
32871 &%system_filter_reply_transport%& must be set to handle any messages generated
32872 by the &%reply%& command.
32873
32874
32875 .section "Testing a system filter" "SECID213"
32876 You can run simple tests of a system filter in the same way as for a user
32877 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32878 are permitted only in system filters are recognized.
32879
32880 If you want to test the combined effect of a system filter and a user filter,
32881 you can use both &%-bF%& and &%-bf%& on the same command line.
32882
32883
32884
32885 .section "Contents of a system filter" "SECID214"
32886 The language used to specify system filters is the same as for users' filter
32887 files. It is described in the separate end-user document &'Exim's interface to
32888 mail filtering'&. However, there are some additional features that are
32889 available only in system filters; these are described in subsequent sections.
32890 If they are encountered in a user's filter file or when testing with &%-bf%&,
32891 they cause errors.
32892
32893 .cindex "frozen messages" "manual thaw; testing in filter"
32894 There are two special conditions which, though available in users' filter
32895 files, are designed for use in system filters. The condition &%first_delivery%&
32896 is true only for the first attempt at delivering a message, and
32897 &%manually_thawed%& is true only if the message has been frozen, and
32898 subsequently thawed by an admin user. An explicit forced delivery counts as a
32899 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32900
32901 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32902 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32903 succeed, it will not be tried again.
32904 If you want Exim to retry an unseen delivery until it succeeds, you should
32905 arrange to set it up every time the filter runs.
32906
32907 When a system filter finishes running, the values of the variables &$n0$& &--
32908 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32909 users' filter files. Thus a system filter can, for example, set up &"scores"&
32910 to which users' filter files can refer.
32911
32912
32913
32914 .section "Additional variable for system filters" "SECID215"
32915 .vindex "&$recipients$&"
32916 The expansion variable &$recipients$&, containing a list of all the recipients
32917 of the message (separated by commas and white space), is available in system
32918 filters. It is not available in users' filters for privacy reasons.
32919
32920
32921
32922 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32923 .cindex "freezing messages"
32924 .cindex "message" "freezing"
32925 .cindex "message" "forced failure"
32926 .cindex "&%fail%&" "in system filter"
32927 .cindex "&%freeze%& in system filter"
32928 .cindex "&%defer%& in system filter"
32929 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32930 always available in system filters, but are not normally enabled in users'
32931 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32932 for the &(redirect)& router.) These commands can optionally be followed by the
32933 word &%text%& and a string containing an error message, for example:
32934 .code
32935 fail text "this message looks like spam to me"
32936 .endd
32937 The keyword &%text%& is optional if the next character is a double quote.
32938
32939 The &%defer%& command defers delivery of the original recipients of the
32940 message. The &%fail%& command causes all the original recipients to be failed,
32941 and a bounce message to be created. The &%freeze%& command suspends all
32942 delivery attempts for the original recipients. In all cases, any new deliveries
32943 that are specified by the filter are attempted as normal after the filter has
32944 run.
32945
32946 The &%freeze%& command is ignored if the message has been manually unfrozen and
32947 not manually frozen since. This means that automatic freezing by a system
32948 filter can be used as a way of checking out suspicious messages. If a message
32949 is found to be all right, manually unfreezing it allows it to be delivered.
32950
32951 .cindex "log" "&%fail%& command log line"
32952 .cindex "&%fail%&" "log line; reducing"
32953 The text given with a fail command is used as part of the bounce message as
32954 well as being written to the log. If the message is quite long, this can fill
32955 up a lot of log space when such failures are common. To reduce the size of the
32956 log message, Exim interprets the text in a special way if it starts with the
32957 two characters &`<<`& and contains &`>>`& later. The text between these two
32958 strings is written to the log, and the rest of the text is used in the bounce
32959 message. For example:
32960 .code
32961 fail "<<filter test 1>>Your message is rejected \
32962      because it contains attachments that we are \
32963      not prepared to receive."
32964 .endd
32965
32966 .cindex "loop" "caused by &%fail%&"
32967 Take great care with the &%fail%& command when basing the decision to fail on
32968 the contents of the message, because the bounce message will of course include
32969 the contents of the original message and will therefore trigger the &%fail%&
32970 command again (causing a mail loop) unless steps are taken to prevent this.
32971 Testing the &%error_message%& condition is one way to prevent this. You could
32972 use, for example
32973 .code
32974 if $message_body contains "this is spam" and not error_message
32975 then fail text "spam is not wanted here" endif
32976 .endd
32977 though of course that might let through unwanted bounce messages. The
32978 alternative is clever checking of the body and/or headers to detect bounces
32979 generated by the filter.
32980
32981 The interpretation of a system filter file ceases after a
32982 &%defer%&,
32983 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32984 set up earlier in the filter file are honoured, so you can use a sequence such
32985 as
32986 .code
32987 mail ...
32988 freeze
32989 .endd
32990 to send a specified message when the system filter is freezing (or deferring or
32991 failing) a message. The normal deliveries for the message do not, of course,
32992 take place.
32993
32994
32995
32996 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32997 .cindex "header lines" "adding; in system filter"
32998 .cindex "header lines" "removing; in system filter"
32999 .cindex "filter" "header lines; adding/removing"
33000 Two filter commands that are available only in system filters are:
33001 .code
33002 headers add <string>
33003 headers remove <string>
33004 .endd
33005 The argument for the &%headers add%& is a string that is expanded and then
33006 added to the end of the message's headers. It is the responsibility of the
33007 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33008 space is ignored, and if the string is otherwise empty, or if the expansion is
33009 forced to fail, the command has no effect.
33010
33011 You can use &"\n"& within the string, followed by white space, to specify
33012 continued header lines. More than one header may be added in one command by
33013 including &"\n"& within the string without any following white space. For
33014 example:
33015 .code
33016 headers add "X-header-1: ....\n  \
33017              continuation of X-header-1 ...\n\
33018              X-header-2: ...."
33019 .endd
33020 Note that the header line continuation white space after the first newline must
33021 be placed before the backslash that continues the input string, because white
33022 space after input continuations is ignored.
33023
33024 The argument for &%headers remove%& is a colon-separated list of header names.
33025 This command applies only to those headers that are stored with the message;
33026 those that are added at delivery time (such as &'Envelope-To:'& and
33027 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33028 header with the same name, they are all removed.
33029
33030 The &%headers%& command in a system filter makes an immediate change to the set
33031 of header lines that was received with the message (with possible additions
33032 from ACL processing). Subsequent commands in the system filter operate on the
33033 modified set, which also forms the basis for subsequent message delivery.
33034 Unless further modified during routing or transporting, this set of headers is
33035 used for all recipients of the message.
33036
33037 During routing and transporting, the variables that refer to the contents of
33038 header lines refer only to those lines that are in this set. Thus, header lines
33039 that are added by a system filter are visible to users' filter files and to all
33040 routers and transports. This contrasts with the manipulation of header lines by
33041 routers and transports, which is not immediate, but which instead is saved up
33042 until the message is actually being written (see section
33043 &<<SECTheadersaddrem>>&).
33044
33045 If the message is not delivered at the first attempt, header lines that were
33046 added by the system filter are stored with the message, and so are still
33047 present at the next delivery attempt. Header lines that were removed are still
33048 present, but marked &"deleted"& so that they are not transported with the
33049 message. For this reason, it is usual to make the &%headers%& command
33050 conditional on &%first_delivery%& so that the set of header lines is not
33051 modified more than once.
33052
33053 Because header modification in a system filter acts immediately, you have to
33054 use an indirect approach if you want to modify the contents of a header line.
33055 For example:
33056 .code
33057 headers add "Old-Subject: $h_subject:"
33058 headers remove "Subject"
33059 headers add "Subject: new subject (was: $h_old-subject:)"
33060 headers remove "Old-Subject"
33061 .endd
33062
33063
33064
33065 .section "Setting an errors address in a system filter" "SECID217"
33066 .cindex "envelope sender"
33067 In a system filter, if a &%deliver%& command is followed by
33068 .code
33069 errors_to <some address>
33070 .endd
33071 in order to change the envelope sender (and hence the error reporting) for that
33072 delivery, any address may be specified. (In a user filter, only the current
33073 user's address can be set.) For example, if some mail is being monitored, you
33074 might use
33075 .code
33076 unseen deliver monitor@spying.example errors_to root@local.example
33077 .endd
33078 to take a copy which would not be sent back to the normal error reporting
33079 address if its delivery failed.
33080
33081
33082
33083 .section "Per-address filtering" "SECTperaddfil"
33084 .vindex "&$domain$&"
33085 .vindex "&$local_part$&"
33086 In contrast to the system filter, which is run just once per message for each
33087 delivery attempt, it is also possible to set up a system-wide filtering
33088 operation that runs once for each recipient address. In this case, variables
33089 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33090 filter file could be made dependent on them. This is an example of a router
33091 which implements such a filter:
33092 .code
33093 central_filter:
33094   check_local_user
33095   driver = redirect
33096   domains = +local_domains
33097   file = /central/filters/$local_part
33098   no_verify
33099   allow_filter
33100   allow_freeze
33101 .endd
33102 The filter is run in a separate process under its own uid. Therefore, either
33103 &%check_local_user%& must be set (as above), in which case the filter is run as
33104 the local user, or the &%user%& option must be used to specify which user to
33105 use. If both are set, &%user%& overrides.
33106
33107 Care should be taken to ensure that none of the commands in the filter file
33108 specify a significant delivery if the message is to go on to be delivered to
33109 its intended recipient. The router will not then claim to have dealt with the
33110 address, so it will be passed on to subsequent routers to be delivered in the
33111 normal way.
33112 .ecindex IIDsysfil1
33113 .ecindex IIDsysfil2
33114 .ecindex IIDsysfil3
33115
33116
33117
33118
33119
33120
33121 . ////////////////////////////////////////////////////////////////////////////
33122 . ////////////////////////////////////////////////////////////////////////////
33123
33124 .chapter "Message processing" "CHAPmsgproc"
33125 .scindex IIDmesproc "message" "general processing"
33126 Exim performs various transformations on the sender and recipient addresses of
33127 all messages that it handles, and also on the messages' header lines. Some of
33128 these are optional and configurable, while others always take place. All of
33129 this processing, except rewriting as a result of routing, and the addition or
33130 removal of header lines while delivering, happens when a message is received,
33131 before it is placed on Exim's queue.
33132
33133 Some of the automatic processing takes place by default only for
33134 &"locally-originated"& messages. This adjective is used to describe messages
33135 that are not received over TCP/IP, but instead are passed to an Exim process on
33136 its standard input. This includes the interactive &"local SMTP"& case that is
33137 set up by the &%-bs%& command line option.
33138
33139 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33140 or ::1) are not considered to be locally-originated. Exim does not treat the
33141 loopback interface specially in any way.
33142
33143 If you want the loopback interface to be treated specially, you must ensure
33144 that there are appropriate entries in your ACLs.
33145
33146
33147
33148
33149 .section "Submission mode for non-local messages" "SECTsubmodnon"
33150 .cindex "message" "submission"
33151 .cindex "submission mode"
33152 Processing that happens automatically for locally-originated messages (unless
33153 &%suppress_local_fixups%& is set) can also be requested for messages that are
33154 received over TCP/IP. The term &"submission mode"& is used to describe this
33155 state. Submission mode is set by the modifier
33156 .code
33157 control = submission
33158 .endd
33159 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33160 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33161 a local submission, and is normally used when the source of the message is
33162 known to be an MUA running on a client host (as opposed to an MTA). For
33163 example, to set submission mode for messages originating on the IPv4 loopback
33164 interface, you could include the following in the MAIL ACL:
33165 .code
33166 warn  hosts = 127.0.0.1
33167       control = submission
33168 .endd
33169 .cindex "&%sender_retain%& submission option"
33170 There are some options that can be used when setting submission mode. A slash
33171 is used to separate options. For example:
33172 .code
33173 control = submission/sender_retain
33174 .endd
33175 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33176 true and &%local_from_check%& false for the current incoming message. The first
33177 of these allows an existing &'Sender:'& header in the message to remain, and
33178 the second suppresses the check to ensure that &'From:'& matches the
33179 authenticated sender. With this setting, Exim still fixes up messages by adding
33180 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33181 attempt to check sender authenticity in header lines.
33182
33183 When &%sender_retain%& is not set, a submission mode setting may specify a
33184 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33185 example:
33186 .code
33187 control = submission/domain=some.domain
33188 .endd
33189 The domain may be empty. How this value is used is described in sections
33190 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33191 that allows you to specify the user's full name for inclusion in a created
33192 &'Sender:'& or &'From:'& header line. For example:
33193 .code
33194 accept authenticated = *
33195        control = submission/domain=wonderland.example/\
33196                             name=${lookup {$authenticated_id} \
33197                                    lsearch {/etc/exim/namelist}}
33198 .endd
33199 Because the name may contain any characters, including slashes, the &%name%&
33200 option must be given last. The remainder of the string is used as the name. For
33201 the example above, if &_/etc/exim/namelist_& contains:
33202 .code
33203 bigegg:  Humpty Dumpty
33204 .endd
33205 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33206 line would be:
33207 .code
33208 Sender: Humpty Dumpty <bigegg@wonderland.example>
33209 .endd
33210 .cindex "return path" "in submission mode"
33211 By default, submission mode forces the return path to the same address as is
33212 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33213 specified, the return path is also left unchanged.
33214
33215 &*Note*&: The changes caused by submission mode take effect after the predata
33216 ACL. This means that any sender checks performed before the fix-ups use the
33217 untrusted sender address specified by the user, not the trusted sender address
33218 specified by submission mode. Although this might be slightly unexpected, it
33219 does mean that you can configure ACL checks to spot that a user is trying to
33220 spoof another's address.
33221
33222 .section "Line endings" "SECTlineendings"
33223 .cindex "line endings"
33224 .cindex "carriage return"
33225 .cindex "linefeed"
33226 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33227 linefeed) is the line ending for messages transmitted over the Internet using
33228 SMTP over TCP/IP. However, within individual operating systems, different
33229 conventions are used. For example, Unix-like systems use just LF, but others
33230 use CRLF or just CR.
33231
33232 Exim was designed for Unix-like systems, and internally, it stores messages
33233 using the system's convention of a single LF as a line terminator. When
33234 receiving a message, all line endings are translated to this standard format.
33235 Originally, it was thought that programs that passed messages directly to an
33236 MTA within an operating system would use that system's convention. Experience
33237 has shown that this is not the case; for example, there are Unix applications
33238 that use CRLF in this circumstance. For this reason, and for compatibility with
33239 other MTAs, the way Exim handles line endings for all messages is now as
33240 follows:
33241
33242 .ilist
33243 LF not preceded by CR is treated as a line ending.
33244 .next
33245 CR is treated as a line ending; if it is immediately followed by LF, the LF
33246 is ignored.
33247 .next
33248 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33249 nor a local message in the state where a line containing only a dot is a
33250 terminator.
33251 .next
33252 If a bare CR is encountered within a header line, an extra space is added after
33253 the line terminator so as not to end the header line. The reasoning behind this
33254 is that bare CRs in header lines are most likely either to be mistakes, or
33255 people trying to play silly games.
33256 .next
33257 If the first header line received in a message ends with CRLF, a subsequent
33258 bare LF in a header line is treated in the same way as a bare CR in a header
33259 line.
33260 .endlist
33261
33262
33263
33264
33265
33266 .section "Unqualified addresses" "SECID218"
33267 .cindex "unqualified addresses"
33268 .cindex "address" "qualification"
33269 By default, Exim expects every envelope address it receives from an external
33270 host to be fully qualified. Unqualified addresses cause negative responses to
33271 SMTP commands. However, because SMTP is used as a means of transporting
33272 messages from MUAs running on personal workstations, there is sometimes a
33273 requirement to accept unqualified addresses from specific hosts or IP networks.
33274
33275 Exim has two options that separately control which hosts may send unqualified
33276 sender or recipient addresses in SMTP commands, namely
33277 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33278 cases, if an unqualified address is accepted, it is qualified by adding the
33279 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33280
33281 .oindex "&%qualify_domain%&"
33282 .oindex "&%qualify_recipient%&"
33283 Unqualified addresses in header lines are automatically qualified for messages
33284 that are locally originated, unless the &%-bnq%& option is given on the command
33285 line. For messages received over SMTP, unqualified addresses in header lines
33286 are qualified only if unqualified addresses are permitted in SMTP commands. In
33287 other words, such qualification is also controlled by
33288 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33289
33290
33291
33292
33293 .section "The UUCP From line" "SECID219"
33294 .cindex "&""From""& line"
33295 .cindex "UUCP" "&""From""& line"
33296 .cindex "sender" "address"
33297 .oindex "&%uucp_from_pattern%&"
33298 .oindex "&%uucp_from_sender%&"
33299 .cindex "envelope sender"
33300 .cindex "Sendmail compatibility" "&""From""& line"
33301 Messages that have come from UUCP (and some other applications) often begin
33302 with a line containing the envelope sender and a timestamp, following the word
33303 &"From"&. Examples of two common formats are:
33304 .code
33305 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33306 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33307 .endd
33308 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33309 Exim recognizes such lines at the start of messages that are submitted to it
33310 via the command line (that is, on the standard input). It does not recognize
33311 such lines in incoming SMTP messages, unless the sending host matches
33312 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33313 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33314 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33315 default value matches the two common cases shown above and puts the address
33316 that follows &"From"& into &$1$&.
33317
33318 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33319 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33320 a trusted user, the message's sender address is constructed by expanding the
33321 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33322 then parsed as an RFC 2822 address. If there is no domain, the local part is
33323 qualified with &%qualify_domain%& unless it is the empty string. However, if
33324 the command line &%-f%& option is used, it overrides the &"From"& line.
33325
33326 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33327 sender address is not changed. This is also the case for incoming SMTP messages
33328 that are permitted to contain &"From"& lines.
33329
33330 Only one &"From"& line is recognized. If there is more than one, the second is
33331 treated as a data line that starts the body of the message, as it is not valid
33332 as a header line. This also happens if a &"From"& line is present in an
33333 incoming SMTP message from a source that is not permitted to send them.
33334
33335
33336
33337 .section "Resent- header lines" "SECID220"
33338 .cindex "&%Resent-%& header lines"
33339 .cindex "header lines" "Resent-"
33340 RFC 2822 makes provision for sets of header lines starting with the string
33341 &`Resent-`& to be added to a message when it is resent by the original
33342 recipient to somebody else. These headers are &'Resent-Date:'&,
33343 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33344 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33345
33346 .blockquote
33347 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33348 processing of replies or other such automatic actions on messages.'&
33349 .endblockquote
33350
33351 This leaves things a bit vague as far as other processing actions such as
33352 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33353 follows:
33354
33355 .ilist
33356 A &'Resent-From:'& line that just contains the login id of the submitting user
33357 is automatically rewritten in the same way as &'From:'& (see below).
33358 .next
33359 If there's a rewriting rule for a particular header line, it is also applied to
33360 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33361 &'From:'& also rewrites &'Resent-From:'&.
33362 .next
33363 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33364 also removed.
33365 .next
33366 For a locally-submitted message,
33367 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33368 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33369 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33370 included in log lines in this case.
33371 .next
33372 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33373 &%Resent-%& header lines are present.
33374 .endlist
33375
33376
33377
33378
33379 .section "The Auto-Submitted: header line" "SECID221"
33380 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33381 includes the header line:
33382 .code
33383 Auto-Submitted: auto-replied
33384 .endd
33385
33386 .section "The Bcc: header line" "SECID222"
33387 .cindex "&'Bcc:'& header line"
33388 If Exim is called with the &%-t%& option, to take recipient addresses from a
33389 message's header, it removes any &'Bcc:'& header line that may exist (after
33390 extracting its addresses). If &%-t%& is not present on the command line, any
33391 existing &'Bcc:'& is not removed.
33392
33393
33394 .section "The Date: header line" "SECID223"
33395 .cindex "&'Date:'& header line"
33396 .cindex "header lines" "Date:"
33397 If a locally-generated or submission-mode message has no &'Date:'& header line,
33398 Exim adds one, using the current date and time, unless the
33399 &%suppress_local_fixups%& control has been specified.
33400
33401 .section "The Delivery-date: header line" "SECID224"
33402 .cindex "&'Delivery-date:'& header line"
33403 .oindex "&%delivery_date_remove%&"
33404 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33405 set. Exim can be configured to add them to the final delivery of messages. (See
33406 the generic &%delivery_date_add%& transport option.) They should not be present
33407 in messages in transit. If the &%delivery_date_remove%& configuration option is
33408 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33409 messages.
33410
33411
33412 .section "The Envelope-to: header line" "SECID225"
33413 .cindex "&'Envelope-to:'& header line"
33414 .cindex "header lines" "Envelope-to:"
33415 .oindex "&%envelope_to_remove%&"
33416 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33417 Exim can be configured to add them to the final delivery of messages. (See the
33418 generic &%envelope_to_add%& transport option.) They should not be present in
33419 messages in transit. If the &%envelope_to_remove%& configuration option is set
33420 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33421 messages.
33422
33423
33424 .section "The From: header line" "SECTthefrohea"
33425 .cindex "&'From:'& header line"
33426 .cindex "header lines" "From:"
33427 .cindex "Sendmail compatibility" "&""From""& line"
33428 .cindex "message" "submission"
33429 .cindex "submission mode"
33430 If a submission-mode message does not contain a &'From:'& header line, Exim
33431 adds one if either of the following conditions is true:
33432
33433 .ilist
33434 The envelope sender address is not empty (that is, this is not a bounce
33435 message). The added header line copies the envelope sender address.
33436 .next
33437 .vindex "&$authenticated_id$&"
33438 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33439 .olist
33440 .vindex "&$qualify_domain$&"
33441 If no domain is specified by the submission control, the local part is
33442 &$authenticated_id$& and the domain is &$qualify_domain$&.
33443 .next
33444 If a non-empty domain is specified by the submission control, the local
33445 part is &$authenticated_id$&, and the domain is the specified domain.
33446 .next
33447 If an empty domain is specified by the submission control,
33448 &$authenticated_id$& is assumed to be the complete address.
33449 .endlist
33450 .endlist
33451
33452 A non-empty envelope sender takes precedence.
33453
33454 If a locally-generated incoming message does not contain a &'From:'& header
33455 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33456 containing the sender's address. The calling user's login name and full name
33457 are used to construct the address, as described in section &<<SECTconstr>>&.
33458 They are obtained from the password data by calling &[getpwuid()]& (but see the
33459 &%unknown_login%& configuration option). The address is qualified with
33460 &%qualify_domain%&.
33461
33462 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33463 &'From:'& header line containing just the unqualified login name of the calling
33464 user, this is replaced by an address containing the user's login name and full
33465 name as described in section &<<SECTconstr>>&.
33466
33467
33468 .section "The Message-ID: header line" "SECID226"
33469 .cindex "&'Message-ID:'& header line"
33470 .cindex "header lines" "Message-ID:"
33471 .cindex "message" "submission"
33472 .oindex "&%message_id_header_text%&"
33473 If a locally-generated or submission-mode incoming message does not contain a
33474 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33475 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33476 to the message. If there are any &'Resent-:'& headers in the message, it
33477 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33478 message id, preceded by the letter E to ensure it starts with a letter, and
33479 followed by @ and the primary host name. Additional information can be included
33480 in this header line by setting the &%message_id_header_text%& and/or
33481 &%message_id_header_domain%& options.
33482
33483
33484 .section "The Received: header line" "SECID227"
33485 .cindex "&'Received:'& header line"
33486 .cindex "header lines" "Received:"
33487 A &'Received:'& header line is added at the start of every message. The
33488 contents are defined by the &%received_header_text%& configuration option, and
33489 Exim automatically adds a semicolon and a timestamp to the configured string.
33490
33491 The &'Received:'& header is generated as soon as the message's header lines
33492 have been received. At this stage, the timestamp in the &'Received:'& header
33493 line is the time that the message started to be received. This is the value
33494 that is seen by the DATA ACL and by the &[local_scan()]& function.
33495
33496 Once a message is accepted, the timestamp in the &'Received:'& header line is
33497 changed to the time of acceptance, which is (apart from a small delay while the
33498 -H spool file is written) the earliest time at which delivery could start.
33499
33500
33501 .section "The References: header line" "SECID228"
33502 .cindex "&'References:'& header line"
33503 .cindex "header lines" "References:"
33504 Messages created by the &(autoreply)& transport include a &'References:'&
33505 header line. This is constructed according to the rules that are described in
33506 section 3.64 of RFC 2822 (which states that replies should contain such a
33507 header line), and section 3.14 of RFC 3834 (which states that automatic
33508 responses are not different in this respect). However, because some mail
33509 processing software does not cope well with very long header lines, no more
33510 than 12 message IDs are copied from the &'References:'& header line in the
33511 incoming message. If there are more than 12, the first one and then the final
33512 11 are copied, before adding the message ID of the incoming message.
33513
33514
33515
33516 .section "The Return-path: header line" "SECID229"
33517 .cindex "&'Return-path:'& header line"
33518 .cindex "header lines" "Return-path:"
33519 .oindex "&%return_path_remove%&"
33520 &'Return-path:'& header lines are defined as something an MTA may insert when
33521 it does the final delivery of messages. (See the generic &%return_path_add%&
33522 transport option.) Therefore, they should not be present in messages in
33523 transit. If the &%return_path_remove%& configuration option is set (the
33524 default), Exim removes &'Return-path:'& header lines from incoming messages.
33525
33526
33527
33528 .section "The Sender: header line" "SECTthesenhea"
33529 .cindex "&'Sender:'& header line"
33530 .cindex "message" "submission"
33531 .cindex "header lines" "Sender:"
33532 For a locally-originated message from an untrusted user, Exim may remove an
33533 existing &'Sender:'& header line, and it may add a new one. You can modify
33534 these actions by setting the &%local_sender_retain%& option true, the
33535 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33536 control setting.
33537
33538 When a local message is received from an untrusted user and
33539 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33540 control has not been set, a check is made to see if the address given in the
33541 &'From:'& header line is the correct (local) sender of the message. The address
33542 that is expected has the login name as the local part and the value of
33543 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33544 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33545 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33546 line is added to the message.
33547
33548 If you set &%local_from_check%& false, this checking does not occur. However,
33549 the removal of an existing &'Sender:'& line still happens, unless you also set
33550 &%local_sender_retain%& to be true. It is not possible to set both of these
33551 options true at the same time.
33552
33553 .cindex "submission mode"
33554 By default, no processing of &'Sender:'& header lines is done for messages
33555 received over TCP/IP or for messages submitted by trusted users. However, when
33556 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33557 not specified on the submission control, the following processing takes place:
33558
33559 .vindex "&$authenticated_id$&"
33560 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33561 authenticated, and &$authenticated_id$& is not empty, a sender address is
33562 created as follows:
33563
33564 .ilist
33565 .vindex "&$qualify_domain$&"
33566 If no domain is specified by the submission control, the local part is
33567 &$authenticated_id$& and the domain is &$qualify_domain$&.
33568 .next
33569 If a non-empty domain is specified by the submission control, the local part
33570 is &$authenticated_id$&, and the domain is the specified domain.
33571 .next
33572 If an empty domain is specified by the submission control,
33573 &$authenticated_id$& is assumed to be the complete address.
33574 .endlist
33575
33576 This address is compared with the address in the &'From:'& header line. If they
33577 are different, a &'Sender:'& header line containing the created address is
33578 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33579 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33580
33581 .cindex "return path" "created from &'Sender:'&"
33582 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33583 the message (the envelope sender address) is changed to be the same address,
33584 except in the case of submission mode when &%sender_retain%& is specified.
33585
33586
33587
33588 .section "Adding and removing header lines in routers and transports" &&&
33589          "SECTheadersaddrem"
33590 .cindex "header lines" "adding; in router or transport"
33591 .cindex "header lines" "removing; in router or transport"
33592 When a message is delivered, the addition and removal of header lines can be
33593 specified in a system filter, or on any of the routers and transports that
33594 process the message. Section &<<SECTaddremheasys>>& contains details about
33595 modifying headers in a system filter. Header lines can also be added in an ACL
33596 as a message is received (see section &<<SECTaddheadacl>>&).
33597
33598 In contrast to what happens in a system filter, header modifications that are
33599 specified on routers and transports apply only to the particular recipient
33600 addresses that are being processed by those routers and transports. These
33601 changes do not actually take place until a copy of the message is being
33602 transported. Therefore, they do not affect the basic set of header lines, and
33603 they do not affect the values of the variables that refer to header lines.
33604
33605 &*Note*&: In particular, this means that any expansions in the configuration of
33606 the transport cannot refer to the modified header lines, because such
33607 expansions all occur before the message is actually transported.
33608
33609 For both routers and transports, the argument of a &%headers_add%&
33610 option must be in the form of one or more RFC 2822 header lines, separated by
33611 newlines (coded as &"\n"&). For example:
33612 .code
33613 headers_add = X-added-header: added by $primary_hostname\n\
33614               X-added-second: another added header line
33615 .endd
33616 Exim does not check the syntax of these added header lines.
33617
33618 Multiple &%headers_add%& options for a single router or transport can be
33619 specified; the values will append to a single list of header lines.
33620 Each header-line is separately expanded.
33621
33622 The argument of a &%headers_remove%& option must consist of a colon-separated
33623 list of header names. This is confusing, because header names themselves are
33624 often terminated by colons. In this case, the colons are the list separators,
33625 not part of the names. For example:
33626 .code
33627 headers_remove = return-receipt-to:acknowledge-to
33628 .endd
33629
33630 Multiple &%headers_remove%& options for a single router or transport can be
33631 specified; the arguments will append to a single header-names list.
33632 Each item is separately expanded.
33633 Note that colons in complex expansions which are used to
33634 form all or part of a &%headers_remove%& list
33635 will act as list separators.
33636
33637 When &%headers_add%& or &%headers_remove%& is specified on a router,
33638 items are expanded at routing time,
33639 and then associated with all addresses that are
33640 accepted by that router, and also with any new addresses that it generates. If
33641 an address passes through several routers as a result of aliasing or
33642 forwarding, the changes are cumulative.
33643
33644 .oindex "&%unseen%&"
33645 However, this does not apply to multiple routers that result from the use of
33646 the &%unseen%& option. Any header modifications that were specified by the
33647 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33648
33649 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33650 settings cannot be delivered together in a batch, so a transport is always
33651 dealing with a set of addresses that have the same header-processing
33652 requirements.
33653
33654 The transport starts by writing the original set of header lines that arrived
33655 with the message, possibly modified by the system filter. As it writes out
33656 these lines, it consults the list of header names that were attached to the
33657 recipient address(es) by &%headers_remove%& options in routers, and it also
33658 consults the transport's own &%headers_remove%& option. Header lines whose
33659 names are on either of these lists are not written out. If there are multiple
33660 instances of any listed header, they are all skipped.
33661
33662 After the remaining original header lines have been written, new header
33663 lines that were specified by routers' &%headers_add%& options are written, in
33664 the order in which they were attached to the address. These are followed by any
33665 header lines specified by the transport's &%headers_add%& option.
33666
33667 This way of handling header line modifications in routers and transports has
33668 the following consequences:
33669
33670 .ilist
33671 The original set of header lines, possibly modified by the system filter,
33672 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33673 to it, at all times.
33674 .next
33675 Header lines that are added by a router's
33676 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33677 expansion syntax in subsequent routers or the transport.
33678 .next
33679 Conversely, header lines that are specified for removal by &%headers_remove%&
33680 in a router remain visible to subsequent routers and the transport.
33681 .next
33682 Headers added to an address by &%headers_add%& in a router cannot be removed by
33683 a later router or by a transport.
33684 .next
33685 An added header can refer to the contents of an original header that is to be
33686 removed, even it has the same name as the added header. For example:
33687 .code
33688 headers_remove = subject
33689 headers_add = Subject: new subject (was: $h_subject:)
33690 .endd
33691 .endlist
33692
33693 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33694 for a &(redirect)& router that has the &%one_time%& option set.
33695
33696
33697
33698
33699
33700 .section "Constructed addresses" "SECTconstr"
33701 .cindex "address" "constructed"
33702 .cindex "constructed address"
33703 When Exim constructs a sender address for a locally-generated message, it uses
33704 the form
33705 .display
33706 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33707 .endd
33708 For example:
33709 .code
33710 Zaphod Beeblebrox <zaphod@end.univ.example>
33711 .endd
33712 The user name is obtained from the &%-F%& command line option if set, or
33713 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33714 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33715 ampersand character, this is replaced by the login name with the first letter
33716 upper cased, as is conventional in a number of operating systems. See the
33717 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33718 The &%unknown_username%& option can be used to specify user names in cases when
33719 there is no password file entry.
33720
33721 .cindex "RFC 2047"
33722 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33723 parts of it if necessary. In addition, if it contains any non-printing
33724 characters, it is encoded as described in RFC 2047, which defines a way of
33725 including non-ASCII characters in header lines. The value of the
33726 &%headers_charset%& option specifies the name of the encoding that is used (the
33727 characters are assumed to be in this encoding). The setting of
33728 &%print_topbitchars%& controls whether characters with the top bit set (that
33729 is, with codes greater than 127) count as printing characters or not.
33730
33731
33732
33733 .section "Case of local parts" "SECID230"
33734 .cindex "case of local parts"
33735 .cindex "local part" "case of"
33736 RFC 2822 states that the case of letters in the local parts of addresses cannot
33737 be assumed to be non-significant. Exim preserves the case of local parts of
33738 addresses, but by default it uses a lower-cased form when it is routing,
33739 because on most Unix systems, usernames are in lower case and case-insensitive
33740 routing is required. However, any particular router can be made to use the
33741 original case for local parts by setting the &%caseful_local_part%& generic
33742 router option.
33743
33744 .cindex "mixed-case login names"
33745 If you must have mixed-case user names on your system, the best way to proceed,
33746 assuming you want case-independent handling of incoming email, is to set up
33747 your first router to convert incoming local parts in your domains to the
33748 correct case by means of a file lookup. For example:
33749 .code
33750 correct_case:
33751   driver = redirect
33752   domains = +local_domains
33753   data = ${lookup{$local_part}cdb\
33754               {/etc/usercased.cdb}{$value}fail}\
33755               @$domain
33756 .endd
33757 For this router, the local part is forced to lower case by the default action
33758 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33759 up a new local part in the correct case. If you then set &%caseful_local_part%&
33760 on any subsequent routers which process your domains, they will operate on
33761 local parts with the correct case in a case-sensitive manner.
33762
33763
33764
33765 .section "Dots in local parts" "SECID231"
33766 .cindex "dot" "in local part"
33767 .cindex "local part" "dots in"
33768 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33769 part may not begin or end with a dot, nor have two consecutive dots in the
33770 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33771 empty components for compatibility.
33772
33773
33774
33775 .section "Rewriting addresses" "SECID232"
33776 .cindex "rewriting" "addresses"
33777 Rewriting of sender and recipient addresses, and addresses in headers, can
33778 happen automatically, or as the result of configuration options, as described
33779 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33780 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33781
33782 Automatic rewriting includes qualification, as mentioned above. The other case
33783 in which it can happen is when an incomplete non-local domain is given. The
33784 routing process may cause this to be expanded into the full domain name. For
33785 example, a header such as
33786 .code
33787 To: hare@teaparty
33788 .endd
33789 might get rewritten as
33790 .code
33791 To: hare@teaparty.wonderland.fict.example
33792 .endd
33793 Rewriting as a result of routing is the one kind of message processing that
33794 does not happen at input time, as it cannot be done until the address has
33795 been routed.
33796
33797 Strictly, one should not do &'any'& deliveries of a message until all its
33798 addresses have been routed, in case any of the headers get changed as a
33799 result of routing. However, doing this in practice would hold up many
33800 deliveries for unreasonable amounts of time, just because one address could not
33801 immediately be routed. Exim therefore does not delay other deliveries when
33802 routing of one or more addresses is deferred.
33803 .ecindex IIDmesproc
33804
33805
33806
33807 . ////////////////////////////////////////////////////////////////////////////
33808 . ////////////////////////////////////////////////////////////////////////////
33809
33810 .chapter "SMTP processing" "CHAPSMTP"
33811 .scindex IIDsmtpproc1 "SMTP" "processing details"
33812 .scindex IIDsmtpproc2 "LMTP" "processing details"
33813 Exim supports a number of different ways of using the SMTP protocol, and its
33814 LMTP variant, which is an interactive protocol for transferring messages into a
33815 closed mail store application. This chapter contains details of how SMTP is
33816 processed. For incoming mail, the following are available:
33817
33818 .ilist
33819 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33820 .next
33821 SMTP over the standard input and output (the &%-bs%& option);
33822 .next
33823 Batched SMTP on the standard input (the &%-bS%& option).
33824 .endlist
33825
33826 For mail delivery, the following are available:
33827
33828 .ilist
33829 SMTP over TCP/IP (the &(smtp)& transport);
33830 .next
33831 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33832 &"lmtp"&);
33833 .next
33834 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33835 transport);
33836 .next
33837 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33838 the &%use_bsmtp%& option set).
33839 .endlist
33840
33841 &'Batched SMTP'& is the name for a process in which batches of messages are
33842 stored in or read from files (or pipes), in a format in which SMTP commands are
33843 used to contain the envelope information.
33844
33845
33846
33847 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33848 .cindex "SMTP" "outgoing over TCP/IP"
33849 .cindex "outgoing SMTP over TCP/IP"
33850 .cindex "LMTP" "over TCP/IP"
33851 .cindex "outgoing LMTP over TCP/IP"
33852 .cindex "EHLO"
33853 .cindex "HELO"
33854 .cindex "SIZE option on MAIL command"
33855 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33856 The &%protocol%& option selects which protocol is to be used, but the actual
33857 processing is the same in both cases.
33858
33859 If, in response to its EHLO command, Exim is told that the SIZE
33860 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33861 command. The value of <&'n'&> is the message size plus the value of the
33862 &%size_addition%& option (default 1024) to allow for additions to the message
33863 such as per-transport header lines, or changes made in a
33864 .cindex "transport" "filter"
33865 .cindex "filter" "transport filter"
33866 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33867 suppressed.
33868
33869 If the remote server advertises support for PIPELINING, Exim uses the
33870 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33871 required for the transaction.
33872
33873 If the remote server advertises support for the STARTTLS command, and Exim
33874 was built to support TLS encryption, it tries to start a TLS session unless the
33875 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33876 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33877 is called for verification.
33878
33879 If the remote server advertises support for the AUTH command, Exim scans
33880 the authenticators configuration for any suitable client settings, as described
33881 in chapter &<<CHAPSMTPAUTH>>&.
33882
33883 .cindex "carriage return"
33884 .cindex "linefeed"
33885 Responses from the remote host are supposed to be terminated by CR followed by
33886 LF. However, there are known to be hosts that do not send CR characters, so in
33887 order to be able to interwork with such hosts, Exim treats LF on its own as a
33888 line terminator.
33889
33890 If a message contains a number of different addresses, all those with the same
33891 characteristics (for example, the same envelope sender) that resolve to the
33892 same set of hosts, in the same order, are sent in a single SMTP transaction,
33893 even if they are for different domains, unless there are more than the setting
33894 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33895 they are split into groups containing no more than &%max_rcpt%&s addresses
33896 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33897 in parallel sessions. The order of hosts with identical MX values is not
33898 significant when checking whether addresses can be batched in this way.
33899
33900 When the &(smtp)& transport suffers a temporary failure that is not
33901 message-related, Exim updates its transport-specific database, which contains
33902 records indexed by host name that remember which messages are waiting for each
33903 particular host. It also updates the retry database with new retry times.
33904
33905 .cindex "hints database" "retry keys"
33906 Exim's retry hints are based on host name plus IP address, so if one address of
33907 a multi-homed host is broken, it will soon be skipped most of the time.
33908 See the next section for more detail about error handling.
33909
33910 .cindex "SMTP" "passed connection"
33911 .cindex "SMTP" "batching over TCP/IP"
33912 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33913 looks in the hints database for the transport to see if there are any queued
33914 messages waiting for the host to which it is connected. If it finds one, it
33915 creates a new Exim process using the &%-MC%& option (which can only be used by
33916 a process running as root or the Exim user) and passes the TCP/IP socket to it
33917 so that it can deliver another message using the same socket. The new process
33918 does only those deliveries that are routed to the connected host, and may in
33919 turn pass the socket on to a third process, and so on.
33920
33921 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33922 limit the number of messages sent down a single TCP/IP connection.
33923
33924 .cindex "asterisk" "after IP address"
33925 The second and subsequent messages delivered down an existing connection are
33926 identified in the main log by the addition of an asterisk after the closing
33927 square bracket of the IP address.
33928
33929
33930
33931
33932 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33933 .cindex "error" "in outgoing SMTP"
33934 .cindex "SMTP" "errors in outgoing"
33935 .cindex "host" "error"
33936 Three different kinds of error are recognized for outgoing SMTP: host errors,
33937 message errors, and recipient errors.
33938
33939 .vlist
33940 .vitem "&*Host errors*&"
33941 A host error is not associated with a particular message or with a
33942 particular recipient of a message. The host errors are:
33943
33944 .ilist
33945 Connection refused or timed out,
33946 .next
33947 Any error response code on connection,
33948 .next
33949 Any error response code to EHLO or HELO,
33950 .next
33951 Loss of connection at any time, except after &"."&,
33952 .next
33953 I/O errors at any time,
33954 .next
33955 Timeouts during the session, other than in response to MAIL, RCPT or
33956 the &"."& at the end of the data.
33957 .endlist ilist
33958
33959 For a host error, a permanent error response on connection, or in response to
33960 EHLO, causes all addresses routed to the host to be failed. Any other host
33961 error causes all addresses to be deferred, and retry data to be created for the
33962 host. It is not tried again, for any message, until its retry time arrives. If
33963 the current set of addresses are not all delivered in this run (to some
33964 alternative host), the message is added to the list of those waiting for this
33965 host, so if it is still undelivered when a subsequent successful delivery is
33966 made to the host, it will be sent down the same SMTP connection.
33967
33968 .vitem "&*Message errors*&"
33969 .cindex "message" "error"
33970 A message error is associated with a particular message when sent to a
33971 particular host, but not with a particular recipient of the message. The
33972 message errors are:
33973
33974 .ilist
33975 Any error response code to MAIL, DATA, or the &"."& that terminates
33976 the data,
33977 .next
33978 Timeout after MAIL,
33979 .next
33980 Timeout or loss of connection after the &"."& that terminates the data. A
33981 timeout after the DATA command itself is treated as a host error, as is loss of
33982 connection at any other time.
33983 .endlist ilist
33984
33985 For a message error, a permanent error response (5&'xx'&) causes all addresses
33986 to be failed, and a delivery error report to be returned to the sender. A
33987 temporary error response (4&'xx'&), or one of the timeouts, causes all
33988 addresses to be deferred. Retry data is not created for the host, but instead,
33989 a retry record for the combination of host plus message id is created. The
33990 message is not added to the list of those waiting for this host. This ensures
33991 that the failing message will not be sent to this host again until the retry
33992 time arrives. However, other messages that are routed to the host are not
33993 affected, so if it is some property of the message that is causing the error,
33994 it will not stop the delivery of other mail.
33995
33996 If the remote host specified support for the SIZE parameter in its response
33997 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33998 over-large message will cause a message error because the error arrives as a
33999 response to MAIL.
34000
34001 .vitem "&*Recipient errors*&"
34002 .cindex "recipient" "error"
34003 A recipient error is associated with a particular recipient of a message. The
34004 recipient errors are:
34005
34006 .ilist
34007 Any error response to RCPT,
34008 .next
34009 Timeout after RCPT.
34010 .endlist
34011
34012 For a recipient error, a permanent error response (5&'xx'&) causes the
34013 recipient address to be failed, and a bounce message to be returned to the
34014 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34015 address to be deferred, and routing retry data to be created for it. This is
34016 used to delay processing of the address in subsequent queue runs, until its
34017 routing retry time arrives. This applies to all messages, but because it
34018 operates only in queue runs, one attempt will be made to deliver a new message
34019 to the failing address before the delay starts to operate. This ensures that,
34020 if the failure is really related to the message rather than the recipient
34021 (&"message too big for this recipient"& is a possible example), other messages
34022 have a chance of getting delivered. If a delivery to the address does succeed,
34023 the retry information gets cleared, so all stuck messages get tried again, and
34024 the retry clock is reset.
34025
34026 The message is not added to the list of those waiting for this host. Use of the
34027 host for other messages is unaffected, and except in the case of a timeout,
34028 other recipients are processed independently, and may be successfully delivered
34029 in the current SMTP session. After a timeout it is of course impossible to
34030 proceed with the session, so all addresses get deferred. However, those other
34031 than the one that failed do not suffer any subsequent retry delays. Therefore,
34032 if one recipient is causing trouble, the others have a chance of getting
34033 through when a subsequent delivery attempt occurs before the failing
34034 recipient's retry time.
34035 .endlist
34036
34037 In all cases, if there are other hosts (or IP addresses) available for the
34038 current set of addresses (for example, from multiple MX records), they are
34039 tried in this run for any undelivered addresses, subject of course to their
34040 own retry data. In other words, recipient error retry data does not take effect
34041 until the next delivery attempt.
34042
34043 Some hosts have been observed to give temporary error responses to every
34044 MAIL command at certain times (&"insufficient space"& has been seen). It
34045 would be nice if such circumstances could be recognized, and defer data for the
34046 host itself created, but this is not possible within the current Exim design.
34047 What actually happens is that retry data for every (host, message) combination
34048 is created.
34049
34050 The reason that timeouts after MAIL and RCPT are treated specially is that
34051 these can sometimes arise as a result of the remote host's verification
34052 procedures. Exim makes this assumption, and treats them as if a temporary error
34053 response had been received. A timeout after &"."& is treated specially because
34054 it is known that some broken implementations fail to recognize the end of the
34055 message if the last character of the last line is a binary zero. Thus, it is
34056 helpful to treat this case as a message error.
34057
34058 Timeouts at other times are treated as host errors, assuming a problem with the
34059 host, or the connection to it. If a timeout after MAIL, RCPT,
34060 or &"."& is really a connection problem, the assumption is that at the next try
34061 the timeout is likely to occur at some other point in the dialogue, causing it
34062 then to be treated as a host error.
34063
34064 There is experimental evidence that some MTAs drop the connection after the
34065 terminating &"."& if they do not like the contents of the message for some
34066 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34067 should be given. That is why Exim treats this case as a message rather than a
34068 host error, in order not to delay other messages to the same host.
34069
34070
34071
34072
34073 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34074 .cindex "SMTP" "incoming over TCP/IP"
34075 .cindex "incoming SMTP over TCP/IP"
34076 .cindex "inetd"
34077 .cindex "daemon"
34078 Incoming SMTP messages can be accepted in one of two ways: by running a
34079 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34080 &_/etc/inetd.conf_& should be like this:
34081 .code
34082 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34083 .endd
34084 Exim distinguishes between this case and the case of a locally running user
34085 agent using the &%-bs%& option by checking whether or not the standard input is
34086 a socket. When it is, either the port must be privileged (less than 1024), or
34087 the caller must be root or the Exim user. If any other user passes a socket
34088 with an unprivileged port number, Exim prints a message on the standard error
34089 stream and exits with an error code.
34090
34091 By default, Exim does not make a log entry when a remote host connects or
34092 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34093 unexpected. It can be made to write such log entries by setting the
34094 &%smtp_connection%& log selector.
34095
34096 .cindex "carriage return"
34097 .cindex "linefeed"
34098 Commands from the remote host are supposed to be terminated by CR followed by
34099 LF. However, there are known to be hosts that do not send CR characters. In
34100 order to be able to interwork with such hosts, Exim treats LF on its own as a
34101 line terminator.
34102 Furthermore, because common code is used for receiving messages from all
34103 sources, a CR on its own is also interpreted as a line terminator. However, the
34104 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34105
34106 .cindex "EHLO" "invalid data"
34107 .cindex "HELO" "invalid data"
34108 One area that sometimes gives rise to problems concerns the EHLO or
34109 HELO commands. Some clients send syntactically invalid versions of these
34110 commands, which Exim rejects by default. (This is nothing to do with verifying
34111 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34112 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34113 match the broken hosts that send invalid commands.
34114
34115 .cindex "SIZE option on MAIL command"
34116 .cindex "MAIL" "SIZE option"
34117 The amount of disk space available is checked whenever SIZE is received on
34118 a MAIL command, independently of whether &%message_size_limit%& or
34119 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34120 false. A temporary error is given if there is not enough space. If
34121 &%check_spool_space%& is set, the check is for that amount of space plus the
34122 value given with SIZE, that is, it checks that the addition of the incoming
34123 message will not reduce the space below the threshold.
34124
34125 When a message is successfully received, Exim includes the local message id in
34126 its response to the final &"."& that terminates the data. If the remote host
34127 logs this text it can help with tracing what has happened to a message.
34128
34129 The Exim daemon can limit the number of simultaneous incoming connections it is
34130 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34131 number of simultaneous incoming connections from a single remote host (see the
34132 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34133 rejected using the SMTP temporary error code 421.
34134
34135 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34136 subprocess has finished, as this can get lost at busy times. Instead, it looks
34137 for completed subprocesses every time it wakes up. Provided there are other
34138 things happening (new incoming calls, starts of queue runs), completed
34139 processes will be noticed and tidied away. On very quiet systems you may
34140 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34141 it will be noticed when the daemon next wakes up.
34142
34143 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34144 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34145 high system load &-- for details see the &%smtp_accept_reserve%&,
34146 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34147 applies in both the daemon and &'inetd'& cases.
34148
34149 Exim normally starts a delivery process for each message received, though this
34150 can be varied by means of the &%-odq%& command line option and the
34151 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34152 number of simultaneously running delivery processes started in this way from
34153 SMTP input can be limited by the &%smtp_accept_queue%& and
34154 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34155 subsequently received messages are just put on the input queue without starting
34156 a delivery process.
34157
34158 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34159 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34160 started up from the &'inetd'& daemon, because in that case each connection is
34161 handled by an entirely independent Exim process. Control by load average is,
34162 however, available with &'inetd'&.
34163
34164 Exim can be configured to verify addresses in incoming SMTP commands as they
34165 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34166 to rewrite addresses at this time &-- before any syntax checking is done. See
34167 section &<<SECTrewriteS>>&.
34168
34169 Exim can also be configured to limit the rate at which a client host submits
34170 MAIL and RCPT commands in a single SMTP session. See the
34171 &%smtp_ratelimit_hosts%& option.
34172
34173
34174
34175 .section "Unrecognized SMTP commands" "SECID234"
34176 .cindex "SMTP" "unrecognized commands"
34177 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34178 commands during a single SMTP connection, it drops the connection after sending
34179 the error response to the last command. The default value for
34180 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34181 abuse that subvert web servers into making connections to SMTP ports; in these
34182 circumstances, a number of non-SMTP lines are sent first.
34183
34184
34185 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34186 .cindex "SMTP" "syntax errors"
34187 .cindex "SMTP" "protocol errors"
34188 A syntax error is detected if an SMTP command is recognized, but there is
34189 something syntactically wrong with its data, for example, a malformed email
34190 address in a RCPT command. Protocol errors include invalid command
34191 sequencing such as RCPT before MAIL. If Exim receives more than
34192 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34193 drops the connection after sending the error response to the last command. The
34194 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34195 broken clients that loop sending bad commands (yes, it has been seen).
34196
34197
34198
34199 .section "Use of non-mail SMTP commands" "SECID236"
34200 .cindex "SMTP" "non-mail commands"
34201 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34202 DATA. Exim counts such commands, and drops the connection if there are too
34203 many of them in a single SMTP session. This action catches some
34204 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34205 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34206 defines what &"too many"& means. Its default value is 10.
34207
34208 When a new message is expected, one occurrence of RSET is not counted. This
34209 allows a client to send one RSET between messages (this is not necessary,
34210 but some clients do it). Exim also allows one uncounted occurrence of HELO
34211 or EHLO, and one occurrence of STARTTLS between messages. After
34212 starting up a TLS session, another EHLO is expected, and so it too is not
34213 counted.
34214
34215 The first occurrence of AUTH in a connection, or immediately following
34216 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34217 RCPT, DATA, and QUIT are counted.
34218
34219 You can control which hosts are subject to the limit set by
34220 &%smtp_accept_max_nonmail%& by setting
34221 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34222 the limit apply to all hosts. This option means that you can exclude any
34223 specific badly-behaved hosts that you have to live with.
34224
34225
34226
34227
34228 .section "The VRFY and EXPN commands" "SECID237"
34229 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34230 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34231 appropriate) in order to decide whether the command should be accepted or not.
34232
34233 .cindex "VRFY" "processing"
34234 When no ACL is defined for VRFY, or if it rejects without
34235 setting an explicit response code, the command is accepted
34236 (with a 252 SMTP response code)
34237 in order to support awkward clients that do a VRFY before every RCPT.
34238 When VRFY is accepted, it runs exactly the same code as when Exim is
34239 called with the &%-bv%& option, and returns 250/451/550
34240 SMTP response codes.
34241
34242 .cindex "EXPN" "processing"
34243 If no ACL for EXPN is defined, the command is rejected.
34244 When EXPN is accepted, a single-level expansion of the address is done.
34245 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34246 than a verification (the &%-bv%& option). If an unqualified local part is given
34247 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34248 of VRFY and EXPN commands are logged on the main and reject logs, and
34249 VRFY verification failures are logged on the main log for consistency with
34250 RCPT failures.
34251
34252
34253
34254 .section "The ETRN command" "SECTETRN"
34255 .cindex "ETRN" "processing"
34256 RFC 1985 describes an SMTP command called ETRN that is designed to
34257 overcome the security problems of the TURN command (which has fallen into
34258 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34259 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34260 should be accepted or not. If no ACL is defined, the command is rejected.
34261
34262 The ETRN command is concerned with &"releasing"& messages that are awaiting
34263 delivery to certain hosts. As Exim does not organize its message queue by host,
34264 the only form of ETRN that is supported by default is the one where the
34265 text starts with the &"#"& prefix, in which case the remainder of the text is
34266 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34267 the &%-R%& option to happen, with the remainder of the ETRN text as its
34268 argument. For example,
34269 .code
34270 ETRN #brigadoon
34271 .endd
34272 runs the command
34273 .code
34274 exim -R brigadoon
34275 .endd
34276 which causes a delivery attempt on all messages with undelivered addresses
34277 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34278 default), Exim prevents the simultaneous execution of more than one queue run
34279 for the same argument string as a result of an ETRN command. This stops
34280 a misbehaving client from starting more than one queue runner at once.
34281
34282 .cindex "hints database" "ETRN serialization"
34283 Exim implements the serialization by means of a hints database in which a
34284 record is written whenever a process is started by ETRN, and deleted when
34285 the process completes. However, Exim does not keep the SMTP session waiting for
34286 the ETRN process to complete. Once ETRN is accepted, the client is sent
34287 a &"success"& return code. Obviously there is scope for hints records to get
34288 left lying around if there is a system or program crash. To guard against this,
34289 Exim ignores any records that are more than six hours old.
34290
34291 .oindex "&%smtp_etrn_command%&"
34292 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34293 used. This specifies a command that is run whenever ETRN is received,
34294 whatever the form of its argument. For
34295 example:
34296 .code
34297 smtp_etrn_command = /etc/etrn_command $domain \
34298                     $sender_host_address
34299 .endd
34300 .vindex "&$domain$&"
34301 The string is split up into arguments which are independently expanded. The
34302 expansion variable &$domain$& is set to the argument of the ETRN command,
34303 and no syntax checking is done on the contents of this argument. Exim does not
34304 wait for the command to complete, so its status code is not checked. Exim runs
34305 under its own uid and gid when receiving incoming SMTP, so it is not possible
34306 for it to change them before running the command.
34307
34308
34309
34310 .section "Incoming local SMTP" "SECID238"
34311 .cindex "SMTP" "local incoming"
34312 Some user agents use SMTP to pass messages to their local MTA using the
34313 standard input and output, as opposed to passing the envelope on the command
34314 line and writing the message to the standard input. This is supported by the
34315 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34316 messages over TCP/IP (including the use of ACLs), except that the envelope
34317 sender given in a MAIL command is ignored unless the caller is trusted. In
34318 an ACL you can detect this form of SMTP input by testing for an empty host
34319 identification. It is common to have this as the first line in the ACL that
34320 runs for RCPT commands:
34321 .code
34322 accept hosts = :
34323 .endd
34324 This accepts SMTP messages from local processes without doing any other tests.
34325
34326
34327
34328 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34329 .cindex "SMTP" "batched outgoing"
34330 .cindex "batched SMTP output"
34331 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34332 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34333 be output in BSMTP format. No SMTP responses are possible for this form of
34334 delivery. All it is doing is using SMTP commands as a way of transmitting the
34335 envelope along with the message.
34336
34337 The message is written to the file or pipe preceded by the SMTP commands
34338 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34339 the message that start with a dot have an extra dot added. The SMTP command
34340 HELO is not normally used. If it is required, the &%message_prefix%& option
34341 can be used to specify it.
34342
34343 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34344 one recipient address at a time by default. However, you can arrange for them
34345 to handle several addresses at once by setting the &%batch_max%& option. When
34346 this is done for BSMTP, messages may contain multiple RCPT commands. See
34347 chapter &<<CHAPbatching>>& for more details.
34348
34349 .vindex "&$host$&"
34350 When one or more addresses are routed to a BSMTP transport by a router that
34351 sets up a host list, the name of the first host on the list is available to the
34352 transport in the variable &$host$&. Here is an example of such a transport and
34353 router:
34354 .code
34355 begin routers
34356 route_append:
34357   driver = manualroute
34358   transport = smtp_appendfile
34359   route_list = domain.example  batch.host.example
34360
34361 begin transports
34362 smtp_appendfile:
34363   driver = appendfile
34364   directory = /var/bsmtp/$host
34365   batch_max = 1000
34366   use_bsmtp
34367   user = exim
34368 .endd
34369 This causes messages addressed to &'domain.example'& to be written in BSMTP
34370 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34371 message (unless there are more than 1000 recipients).
34372
34373
34374
34375 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34376 .cindex "SMTP" "batched incoming"
34377 .cindex "batched SMTP input"
34378 The &%-bS%& command line option causes Exim to accept one or more messages by
34379 reading SMTP on the standard input, but to generate no responses. If the caller
34380 is trusted, the senders in the MAIL commands are believed; otherwise the
34381 sender is always the caller of Exim. Unqualified senders and receivers are not
34382 rejected (there seems little point) but instead just get qualified. HELO
34383 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34384 as NOOP; QUIT quits.
34385
34386 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34387 ACL is run in the same way as for non-SMTP local input.
34388
34389 If an error is detected while reading a message, including a missing &"."& at
34390 the end, Exim gives up immediately. It writes details of the error to the
34391 standard output in a stylized way that the calling program should be able to
34392 make some use of automatically, for example:
34393 .code
34394 554 Unexpected end of file
34395 Transaction started in line 10
34396 Error detected in line 14
34397 .endd
34398 It writes a more verbose version, for human consumption, to the standard error
34399 file, for example:
34400 .code
34401 An error was detected while processing a file of BSMTP input.
34402 The error message was:
34403
34404 501 '>' missing at end of address
34405
34406 The SMTP transaction started in line 10.
34407 The error was detected in line 12.
34408 The SMTP command at fault was:
34409
34410 rcpt to:<malformed@in.com.plete
34411
34412 1 previous message was successfully processed.
34413 The rest of the batch was abandoned.
34414 .endd
34415 The return code from Exim is zero only if there were no errors. It is 1 if some
34416 messages were accepted before an error was detected, and 2 if no messages were
34417 accepted.
34418 .ecindex IIDsmtpproc1
34419 .ecindex IIDsmtpproc2
34420
34421
34422
34423 . ////////////////////////////////////////////////////////////////////////////
34424 . ////////////////////////////////////////////////////////////////////////////
34425
34426 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34427          "Customizing messages"
34428 When a message fails to be delivered, or remains on the queue for more than a
34429 configured amount of time, Exim sends a message to the original sender, or
34430 to an alternative configured address. The text of these messages is built into
34431 the code of Exim, but it is possible to change it, either by adding a single
34432 string, or by replacing each of the paragraphs by text supplied in a file.
34433
34434 The &'From:'& and &'To:'& header lines are automatically generated; you can
34435 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34436 option. Exim also adds the line
34437 .code
34438 Auto-Submitted: auto-generated
34439 .endd
34440 to all warning and bounce messages,
34441
34442
34443 .section "Customizing bounce messages" "SECID239"
34444 .cindex "customizing" "bounce message"
34445 .cindex "bounce message" "customizing"
34446 If &%bounce_message_text%& is set, its contents are included in the default
34447 message immediately after &"This message was created automatically by mail
34448 delivery software."& The string is not expanded. It is not used if
34449 &%bounce_message_file%& is set.
34450
34451 When &%bounce_message_file%& is set, it must point to a template file for
34452 constructing error messages. The file consists of a series of text items,
34453 separated by lines consisting of exactly four asterisks. If the file cannot be
34454 opened, default text is used and a message is written to the main and panic
34455 logs. If any text item in the file is empty, default text is used for that
34456 item.
34457
34458 .vindex "&$bounce_recipient$&"
34459 .vindex "&$bounce_return_size_limit$&"
34460 Each item of text that is read from the file is expanded, and there are two
34461 expansion variables which can be of use here: &$bounce_recipient$& is set to
34462 the recipient of an error message while it is being created, and
34463 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34464 option, rounded to a whole number.
34465
34466 The items must appear in the file in the following order:
34467
34468 .ilist
34469 The first item is included in the headers, and should include at least a
34470 &'Subject:'& header. Exim does not check the syntax of these headers.
34471 .next
34472 The second item forms the start of the error message. After it, Exim lists the
34473 failing addresses with their error messages.
34474 .next
34475 The third item is used to introduce any text from pipe transports that is to be
34476 returned to the sender. It is omitted if there is no such text.
34477 .next
34478 The fourth, fifth and sixth items will be ignored and may be empty.
34479 The fields exist for back-compatibility
34480 .endlist
34481
34482 The default state (&%bounce_message_file%& unset) is equivalent to the
34483 following file, in which the sixth item is empty. The &'Subject:'& and some
34484 other lines have been split in order to fit them on the page:
34485 .code
34486 Subject: Mail delivery failed
34487   ${if eq{$sender_address}{$bounce_recipient}
34488   {: returning message to sender}}
34489 ****
34490 This message was created automatically by mail delivery software.
34491
34492 A message ${if eq{$sender_address}{$bounce_recipient}
34493   {that you sent }{sent by
34494
34495 <$sender_address>
34496
34497 }}could not be delivered to all of its recipients.
34498 This is a permanent error. The following address(es) failed:
34499 ****
34500 The following text was generated during the delivery attempt(s):
34501 ****
34502 ------ This is a copy of the message, including all the headers.
34503   ------
34504 ****
34505 ------ The body of the message is $message_size characters long;
34506   only the first
34507 ------ $bounce_return_size_limit or so are included here.
34508 ****
34509 .endd
34510 .section "Customizing warning messages" "SECTcustwarn"
34511 .cindex "customizing" "warning message"
34512 .cindex "warning of delay" "customizing the message"
34513 The option &%warn_message_file%& can be pointed at a template file for use when
34514 warnings about message delays are created. In this case there are only three
34515 text sections:
34516
34517 .ilist
34518 The first item is included in the headers, and should include at least a
34519 &'Subject:'& header. Exim does not check the syntax of these headers.
34520 .next
34521 The second item forms the start of the warning message. After it, Exim lists
34522 the delayed addresses.
34523 .next
34524 The third item then ends the message.
34525 .endlist
34526
34527 The default state is equivalent to the following file, except that some lines
34528 have been split here, in order to fit them on the page:
34529 .code
34530 Subject: Warning: message $message_exim_id delayed
34531   $warn_message_delay
34532 ****
34533 This message was created automatically by mail delivery software.
34534
34535 A message ${if eq{$sender_address}{$warn_message_recipients}
34536 {that you sent }{sent by
34537
34538 <$sender_address>
34539
34540 }}has not been delivered to all of its recipients after
34541 more than $warn_message_delay on the queue on $primary_hostname.
34542
34543 The message identifier is:     $message_exim_id
34544 The subject of the message is: $h_subject
34545 The date of the message is:    $h_date
34546
34547 The following address(es) have not yet been delivered:
34548 ****
34549 No action is required on your part. Delivery attempts will
34550 continue for some time, and this warning may be repeated at
34551 intervals if the message remains undelivered. Eventually the
34552 mail delivery software will give up, and when that happens,
34553 the message will be returned to you.
34554 .endd
34555 .vindex "&$warn_message_delay$&"
34556 .vindex "&$warn_message_recipients$&"
34557 However, in the default state the subject and date lines are omitted if no
34558 appropriate headers exist. During the expansion of this file,
34559 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34560 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34561 of recipients for the warning message. There may be more than one if there are
34562 multiple addresses with different &%errors_to%& settings on the routers that
34563 handled them.
34564
34565
34566
34567
34568 . ////////////////////////////////////////////////////////////////////////////
34569 . ////////////////////////////////////////////////////////////////////////////
34570
34571 .chapter "Some common configuration settings" "CHAPcomconreq"
34572 This chapter discusses some configuration settings that seem to be fairly
34573 common. More examples and discussion can be found in the Exim book.
34574
34575
34576
34577 .section "Sending mail to a smart host" "SECID240"
34578 .cindex "smart host" "example router"
34579 If you want to send all mail for non-local domains to a &"smart host"&, you
34580 should replace the default &(dnslookup)& router with a router which does the
34581 routing explicitly:
34582 .code
34583 send_to_smart_host:
34584   driver = manualroute
34585   route_list = !+local_domains smart.host.name
34586   transport = remote_smtp
34587 .endd
34588 You can use the smart host's IP address instead of the name if you wish.
34589 If you are using Exim only to submit messages to a smart host, and not for
34590 receiving incoming messages, you can arrange for it to do the submission
34591 synchronously by setting the &%mua_wrapper%& option (see chapter
34592 &<<CHAPnonqueueing>>&).
34593
34594
34595
34596
34597 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34598 .cindex "mailing lists"
34599 Exim can be used to run simple mailing lists, but for large and/or complicated
34600 requirements, the use of additional specialized mailing list software such as
34601 Majordomo or Mailman is recommended.
34602
34603 The &(redirect)& router can be used to handle mailing lists where each list
34604 is maintained in a separate file, which can therefore be managed by an
34605 independent manager. The &%domains%& router option can be used to run these
34606 lists in a separate domain from normal mail. For example:
34607 .code
34608 lists:
34609   driver = redirect
34610   domains = lists.example
34611   file = /usr/lists/$local_part
34612   forbid_pipe
34613   forbid_file
34614   errors_to = $local_part-request@lists.example
34615   no_more
34616 .endd
34617 This router is skipped for domains other than &'lists.example'&. For addresses
34618 in that domain, it looks for a file that matches the local part. If there is no
34619 such file, the router declines, but because &%no_more%& is set, no subsequent
34620 routers are tried, and so the whole delivery fails.
34621
34622 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34623 expanded into a file name or a pipe delivery, which is usually inappropriate in
34624 a mailing list.
34625
34626 .oindex "&%errors_to%&"
34627 The &%errors_to%& option specifies that any delivery errors caused by addresses
34628 taken from a mailing list are to be sent to the given address rather than the
34629 original sender of the message. However, before acting on this, Exim verifies
34630 the error address, and ignores it if verification fails.
34631
34632 For example, using the configuration above, mail sent to
34633 &'dicts@lists.example'& is passed on to those addresses contained in
34634 &_/usr/lists/dicts_&, with error reports directed to
34635 &'dicts-request@lists.example'&, provided that this address can be verified.
34636 There could be a file called &_/usr/lists/dicts-request_& containing
34637 the address(es) of this particular list's manager(s), but other approaches,
34638 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34639 or &%local_part_suffix%& options) to handle addresses of the form
34640 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34641
34642
34643
34644 .section "Syntax errors in mailing lists" "SECID241"
34645 .cindex "mailing lists" "syntax errors in"
34646 If an entry in redirection data contains a syntax error, Exim normally defers
34647 delivery of the original address. That means that a syntax error in a mailing
34648 list holds up all deliveries to the list. This may not be appropriate when a
34649 list is being maintained automatically from data supplied by users, and the
34650 addresses are not rigorously checked.
34651
34652 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34653 entries that fail to parse, noting the incident in the log. If in addition
34654 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34655 whenever a broken address is skipped. It is usually appropriate to set
34656 &%syntax_errors_to%& to the same address as &%errors_to%&.
34657
34658
34659
34660 .section "Re-expansion of mailing lists" "SECID242"
34661 .cindex "mailing lists" "re-expansion of"
34662 Exim remembers every individual address to which a message has been delivered,
34663 in order to avoid duplication, but it normally stores only the original
34664 recipient addresses with a message. If all the deliveries to a mailing list
34665 cannot be done at the first attempt, the mailing list is re-expanded when the
34666 delivery is next tried. This means that alterations to the list are taken into
34667 account at each delivery attempt, so addresses that have been added to
34668 the list since the message arrived will therefore receive a copy of the
34669 message, even though it pre-dates their subscription.
34670
34671 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34672 on the &(redirect)& router. If this is done, any addresses generated by the
34673 router that fail to deliver at the first attempt are added to the message as
34674 &"top level"& addresses, and the parent address that generated them is marked
34675 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34676 subsequent delivery attempts. The disadvantage of this is that if any of the
34677 failing addresses are incorrect, correcting them in the file has no effect on
34678 pre-existing messages.
34679
34680 The original top-level address is remembered with each of the generated
34681 addresses, and is output in any log messages. However, any intermediate parent
34682 addresses are not recorded. This makes a difference to the log only if the
34683 &%all_parents%& selector is set, but for mailing lists there is normally only
34684 one level of expansion anyway.
34685
34686
34687
34688 .section "Closed mailing lists" "SECID243"
34689 .cindex "mailing lists" "closed"
34690 The examples so far have assumed open mailing lists, to which anybody may
34691 send mail. It is also possible to set up closed lists, where mail is accepted
34692 from specified senders only. This is done by making use of the generic
34693 &%senders%& option to restrict the router that handles the list.
34694
34695 The following example uses the same file as a list of recipients and as a list
34696 of permitted senders. It requires three routers:
34697 .code
34698 lists_request:
34699   driver = redirect
34700   domains = lists.example
34701   local_part_suffix = -request
34702   file = /usr/lists/$local_part$local_part_suffix
34703   no_more
34704
34705 lists_post:
34706   driver = redirect
34707   domains = lists.example
34708   senders = ${if exists {/usr/lists/$local_part}\
34709              {lsearch;/usr/lists/$local_part}{*}}
34710   file = /usr/lists/$local_part
34711   forbid_pipe
34712   forbid_file
34713   errors_to = $local_part-request@lists.example
34714   no_more
34715
34716 lists_closed:
34717   driver = redirect
34718   domains = lists.example
34719   allow_fail
34720   data = :fail: $local_part@lists.example is a closed mailing list
34721 .endd
34722 All three routers have the same &%domains%& setting, so for any other domains,
34723 they are all skipped. The first router runs only if the local part ends in
34724 &%-request%&. It handles messages to the list manager(s) by means of an open
34725 mailing list.
34726
34727 The second router runs only if the &%senders%& precondition is satisfied. It
34728 checks for the existence of a list that corresponds to the local part, and then
34729 checks that the sender is on the list by means of a linear search. It is
34730 necessary to check for the existence of the file before trying to search it,
34731 because otherwise Exim thinks there is a configuration error. If the file does
34732 not exist, the expansion of &%senders%& is *, which matches all senders. This
34733 means that the router runs, but because there is no list, declines, and
34734 &%no_more%& ensures that no further routers are run. The address fails with an
34735 &"unrouteable address"& error.
34736
34737 The third router runs only if the second router is skipped, which happens when
34738 a mailing list exists, but the sender is not on it. This router forcibly fails
34739 the address, giving a suitable error message.
34740
34741
34742
34743
34744 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34745 .cindex "VERP"
34746 .cindex "Variable Envelope Return Paths"
34747 .cindex "envelope sender"
34748 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34749 are a way of helping mailing list administrators discover which subscription
34750 address is the cause of a particular delivery failure. The idea is to encode
34751 the original recipient address in the outgoing envelope sender address, so that
34752 if the message is forwarded by another host and then subsequently bounces, the
34753 original recipient can be extracted from the recipient address of the bounce.
34754
34755 .oindex &%errors_to%&
34756 .oindex &%return_path%&
34757 Envelope sender addresses can be modified by Exim using two different
34758 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34759 list examples), or the &%return_path%& option on a transport. The second of
34760 these is effective only if the message is successfully delivered to another
34761 host; it is not used for errors detected on the local host (see the description
34762 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34763 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34764 .code
34765 verp_smtp:
34766   driver = smtp
34767   max_rcpt = 1
34768   return_path = \
34769     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34770       {$1-request+$local_part=$domain@your.dom.example}fail}
34771 .endd
34772 This has the effect of rewriting the return path (envelope sender) on outgoing
34773 SMTP messages, if the local part of the original return path ends in
34774 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34775 local part and domain of the recipient into the return path. Suppose, for
34776 example, that a message whose return path has been set to
34777 &'somelist-request@your.dom.example'& is sent to
34778 &'subscriber@other.dom.example'&. In the transport, the return path is
34779 rewritten as
34780 .code
34781 somelist-request+subscriber=other.dom.example@your.dom.example
34782 .endd
34783 .vindex "&$local_part$&"
34784 For this to work, you must tell Exim to send multiple copies of messages that
34785 have more than one recipient, so that each copy has just one recipient. This is
34786 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34787 might be sent to several different recipients in the same domain, in which case
34788 &$local_part$& is not available in the transport, because it is not unique.
34789
34790 Unless your host is doing nothing but mailing list deliveries, you should
34791 probably use a separate transport for the VERP deliveries, so as not to use
34792 extra resources in making one-per-recipient copies for other deliveries. This
34793 can easily be done by expanding the &%transport%& option in the router:
34794 .code
34795 dnslookup:
34796   driver = dnslookup
34797   domains = ! +local_domains
34798   transport = \
34799     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34800       {verp_smtp}{remote_smtp}}
34801   no_more
34802 .endd
34803 If you want to change the return path using &%errors_to%& in a router instead
34804 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34805 routers that handle mailing list addresses. This will ensure that all delivery
34806 errors, including those detected on the local host, are sent to the VERP
34807 address.
34808
34809 On a host that does no local deliveries and has no manual routing, only the
34810 &(dnslookup)& router needs to be changed. A special transport is not needed for
34811 SMTP deliveries. Every mailing list recipient has its own return path value,
34812 and so Exim must hand them to the transport one at a time. Here is an example
34813 of a &(dnslookup)& router that implements VERP:
34814 .code
34815 verp_dnslookup:
34816   driver = dnslookup
34817   domains = ! +local_domains
34818   transport = remote_smtp
34819   errors_to = \
34820     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34821      {$1-request+$local_part=$domain@your.dom.example}fail}
34822   no_more
34823 .endd
34824 Before you start sending out messages with VERPed return paths, you must also
34825 configure Exim to accept the bounce messages that come back to those paths.
34826 Typically this is done by setting a &%local_part_suffix%& option for a
34827 router, and using this to route the messages to wherever you want to handle
34828 them.
34829
34830 The overhead incurred in using VERP depends very much on the size of the
34831 message, the number of recipient addresses that resolve to the same remote
34832 host, and the speed of the connection over which the message is being sent. If
34833 a lot of addresses resolve to the same host and the connection is slow, sending
34834 a separate copy of the message for each address may take substantially longer
34835 than sending a single copy with many recipients (for which VERP cannot be
34836 used).
34837
34838
34839
34840
34841
34842
34843 .section "Virtual domains" "SECTvirtualdomains"
34844 .cindex "virtual domains"
34845 .cindex "domain" "virtual"
34846 The phrase &'virtual domain'& is unfortunately used with two rather different
34847 meanings:
34848
34849 .ilist
34850 A domain for which there are no real mailboxes; all valid local parts are
34851 aliases for other email addresses. Common examples are organizational
34852 top-level domains and &"vanity"& domains.
34853 .next
34854 One of a number of independent domains that are all handled by the same host,
34855 with mailboxes on that host, but where the mailbox owners do not necessarily
34856 have login accounts on that host.
34857 .endlist
34858
34859 The first usage is probably more common, and does seem more &"virtual"& than
34860 the second. This kind of domain can be handled in Exim with a straightforward
34861 aliasing router. One approach is to create a separate alias file for each
34862 virtual domain. Exim can test for the existence of the alias file to determine
34863 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34864 to a router of this form:
34865 .code
34866 virtual:
34867   driver = redirect
34868   domains = dsearch;/etc/mail/virtual
34869   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34870   no_more
34871 .endd
34872 The &%domains%& option specifies that the router is to be skipped, unless there
34873 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34874 domain that is being processed. When the router runs, it looks up the local
34875 part in the file to find a new address (or list of addresses). The &%no_more%&
34876 setting ensures that if the lookup fails (leading to &%data%& being an empty
34877 string), Exim gives up on the address without trying any subsequent routers.
34878
34879 This one router can handle all the virtual domains because the alias file names
34880 follow a fixed pattern. Permissions can be arranged so that appropriate people
34881 can edit the different alias files. A successful aliasing operation results in
34882 a new envelope recipient address, which is then routed from scratch.
34883
34884 The other kind of &"virtual"& domain can also be handled in a straightforward
34885 way. One approach is to create a file for each domain containing a list of
34886 valid local parts, and use it in a router like this:
34887 .code
34888 my_domains:
34889   driver = accept
34890   domains = dsearch;/etc/mail/domains
34891   local_parts = lsearch;/etc/mail/domains/$domain
34892   transport = my_mailboxes
34893 .endd
34894 The address is accepted if there is a file for the domain, and the local part
34895 can be found in the file. The &%domains%& option is used to check for the
34896 file's existence because &%domains%& is tested before the &%local_parts%&
34897 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34898 because that option is tested after &%local_parts%&. The transport is as
34899 follows:
34900 .code
34901 my_mailboxes:
34902   driver = appendfile
34903   file = /var/mail/$domain/$local_part
34904   user = mail
34905 .endd
34906 This uses a directory of mailboxes for each domain. The &%user%& setting is
34907 required, to specify which uid is to be used for writing to the mailboxes.
34908
34909 The configuration shown here is just one example of how you might support this
34910 requirement. There are many other ways this kind of configuration can be set
34911 up, for example, by using a database instead of separate files to hold all the
34912 information about the domains.
34913
34914
34915
34916 .section "Multiple user mailboxes" "SECTmulbox"
34917 .cindex "multiple mailboxes"
34918 .cindex "mailbox" "multiple"
34919 .cindex "local part" "prefix"
34920 .cindex "local part" "suffix"
34921 Heavy email users often want to operate with multiple mailboxes, into which
34922 incoming mail is automatically sorted. A popular way of handling this is to
34923 allow users to use multiple sender addresses, so that replies can easily be
34924 identified. Users are permitted to add prefixes or suffixes to their local
34925 parts for this purpose. The wildcard facility of the generic router options
34926 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34927 example, consider this router:
34928 .code
34929 userforward:
34930   driver = redirect
34931   check_local_user
34932   file = $home/.forward
34933   local_part_suffix = -*
34934   local_part_suffix_optional
34935   allow_filter
34936 .endd
34937 .vindex "&$local_part_suffix$&"
34938 It runs a user's &_.forward_& file for all local parts of the form
34939 &'username-*'&. Within the filter file the user can distinguish different
34940 cases by testing the variable &$local_part_suffix$&. For example:
34941 .code
34942 if $local_part_suffix contains -special then
34943 save /home/$local_part/Mail/special
34944 endif
34945 .endd
34946 If the filter file does not exist, or does not deal with such addresses, they
34947 fall through to subsequent routers, and, assuming no subsequent use of the
34948 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34949 control over which suffixes are valid.
34950
34951 Alternatively, a suffix can be used to trigger the use of a different
34952 &_.forward_& file &-- which is the way a similar facility is implemented in
34953 another MTA:
34954 .code
34955 userforward:
34956   driver = redirect
34957   check_local_user
34958   file = $home/.forward$local_part_suffix
34959   local_part_suffix = -*
34960   local_part_suffix_optional
34961   allow_filter
34962 .endd
34963 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34964 example, &_.forward-special_& is used. Once again, if the appropriate file
34965 does not exist, or does not deal with the address, it is passed on to
34966 subsequent routers, which could, if required, look for an unqualified
34967 &_.forward_& file to use as a default.
34968
34969
34970
34971 .section "Simplified vacation processing" "SECID244"
34972 .cindex "vacation processing"
34973 The traditional way of running the &'vacation'& program is for a user to set up
34974 a pipe command in a &_.forward_& file
34975 (see section &<<SECTspecitredli>>& for syntax details).
34976 This is prone to error by inexperienced users. There are two features of Exim
34977 that can be used to make this process simpler for users:
34978
34979 .ilist
34980 A local part prefix such as &"vacation-"& can be specified on a router which
34981 can cause the message to be delivered directly to the &'vacation'& program, or
34982 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34983 &_.forward_& file are then much simpler. For example:
34984 .code
34985 spqr, vacation-spqr
34986 .endd
34987 .next
34988 The &%require_files%& generic router option can be used to trigger a
34989 vacation delivery by checking for the existence of a certain file in the
34990 user's home directory. The &%unseen%& generic option should also be used, to
34991 ensure that the original delivery also proceeds. In this case, all the user has
34992 to do is to create a file called, say, &_.vacation_&, containing a vacation
34993 message.
34994 .endlist
34995
34996 Another advantage of both these methods is that they both work even when the
34997 use of arbitrary pipes by users is locked out.
34998
34999
35000
35001 .section "Taking copies of mail" "SECID245"
35002 .cindex "message" "copying every"
35003 Some installations have policies that require archive copies of all messages to
35004 be made. A single copy of each message can easily be taken by an appropriate
35005 command in a system filter, which could, for example, use a different file for
35006 each day's messages.
35007
35008 There is also a shadow transport mechanism that can be used to take copies of
35009 messages that are successfully delivered by local transports, one copy per
35010 delivery. This could be used, &'inter alia'&, to implement automatic
35011 notification of delivery by sites that insist on doing such things.
35012
35013
35014
35015 .section "Intermittently connected hosts" "SECID246"
35016 .cindex "intermittently connected hosts"
35017 It has become quite common (because it is cheaper) for hosts to connect to the
35018 Internet periodically rather than remain connected all the time. The normal
35019 arrangement is that mail for such hosts accumulates on a system that is
35020 permanently connected.
35021
35022 Exim was designed for use on permanently connected hosts, and so it is not
35023 particularly well-suited to use in an intermittently connected environment.
35024 Nevertheless there are some features that can be used.
35025
35026
35027 .section "Exim on the upstream server host" "SECID247"
35028 It is tempting to arrange for incoming mail for the intermittently connected
35029 host to remain on Exim's queue until the client connects. However, this
35030 approach does not scale very well. Two different kinds of waiting message are
35031 being mixed up in the same queue &-- those that cannot be delivered because of
35032 some temporary problem, and those that are waiting for their destination host
35033 to connect. This makes it hard to manage the queue, as well as wasting
35034 resources, because each queue runner scans the entire queue.
35035
35036 A better approach is to separate off those messages that are waiting for an
35037 intermittently connected host. This can be done by delivering these messages
35038 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35039 format, from where they are transmitted by other software when their
35040 destination connects. This makes it easy to collect all the mail for one host
35041 in a single directory, and to apply local timeout rules on a per-message basis
35042 if required.
35043
35044 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35045 you are doing this, you should configure Exim with a long retry period for the
35046 intermittent host. For example:
35047 .code
35048 cheshire.wonderland.fict.example    *   F,5d,24h
35049 .endd
35050 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35051 which messages it has queued up for that host. Once the intermittent host comes
35052 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35053 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35054 causes all the queued up messages to be delivered, often down a single SMTP
35055 connection. While the host remains connected, any new messages get delivered
35056 immediately.
35057
35058 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35059 issued with a different IP address each time it connects, Exim's retry
35060 mechanisms on the holding host get confused, because the IP address is normally
35061 used as part of the key string for holding retry information. This can be
35062 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35063 Since this has disadvantages for permanently connected hosts, it is best to
35064 arrange a separate transport for the intermittently connected ones.
35065
35066
35067
35068 .section "Exim on the intermittently connected client host" "SECID248"
35069 The value of &%smtp_accept_queue_per_connection%& should probably be
35070 increased, or even set to zero (that is, disabled) on the intermittently
35071 connected host, so that all incoming messages down a single connection get
35072 delivered immediately.
35073
35074 .cindex "SMTP" "passed connection"
35075 .cindex "SMTP" "multiple deliveries"
35076 .cindex "multiple SMTP deliveries"
35077 Mail waiting to be sent from an intermittently connected host will probably
35078 not have been routed, because without a connection DNS lookups are not
35079 possible. This means that if a normal queue run is done at connection time,
35080 each message is likely to be sent in a separate SMTP session. This can be
35081 avoided by starting the queue run with a command line option beginning with
35082 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35083 first pass, routing is done but no deliveries take place. The second pass is a
35084 normal queue run; since all the messages have been previously routed, those
35085 destined for the same host are likely to get sent as multiple deliveries in a
35086 single SMTP connection.
35087
35088
35089
35090 . ////////////////////////////////////////////////////////////////////////////
35091 . ////////////////////////////////////////////////////////////////////////////
35092
35093 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35094          "Exim as a non-queueing client"
35095 .cindex "client, non-queueing"
35096 .cindex "smart host" "suppressing queueing"
35097 On a personal computer, it is a common requirement for all
35098 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35099 configured to operate that way, for all the popular operating systems.
35100 However, there are some MUAs for Unix-like systems that cannot be so
35101 configured: they submit messages using the command line interface of
35102 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35103 messages this way.
35104
35105 If the personal computer runs continuously, there is no problem, because it can
35106 run a conventional MTA that handles delivery to the smart host, and deal with
35107 any delays via its queueing mechanism. However, if the computer does not run
35108 continuously or runs different operating systems at different times, queueing
35109 email is not desirable.
35110
35111 There is therefore a requirement for something that can provide the
35112 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35113 any queueing or retrying facilities. Furthermore, the delivery to the smart
35114 host should be synchronous, so that if it fails, the sending MUA is immediately
35115 informed. In other words, we want something that extends an MUA that submits
35116 to a local MTA via the command line so that it behaves like one that submits
35117 to a remote smart host using TCP/SMTP.
35118
35119 There are a number of applications (for example, there is one called &'ssmtp'&)
35120 that do this job. However, people have found them to be lacking in various
35121 ways. For instance, you might want to allow aliasing and forwarding to be done
35122 before sending a message to the smart host.
35123
35124 Exim already had the necessary infrastructure for doing this job. Just a few
35125 tweaks were needed to make it behave as required, though it is somewhat of an
35126 overkill to use a fully-featured MTA for this purpose.
35127
35128 .oindex "&%mua_wrapper%&"
35129 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35130 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35131 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35132 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35133 compatible router and transport configuration. Typically there will be just one
35134 router and one transport, sending everything to a smart host.
35135
35136 When run in MUA wrapping mode, the behaviour of Exim changes in the
35137 following ways:
35138
35139 .ilist
35140 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35141 In other words, the only way to submit messages is via the command line.
35142 .next
35143 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35144 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35145 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35146 does not finish until the delivery attempt is complete. If the delivery is
35147 successful, a zero return code is given.
35148 .next
35149 Address redirection is permitted, but the final routing for all addresses must
35150 be to the same remote transport, and to the same list of hosts. Furthermore,
35151 the return address (envelope sender) must be the same for all recipients, as
35152 must any added or deleted header lines. In other words, it must be possible to
35153 deliver the message in a single SMTP transaction, however many recipients there
35154 are.
35155 .next
35156 If these conditions are not met, or if routing any address results in a
35157 failure or defer status, or if Exim is unable to deliver all the recipients
35158 successfully to one of the smart hosts, delivery of the entire message fails.
35159 .next
35160 Because no queueing is allowed, all failures are treated as permanent; there
35161 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35162 smart host. Furthermore, because only a single yes/no response can be given to
35163 the caller, it is not possible to deliver to some recipients and not others. If
35164 there is an error (temporary or permanent) for any recipient, all are failed.
35165 .next
35166 If more than one smart host is listed, Exim will try another host after a
35167 connection failure or a timeout, in the normal way. However, if this kind of
35168 failure happens for all the hosts, the delivery fails.
35169 .next
35170 When delivery fails, an error message is written to the standard error stream
35171 (as well as to Exim's log), and Exim exits to the caller with a return code
35172 value 1. The message is expunged from Exim's spool files. No bounce messages
35173 are ever generated.
35174 .next
35175 No retry data is maintained, and any retry rules are ignored.
35176 .next
35177 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35178 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35179 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35180 .endlist
35181
35182 The overall effect is that Exim makes a single synchronous attempt to deliver
35183 the message, failing if there is any kind of problem. Because no local
35184 deliveries are done and no daemon can be run, Exim does not need root
35185 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35186 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35187 the advantages and disadvantages of running without root privilege.
35188
35189
35190
35191
35192 . ////////////////////////////////////////////////////////////////////////////
35193 . ////////////////////////////////////////////////////////////////////////////
35194
35195 .chapter "Log files" "CHAPlog"
35196 .scindex IIDloggen "log" "general description"
35197 .cindex "log" "types of"
35198 Exim writes three different logs, referred to as the main log, the reject log,
35199 and the panic log:
35200
35201 .ilist
35202 .cindex "main log"
35203 The main log records the arrival of each message and each delivery in a single
35204 line in each case. The format is as compact as possible, in an attempt to keep
35205 down the size of log files. Two-character flag sequences make it easy to pick
35206 out these lines. A number of other events are recorded in the main log. Some of
35207 them are optional, in which case the &%log_selector%& option controls whether
35208 they are included or not. A Perl script called &'eximstats'&, which does simple
35209 analysis of main log files, is provided in the Exim distribution (see section
35210 &<<SECTmailstat>>&).
35211 .next
35212 .cindex "reject log"
35213 The reject log records information from messages that are rejected as a result
35214 of a configuration option (that is, for policy reasons).
35215 The first line of each rejection is a copy of the line that is also written to
35216 the main log. Then, if the message's header has been read at the time the log
35217 is written, its contents are written to this log. Only the original header
35218 lines are available; header lines added by ACLs are not logged. You can use the
35219 reject log to check that your policy controls are working correctly; on a busy
35220 host this may be easier than scanning the main log for rejection messages. You
35221 can suppress the writing of the reject log by setting &%write_rejectlog%&
35222 false.
35223 .next
35224 .cindex "panic log"
35225 .cindex "system log"
35226 When certain serious errors occur, Exim writes entries to its panic log. If the
35227 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35228 are usually written to the main log as well, but can get lost amid the mass of
35229 other entries. The panic log should be empty under normal circumstances. It is
35230 therefore a good idea to check it (or to have a &'cron'& script check it)
35231 regularly, in order to become aware of any problems. When Exim cannot open its
35232 panic log, it tries as a last resort to write to the system log (syslog). This
35233 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35234 message itself is written at priority LOG_CRIT.
35235 .endlist
35236
35237 Every log line starts with a timestamp, in the format shown in the following
35238 example. Note that many of the examples shown in this chapter are line-wrapped.
35239 In the log file, this would be all on one line:
35240 .code
35241 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35242   by QUIT
35243 .endd
35244 By default, the timestamps are in the local timezone. There are two
35245 ways of changing this:
35246
35247 .ilist
35248 You can set the &%timezone%& option to a different time zone; in particular, if
35249 you set
35250 .code
35251 timezone = UTC
35252 .endd
35253 the timestamps will be in UTC (aka GMT).
35254 .next
35255 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35256 example:
35257 .code
35258 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35259 .endd
35260 .endlist
35261
35262 .cindex "log" "process ids in"
35263 .cindex "pid (process id)" "in log lines"
35264 Exim does not include its process id in log lines by default, but you can
35265 request that it does so by specifying the &`pid`& log selector (see section
35266 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35267 brackets, immediately after the time and date.
35268
35269
35270
35271
35272 .section "Where the logs are written" "SECTwhelogwri"
35273 .cindex "log" "destination"
35274 .cindex "log" "to file"
35275 .cindex "log" "to syslog"
35276 .cindex "syslog"
35277 The logs may be written to local files, or to syslog, or both. However, it
35278 should be noted that many syslog implementations use UDP as a transport, and
35279 are therefore unreliable in the sense that messages are not guaranteed to
35280 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35281 It has also been reported that on large log files (tens of megabytes) you may
35282 need to tweak syslog to prevent it syncing the file with each write &-- on
35283 Linux this has been seen to make syslog take 90% plus of CPU time.
35284
35285 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35286 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35287 configuration. This latter string is expanded, so it can contain, for example,
35288 references to the host name:
35289 .code
35290 log_file_path = /var/log/$primary_hostname/exim_%slog
35291 .endd
35292 It is generally advisable, however, to set the string in &_Local/Makefile_&
35293 rather than at run time, because then the setting is available right from the
35294 start of Exim's execution. Otherwise, if there's something it wants to log
35295 before it has read the configuration file (for example, an error in the
35296 configuration file) it will not use the path you want, and may not be able to
35297 log at all.
35298
35299 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35300 list, currently limited to at most two items. This is one option where the
35301 facility for changing a list separator may not be used. The list must always be
35302 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35303 otherwise the item must either be an absolute path, containing &`%s`& at the
35304 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35305 implying the use of a default path.
35306
35307 When Exim encounters an empty item in the list, it searches the list defined by
35308 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35309 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35310 mean &"use the path specified at build time"&. It no such item exists, log
35311 files are written in the &_log_& subdirectory of the spool directory. This is
35312 equivalent to the setting:
35313 .code
35314 log_file_path = $spool_directory/log/%slog
35315 .endd
35316 If you do not specify anything at build time or run time,
35317 or if you unset the option at run time (i.e. &`log_file_path = `&),
35318 that is where the logs are written.
35319
35320 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35321 are in use &-- see section &<<SECTdatlogfil>>& below.
35322
35323 Here are some examples of possible settings:
35324 .display
35325 &`LOG_FILE_PATH=syslog                    `& syslog only
35326 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35327 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35328 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35329 .endd
35330 If there are more than two paths in the list, the first is used and a panic
35331 error is logged.
35332
35333
35334
35335 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35336 .cindex "log" "cycling local files"
35337 .cindex "cycling logs"
35338 .cindex "&'exicyclog'&"
35339 .cindex "log" "local files; writing to"
35340 Some operating systems provide centralized and standardized methods for cycling
35341 log files. For those that do not, a utility script called &'exicyclog'& is
35342 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35343 main and reject logs each time it is called. The maximum number of old logs to
35344 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35345
35346 An Exim delivery process opens the main log when it first needs to write to it,
35347 and it keeps the file open in case subsequent entries are required &-- for
35348 example, if a number of different deliveries are being done for the same
35349 message. However, remote SMTP deliveries can take a long time, and this means
35350 that the file may be kept open long after it is renamed if &'exicyclog'& or
35351 something similar is being used to rename log files on a regular basis. To
35352 ensure that a switch of log files is noticed as soon as possible, Exim calls
35353 &[stat()]& on the main log's name before reusing an open file, and if the file
35354 does not exist, or its inode has changed, the old file is closed and Exim
35355 tries to open the main log from scratch. Thus, an old log file may remain open
35356 for quite some time, but no Exim processes should write to it once it has been
35357 renamed.
35358
35359
35360
35361 .section "Datestamped log files" "SECTdatlogfil"
35362 .cindex "log" "datestamped files"
35363 Instead of cycling the main and reject log files by renaming them
35364 periodically, some sites like to use files whose names contain a datestamp,
35365 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35366 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35367 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35368 point where the datestamp is required. For example:
35369 .code
35370 log_file_path = /var/spool/exim/log/%slog-%D
35371 log_file_path = /var/log/exim-%s-%D.log
35372 log_file_path = /var/spool/exim/log/%D-%slog
35373 log_file_path = /var/log/exim/%s.%M
35374 .endd
35375 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35376 examples of names generated by the above examples:
35377 .code
35378 /var/spool/exim/log/mainlog-20021225
35379 /var/log/exim-reject-20021225.log
35380 /var/spool/exim/log/20021225-mainlog
35381 /var/log/exim/main.200212
35382 .endd
35383 When this form of log file is specified, Exim automatically switches to new
35384 files at midnight. It does not make any attempt to compress old logs; you
35385 will need to write your own script if you require this. You should not
35386 run &'exicyclog'& with this form of logging.
35387
35388 The location of the panic log is also determined by &%log_file_path%&, but it
35389 is not datestamped, because rotation of the panic log does not make sense.
35390 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35391 the string. In addition, if it immediately follows a slash, a following
35392 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35393 character is removed. Thus, the four examples above would give these panic
35394 log names:
35395 .code
35396 /var/spool/exim/log/paniclog
35397 /var/log/exim-panic.log
35398 /var/spool/exim/log/paniclog
35399 /var/log/exim/panic
35400 .endd
35401
35402
35403 .section "Logging to syslog" "SECID249"
35404 .cindex "log" "syslog; writing to"
35405 The use of syslog does not change what Exim logs or the format of its messages,
35406 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35407 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35408 that, the same strings are written to syslog as to log files. The syslog
35409 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35410 by default, but you can change these by setting the &%syslog_facility%& and
35411 &%syslog_processname%& options, respectively. If Exim was compiled with
35412 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35413 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35414 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35415 the time and host name to each line.
35416 The three log streams are mapped onto syslog priorities as follows:
35417
35418 .ilist
35419 &'mainlog'& is mapped to LOG_INFO
35420 .next
35421 &'rejectlog'& is mapped to LOG_NOTICE
35422 .next
35423 &'paniclog'& is mapped to LOG_ALERT
35424 .endlist
35425
35426 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35427 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35428 these are routed by syslog to the same place. You can suppress this duplication
35429 by setting &%syslog_duplication%& false.
35430
35431 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35432 entries contain multiple lines when headers are included. To cope with both
35433 these cases, entries written to syslog are split into separate &[syslog()]&
35434 calls at each internal newline, and also after a maximum of
35435 870 data characters. (This allows for a total syslog line length of 1024, when
35436 additions such as timestamps are added.) If you are running a syslog
35437 replacement that can handle lines longer than the 1024 characters allowed by
35438 RFC 3164, you should set
35439 .code
35440 SYSLOG_LONG_LINES=yes
35441 .endd
35442 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35443 lines, but it still splits at internal newlines in &'reject'& log entries.
35444
35445 To make it easy to re-assemble split lines later, each component of a split
35446 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35447 where <&'n'&> is the component number and <&'m'&> is the total number of
35448 components in the entry. The / delimiter is used when the line was split
35449 because it was too long; if it was split because of an internal newline, the \
35450 delimiter is used. For example, supposing the length limit to be 50 instead of
35451 870, the following would be the result of a typical rejection message to
35452 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35453 name, and pid as added by syslog:
35454 .code
35455 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35456 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35457 [3/5]  when scanning for sender: missing or malformed lo
35458 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35459 [5/5] mple>)
35460 .endd
35461 The same error might cause the following lines to be written to &"rejectlog"&
35462 (LOG_NOTICE):
35463 .code
35464 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35465 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35466 [3/18] er when scanning for sender: missing or malformed
35467 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35468 [5\18] .example>)
35469 [6\18] Recipients: ph10@some.domain.cam.example
35470 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35471 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35472 [9\18]        id 16RdAL-0006pc-00
35473 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35474 [11\18] 09:43 +0100
35475 [12\18] F From: <>
35476 [13\18]   Subject: this is a test header
35477 [18\18]   X-something: this is another header
35478 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35479 [16\18] le>
35480 [17\18] B Bcc:
35481 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35482 .endd
35483 Log lines that are neither too long nor contain newlines are written to syslog
35484 without modification.
35485
35486 If only syslog is being used, the Exim monitor is unable to provide a log tail
35487 display, unless syslog is routing &'mainlog'& to a file on the local host and
35488 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35489 where it is.
35490
35491
35492
35493 .section "Log line flags" "SECID250"
35494 One line is written to the main log for each message received, and for each
35495 successful, unsuccessful, and delayed delivery. These lines can readily be
35496 picked out by the distinctive two-character flags that immediately follow the
35497 timestamp. The flags are:
35498 .display
35499 &`<=`&     message arrival
35500 &`(=`&     message fakereject
35501 &`=>`&     normal message delivery
35502 &`->`&     additional address in same delivery
35503 &`>>`&     cutthrough message delivery
35504 &`*>`&     delivery suppressed by &%-N%&
35505 &`**`&     delivery failed; address bounced
35506 &`==`&     delivery deferred; temporary problem
35507 .endd
35508
35509
35510 .section "Logging message reception" "SECID251"
35511 .cindex "log" "reception line"
35512 The format of the single-line entry in the main log that is written for every
35513 message received is shown in the basic example below, which is split over
35514 several lines in order to fit it on the page:
35515 .code
35516 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35517   H=mailer.fict.example [192.168.123.123] U=exim
35518   P=smtp S=5678 id=<incoming message id>
35519 .endd
35520 The address immediately following &"<="& is the envelope sender address. A
35521 bounce message is shown with the sender address &"<>"&, and if it is locally
35522 generated, this is followed by an item of the form
35523 .code
35524 R=<message id>
35525 .endd
35526 which is a reference to the message that caused the bounce to be sent.
35527
35528 .cindex "HELO"
35529 .cindex "EHLO"
35530 For messages from other hosts, the H and U fields identify the remote host and
35531 record the RFC 1413 identity of the user that sent the message, if one was
35532 received. The number given in square brackets is the IP address of the sending
35533 host. If there is a single, unparenthesized  host name in the H field, as
35534 above, it has been verified to correspond to the IP address (see the
35535 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35536 by the remote host in the SMTP HELO or EHLO command, and has not been
35537 verified. If verification yields a different name to that given for HELO or
35538 EHLO, the verified name appears first, followed by the HELO or EHLO
35539 name in parentheses.
35540
35541 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35542 without brackets, in the HELO or EHLO command, leading to entries in
35543 the log containing text like these examples:
35544 .code
35545 H=(10.21.32.43) [192.168.8.34]
35546 H=([10.21.32.43]) [192.168.8.34]
35547 .endd
35548 This can be confusing. Only the final address in square brackets can be relied
35549 on.
35550
35551 For locally generated messages (that is, messages not received over TCP/IP),
35552 the H field is omitted, and the U field contains the login name of the caller
35553 of Exim.
35554
35555 .cindex "authentication" "logging"
35556 .cindex "AUTH" "logging"
35557 For all messages, the P field specifies the protocol used to receive the
35558 message. This is the value that is stored in &$received_protocol$&. In the case
35559 of incoming SMTP messages, the value indicates whether or not any SMTP
35560 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35561 session was encrypted, there is an additional X field that records the cipher
35562 suite that was used.
35563
35564 .cindex log protocol
35565 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35566 hosts that have authenticated themselves using the SMTP AUTH command. The first
35567 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35568 there is an additional item A= followed by the name of the authenticator that
35569 was used. If an authenticated identification was set up by the authenticator's
35570 &%server_set_id%& option, this is logged too, separated by a colon from the
35571 authenticator name.
35572
35573 .cindex "size" "of message"
35574 The id field records the existing message id, if present. The size of the
35575 received message is given by the S field. When the message is delivered,
35576 headers may be removed or added, so that the size of delivered copies of the
35577 message may not correspond with this value (and indeed may be different to each
35578 other).
35579
35580 The &%log_selector%& option can be used to request the logging of additional
35581 data when a message is received. See section &<<SECTlogselector>>& below.
35582
35583
35584
35585 .section "Logging deliveries" "SECID252"
35586 .cindex "log" "delivery line"
35587 The format of the single-line entry in the main log that is written for every
35588 delivery is shown in one of the examples below, for local and remote
35589 deliveries, respectively. Each example has been split into multiple lines in order
35590 to fit it on the page:
35591 .code
35592 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35593   <marv@hitch.fict.example> R=localuser T=local_delivery
35594 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35595   monk@holistic.fict.example R=dnslookup T=remote_smtp
35596   H=holistic.fict.example [192.168.234.234]
35597 .endd
35598 For ordinary local deliveries, the original address is given in angle brackets
35599 after the final delivery address, which might be a pipe or a file. If
35600 intermediate address(es) exist between the original and the final address, the
35601 last of these is given in parentheses after the final address. The R and T
35602 fields record the router and transport that were used to process the address.
35603
35604 If SMTP AUTH was used for the delivery there is an additional item A=
35605 followed by the name of the authenticator that was used.
35606 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35607 option, this is logged too, separated by a colon from the authenticator name.
35608
35609 If a shadow transport was run after a successful local delivery, the log line
35610 for the successful delivery has an item added on the end, of the form
35611 .display
35612 &`ST=<`&&'shadow transport name'&&`>`&
35613 .endd
35614 If the shadow transport did not succeed, the error message is put in
35615 parentheses afterwards.
35616
35617 .cindex "asterisk" "after IP address"
35618 When more than one address is included in a single delivery (for example, two
35619 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35620 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35621 down a single SMTP connection, an asterisk follows the IP address in the log
35622 lines for the second and subsequent messages.
35623
35624 .cindex "delivery" "cutthrough; logging"
35625 .cindex "cutthrough" "logging"
35626 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35627 line precedes the reception line, since cutthrough waits for a possible
35628 rejection from the destination in case it can reject the sourced item.
35629
35630 The generation of a reply message by a filter file gets logged as a
35631 &"delivery"& to the addressee, preceded by &">"&.
35632
35633 The &%log_selector%& option can be used to request the logging of additional
35634 data when a message is delivered. See section &<<SECTlogselector>>& below.
35635
35636
35637 .section "Discarded deliveries" "SECID253"
35638 .cindex "discarded messages"
35639 .cindex "message" "discarded"
35640 .cindex "delivery" "discarded; logging"
35641 When a message is discarded as a result of the command &"seen finish"& being
35642 obeyed in a filter file which generates no deliveries, a log entry of the form
35643 .code
35644 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35645   <low.club@bridge.example> R=userforward
35646 .endd
35647 is written, to record why no deliveries are logged. When a message is discarded
35648 because it is aliased to &":blackhole:"& the log line is like this:
35649 .code
35650 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35651   <hole@nowhere.example> R=blackhole_router
35652 .endd
35653
35654
35655 .section "Deferred deliveries" "SECID254"
35656 When a delivery is deferred, a line of the following form is logged:
35657 .code
35658 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35659   R=dnslookup T=smtp defer (146): Connection refused
35660 .endd
35661 In the case of remote deliveries, the error is the one that was given for the
35662 last IP address that was tried. Details of individual SMTP failures are also
35663 written to the log, so the above line would be preceded by something like
35664 .code
35665 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35666   mail1.endrest.example [192.168.239.239]: Connection refused
35667 .endd
35668 When a deferred address is skipped because its retry time has not been reached,
35669 a message is written to the log, but this can be suppressed by setting an
35670 appropriate value in &%log_selector%&.
35671
35672
35673
35674 .section "Delivery failures" "SECID255"
35675 .cindex "delivery" "failure; logging"
35676 If a delivery fails because an address cannot be routed, a line of the
35677 following form is logged:
35678 .code
35679 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35680   <jim@trek99.example>: unknown mail domain
35681 .endd
35682 If a delivery fails at transport time, the router and transport are shown, and
35683 the response from the remote host is included, as in this example:
35684 .code
35685 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35686   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35687   after pipelined RCPT TO:<ace400@pb.example>: host
35688   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35689   <ace400@pb.example>...Addressee unknown
35690 .endd
35691 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35692 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35693 disabling PIPELINING. The log lines for all forms of delivery failure are
35694 flagged with &`**`&.
35695
35696
35697
35698 .section "Fake deliveries" "SECID256"
35699 .cindex "delivery" "fake; logging"
35700 If a delivery does not actually take place because the &%-N%& option has been
35701 used to suppress it, a normal delivery line is written to the log, except that
35702 &"=>"& is replaced by &"*>"&.
35703
35704
35705
35706 .section "Completion" "SECID257"
35707 A line of the form
35708 .code
35709 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35710 .endd
35711 is written to the main log when a message is about to be removed from the spool
35712 at the end of its processing.
35713
35714
35715
35716
35717 .section "Summary of Fields in Log Lines" "SECID258"
35718 .cindex "log" "summary of fields"
35719 A summary of the field identifiers that are used in log lines is shown in
35720 the following table:
35721 .display
35722 &`A   `&        authenticator name (and optional id and sender)
35723 &`C   `&        SMTP confirmation on delivery
35724 &`    `&        command list for &"no mail in SMTP session"&
35725 &`CV  `&        certificate verification status
35726 &`D   `&        duration of &"no mail in SMTP session"&
35727 &`DN  `&        distinguished name from peer certificate
35728 &`DS  `&        DNSSEC secured lookups
35729 &`DT  `&        on &`=>`& lines: time taken for a delivery
35730 &`F   `&        sender address (on delivery lines)
35731 &`H   `&        host name and IP address
35732 &`I   `&        local interface used
35733 &`K   `&        CHUNKING extension used
35734 &`id  `&        message id for incoming message
35735 &`P   `&        on &`<=`& lines: protocol used
35736 &`    `&        on &`=>`& and &`**`& lines: return path
35737 &`PRDR`&        PRDR extension used
35738 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
35739 &`Q   `&        alternate queue name
35740 &`QT  `&        on &`=>`& lines: time spent on queue so far
35741 &`    `&        on &"Completed"& lines: time spent on queue
35742 &`R   `&        on &`<=`& lines: reference for local bounce
35743 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35744 &`S   `&        size of message in bytes
35745 &`SNI `&        server name indication from TLS client hello
35746 &`ST  `&        shadow transport name
35747 &`T   `&        on &`<=`& lines: message subject (topic)
35748 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35749 &`U   `&        local user or RFC 1413 identity
35750 &`X   `&        TLS cipher suite
35751 .endd
35752
35753
35754 .section "Other log entries" "SECID259"
35755 Various other types of log entry are written from time to time. Most should be
35756 self-explanatory. Among the more common are:
35757
35758 .ilist
35759 .cindex "retry" "time not reached"
35760 &'retry time not reached'&&~&~An address previously suffered a temporary error
35761 during routing or local delivery, and the time to retry has not yet arrived.
35762 This message is not written to an individual message log file unless it happens
35763 during the first delivery attempt.
35764 .next
35765 &'retry time not reached for any host'&&~&~An address previously suffered
35766 temporary errors during remote delivery, and the retry time has not yet arrived
35767 for any of the hosts to which it is routed.
35768 .next
35769 .cindex "spool directory" "file locked"
35770 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35771 some other Exim process is already working on the message. This can be quite
35772 common if queue running processes are started at frequent intervals. The
35773 &'exiwhat'& utility script can be used to find out what Exim processes are
35774 doing.
35775 .next
35776 .cindex "error" "ignored"
35777 &'error ignored'&&~&~There are several circumstances that give rise to this
35778 message:
35779 .olist
35780 Exim failed to deliver a bounce message whose age was greater than
35781 &%ignore_bounce_errors_after%&. The bounce was discarded.
35782 .next
35783 A filter file set up a delivery using the &"noerror"& option, and the delivery
35784 failed. The delivery was discarded.
35785 .next
35786 A delivery set up by a router configured with
35787 . ==== As this is a nested list, any displays it contains must be indented
35788 . ==== as otherwise they are too far to the left.
35789 .code
35790     errors_to = <>
35791 .endd
35792 failed. The delivery was discarded.
35793 .endlist olist
35794 .endlist ilist
35795
35796
35797
35798
35799
35800 .section "Reducing or increasing what is logged" "SECTlogselector"
35801 .cindex "log" "selectors"
35802 By setting the &%log_selector%& global option, you can disable some of Exim's
35803 default logging, or you can request additional logging. The value of
35804 &%log_selector%& is made up of names preceded by plus or minus characters. For
35805 example:
35806 .code
35807 log_selector = +arguments -retry_defer
35808 .endd
35809 The list of optional log items is in the following table, with the default
35810 selection marked by asterisks:
35811 .display
35812 &` 8bitmime                   `&  received 8BITMIME status
35813 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35814 &` address_rewrite            `&  address rewriting
35815 &` all_parents                `&  all parents in => lines
35816 &` arguments                  `&  command line arguments
35817 &`*connection_reject          `&  connection rejections
35818 &`*delay_delivery             `&  immediate delivery delayed
35819 &` deliver_time               `&  time taken to perform delivery
35820 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35821 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35822 &` dnssec                     `&  DNSSEC secured lookups
35823 &`*etrn                       `&  ETRN commands
35824 &`*host_lookup_failed         `&  as it says
35825 &` ident_timeout              `&  timeout for ident connection
35826 &` incoming_interface         `&  local interface on <= and => lines
35827 &` incoming_port              `&  remote port on <= lines
35828 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35829 &` outgoing_interface         `&  local interface on => lines
35830 &` outgoing_port              `&  add remote port to => lines
35831 &`*queue_run                  `&  start and end queue runs
35832 &` queue_time                 `&  time on queue for one recipient
35833 &` queue_time_overall         `&  time on queue for whole message
35834 &` pid                        `&  Exim process id
35835 &` proxy                      `&  proxy address on <= and => lines
35836 &` received_recipients        `&  recipients on <= lines
35837 &` received_sender            `&  sender on <= lines
35838 &`*rejected_header            `&  header contents on reject log
35839 &`*retry_defer                `&  &"retry time not reached"&
35840 &` return_path_on_delivery    `&  put return path on => and ** lines
35841 &` sender_on_delivery         `&  add sender to => lines
35842 &`*sender_verify_fail         `&  sender verification failures
35843 &`*size_reject                `&  rejection because too big
35844 &`*skip_delivery              `&  delivery skipped in a queue run
35845 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35846 &` smtp_connection            `&  incoming SMTP connections
35847 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35848 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35849 &` smtp_no_mail               `&  session with no MAIL commands
35850 &` smtp_protocol_error        `&  SMTP protocol errors
35851 &` smtp_syntax_error          `&  SMTP syntax errors
35852 &` subject                    `&  contents of &'Subject:'& on <= lines
35853 &`*tls_certificate_verified   `&  certificate verification status
35854 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35855 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35856 &` tls_sni                    `&  TLS SNI on <= lines
35857 &` unknown_in_list            `&  DNS lookup failed in list match
35858
35859 &` all                        `&  all of the above
35860 .endd
35861 See also the &%slow_lookup_log%& main configuration option,
35862 section &<<SECID99>>&
35863
35864 More details on each of these items follows:
35865
35866 .ilist
35867 .cindex "8BITMIME"
35868 .cindex "log" "8BITMIME"
35869 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35870 which may help in tracking down interoperability issues with ancient MTAs
35871 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35872 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35873 &`7BIT`& and &`8BITMIME`& respectively.
35874 .next
35875 .cindex "&%warn%& ACL verb" "log when skipping"
35876 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35877 its conditions cannot be evaluated, a log line to this effect is written if
35878 this log selector is set.
35879 .next
35880 .cindex "log" "rewriting"
35881 .cindex "rewriting" "logging"
35882 &%address_rewrite%&: This applies both to global rewrites and per-transport
35883 rewrites, but not to rewrites in filters run as an unprivileged user (because
35884 such users cannot access the log).
35885 .next
35886 .cindex "log" "full parentage"
35887 &%all_parents%&: Normally only the original and final addresses are logged on
35888 delivery lines; with this selector, intermediate parents are given in
35889 parentheses between them.
35890 .next
35891 .cindex "log" "Exim arguments"
35892 .cindex "Exim arguments, logging"
35893 &%arguments%&: This causes Exim to write the arguments with which it was called
35894 to the main log, preceded by the current working directory. This is a debugging
35895 feature, added to make it easier to find out how certain MUAs call
35896 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35897 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35898 that are empty or that contain white space are quoted. Non-printing characters
35899 are shown as escape sequences. This facility cannot log unrecognized arguments,
35900 because the arguments are checked before the configuration file is read. The
35901 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35902 between the caller and Exim.
35903 .next
35904 .cindex "log" "connection rejections"
35905 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35906 connection is rejected, for whatever reason.
35907 .next
35908 .cindex "log" "delayed delivery"
35909 .cindex "delayed delivery, logging"
35910 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35911 started for an incoming message because the load is too high or too many
35912 messages were received on one connection. Logging does not occur if no delivery
35913 process is started because &%queue_only%& is set or &%-odq%& was used.
35914 .next
35915 .cindex "log" "delivery duration"
35916 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35917 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35918 .next
35919 .cindex "log" "message size on delivery"
35920 .cindex "size" "of message"
35921 &%delivery_size%&: For each delivery, the size of message delivered is added to
35922 the &"=>"& line, tagged with S=.
35923 .next
35924 .cindex "log" "dnslist defer"
35925 .cindex "DNS list" "logging defer"
35926 .cindex "black list (DNS)"
35927 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35928 DNS black list suffers a temporary error.
35929 .next
35930 .cindex log dnssec
35931 .cindex dnssec logging
35932 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
35933 dns lookups gave secure results a tag of DS is added.
35934 For acceptance this covers the reverse and forward lookups for host name verification.
35935 It does not cover helo-name verification.
35936 For delivery this covers the SRV, MX, A and/or AAAA lookups.
35937 .next
35938 .cindex "log" "ETRN commands"
35939 .cindex "ETRN" "logging"
35940 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35941 is run to determine whether or not it is actually accepted. An invalid ETRN
35942 command, or one received within a message transaction is not logged by this
35943 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35944 .next
35945 .cindex "log" "host lookup failure"
35946 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35947 any addresses, or when a lookup of an IP address fails to find a host name, a
35948 log line is written. This logging does not apply to direct DNS lookups when
35949 routing email addresses, but it does apply to &"byname"& lookups.
35950 .next
35951 .cindex "log" "ident timeout"
35952 .cindex "RFC 1413" "logging timeout"
35953 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35954 client's ident port times out.
35955 .next
35956 .cindex "log" "incoming interface"
35957 .cindex "log" "local interface"
35958 .cindex "log" "local address and port"
35959 .cindex "TCP/IP" "logging local address and port"
35960 .cindex "interface" "logging"
35961 &%incoming_interface%&: The interface on which a message was received is added
35962 to the &"<="& line as an IP address in square brackets, tagged by I= and
35963 followed by a colon and the port number. The local interface and port are also
35964 added to other SMTP log lines, for example &"SMTP connection from"&, to
35965 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35966 The latter can be disabled by turning off the &%outgoing_interface%& option.
35967 .next
35968 .cindex log "incoming proxy address"
35969 .cindex proxy "logging proxy address"
35970 .cindex "TCP/IP" "logging proxy address"
35971 &%proxy%&: The internal (closest to the system running Exim) IP address
35972 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35973 on a proxied connection
35974 or the &"=>"& line for a message delivered on a proxied connection..
35975 See &<<SECTproxyInbound>>& for more information.
35976 .next
35977 .cindex "log" "incoming remote port"
35978 .cindex "port" "logging remote"
35979 .cindex "TCP/IP" "logging incoming remote port"
35980 .vindex "&$sender_fullhost$&"
35981 .vindex "&$sender_rcvhost$&"
35982 &%incoming_port%&: The remote port number from which a message was received is
35983 added to log entries and &'Received:'& header lines, following the IP address
35984 in square brackets, and separated from it by a colon. This is implemented by
35985 changing the value that is put in the &$sender_fullhost$& and
35986 &$sender_rcvhost$& variables. Recording the remote port number has become more
35987 important with the widening use of NAT (see RFC 2505).
35988 .next
35989 .cindex "log" "dropped connection"
35990 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35991 connection is unexpectedly dropped.
35992 .next
35993 .cindex "log" "outgoing interface"
35994 .cindex "log" "local interface"
35995 .cindex "log" "local address and port"
35996 .cindex "TCP/IP" "logging local address and port"
35997 .cindex "interface" "logging"
35998 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35999 interface on which a message was sent is added to delivery lines as an I= tag
36000 followed by IP address in square brackets. You can disable this by turning
36001 off the &%outgoing_interface%& option.
36002 .next
36003 .cindex "log" "outgoing remote port"
36004 .cindex "port" "logging outgoint remote"
36005 .cindex "TCP/IP" "logging ougtoing remote port"
36006 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36007 containing => tags) following the IP address.
36008 The local port is also added if &%incoming_interface%& and
36009 &%outgoing_interface%& are both enabled.
36010 This option is not included in the default setting, because for most ordinary
36011 configurations, the remote port number is always 25 (the SMTP port), and the
36012 local port is a random ephemeral port.
36013 .next
36014 .cindex "log" "process ids in"
36015 .cindex "pid (process id)" "in log lines"
36016 &%pid%&: The current process id is added to every log line, in square brackets,
36017 immediately after the time and date.
36018 .next
36019 .cindex "log" "queue run"
36020 .cindex "queue runner" "logging"
36021 &%queue_run%&: The start and end of every queue run are logged.
36022 .next
36023 .cindex "log" "queue time"
36024 &%queue_time%&: The amount of time the message has been in the queue on the
36025 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36026 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36027 includes reception time as well as the delivery time for the current address.
36028 This means that it may be longer than the difference between the arrival and
36029 delivery log line times, because the arrival log line is not written until the
36030 message has been successfully received.
36031 .next
36032 &%queue_time_overall%&: The amount of time the message has been in the queue on
36033 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36034 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36035 message, so it includes reception time as well as the total delivery time.
36036 .next
36037 .cindex "log" "recipients"
36038 &%received_recipients%&: The recipients of a message are listed in the main log
36039 as soon as the message is received. The list appears at the end of the log line
36040 that is written when a message is received, preceded by the word &"for"&. The
36041 addresses are listed after they have been qualified, but before any rewriting
36042 has taken place.
36043 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36044 in the list.
36045 .next
36046 .cindex "log" "sender reception"
36047 &%received_sender%&: The unrewritten original sender of a message is added to
36048 the end of the log line that records the message's arrival, after the word
36049 &"from"& (before the recipients if &%received_recipients%& is also set).
36050 .next
36051 .cindex "log" "header lines for rejection"
36052 &%rejected_header%&: If a message's header has been received at the time a
36053 rejection is written to the reject log, the complete header is added to the
36054 log. Header logging can be turned off individually for messages that are
36055 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36056 .next
36057 .cindex "log" "retry defer"
36058 &%retry_defer%&: A log line is written if a delivery is deferred because a
36059 retry time has not yet been reached. However, this &"retry time not reached"&
36060 message is always omitted from individual message logs after the first delivery
36061 attempt.
36062 .next
36063 .cindex "log" "return path"
36064 &%return_path_on_delivery%&: The return path that is being transmitted with
36065 the message is included in delivery and bounce lines, using the tag P=.
36066 This is omitted if no delivery actually happens, for example, if routing fails,
36067 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36068 .next
36069 .cindex "log" "sender on delivery"
36070 &%sender_on_delivery%&: The message's sender address is added to every delivery
36071 and bounce line, tagged by F= (for &"from"&).
36072 This is the original sender that was received with the message; it is not
36073 necessarily the same as the outgoing return path.
36074 .next
36075 .cindex "log" "sender verify failure"
36076 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36077 gives details of a sender verification failure is not written. Log lines for
36078 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36079 detail is lost.
36080 .next
36081 .cindex "log" "size rejection"
36082 &%size_reject%&: A log line is written whenever a message is rejected because
36083 it is too big.
36084 .next
36085 .cindex "log" "frozen messages; skipped"
36086 .cindex "frozen messages" "logging skipping"
36087 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36088 queue run because it is frozen or because another process is already delivering
36089 it.
36090 .cindex "&""spool file is locked""&"
36091 The message that is written is &"spool file is locked"&.
36092 .next
36093 .cindex "log" "smtp confirmation"
36094 .cindex "SMTP" "logging confirmation"
36095 .cindex "LMTP" "logging confirmation"
36096 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36097 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36098 A number of MTAs (including Exim) return an identifying string in this
36099 response.
36100 .next
36101 .cindex "log" "SMTP connections"
36102 .cindex "SMTP" "logging connections"
36103 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36104 established or closed, unless the connection is from a host that matches
36105 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36106 only when the closure is unexpected.) This applies to connections from local
36107 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36108 dropped in the middle of a message, a log line is always written, whether or
36109 not this selector is set, but otherwise nothing is written at the start and end
36110 of connections unless this selector is enabled.
36111
36112 For TCP/IP connections to an Exim daemon, the current number of connections is
36113 included in the log message for each new connection, but note that the count is
36114 reset if the daemon is restarted.
36115 Also, because connections are closed (and the closure is logged) in
36116 subprocesses, the count may not include connections that have been closed but
36117 whose termination the daemon has not yet noticed. Thus, while it is possible to
36118 match up the opening and closing of connections in the log, the value of the
36119 logged counts may not be entirely accurate.
36120 .next
36121 .cindex "log" "SMTP transaction; incomplete"
36122 .cindex "SMTP" "logging incomplete transactions"
36123 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36124 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36125 and the message sender plus any accepted recipients are included in the log
36126 line. This can provide evidence of dictionary attacks.
36127 .next
36128 .cindex "log" "non-MAIL SMTP sessions"
36129 .cindex "MAIL" "logging session without"
36130 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36131 connection terminates without having issued a MAIL command. This includes both
36132 the case when the connection is dropped, and the case when QUIT is used. It
36133 does not include cases where the connection is rejected right at the start (by
36134 an ACL, or because there are too many connections, or whatever). These cases
36135 already have their own log lines.
36136
36137 The log line that is written contains the identity of the client in the usual
36138 way, followed by D= and a time, which records the duration of the connection.
36139 If the connection was authenticated, this fact is logged exactly as it is for
36140 an incoming message, with an A= item. If the connection was encrypted, CV=,
36141 DN=, and X= items may appear as they do for an incoming message, controlled by
36142 the same logging options.
36143
36144 Finally, if any SMTP commands were issued during the connection, a C= item
36145 is added to the line, listing the commands that were used. For example,
36146 .code
36147 C=EHLO,QUIT
36148 .endd
36149 shows that the client issued QUIT straight after EHLO. If there were fewer
36150 than 20 commands, they are all listed. If there were more than 20 commands,
36151 the last 20 are listed, preceded by &"..."&. However, with the default
36152 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36153 have been aborted before 20 non-mail commands are processed.
36154 .next
36155 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36156 colon-separated, is appended to the A= item for a message arrival or delivery
36157 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36158 was accepted or used.
36159 .next
36160 .cindex "log" "SMTP protocol error"
36161 .cindex "SMTP" "logging protocol error"
36162 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36163 encountered. Exim does not have perfect detection of all protocol errors
36164 because of transmission delays and the use of pipelining. If PIPELINING has
36165 been advertised to a client, an Exim server assumes that the client will use
36166 it, and therefore it does not count &"expected"& errors (for example, RCPT
36167 received after rejecting MAIL) as protocol errors.
36168 .next
36169 .cindex "SMTP" "logging syntax errors"
36170 .cindex "SMTP" "syntax errors; logging"
36171 .cindex "SMTP" "unknown command; logging"
36172 .cindex "log" "unknown SMTP command"
36173 .cindex "log" "SMTP syntax error"
36174 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36175 encountered. An unrecognized command is treated as a syntax error. For an
36176 external connection, the host identity is given; for an internal connection
36177 using &%-bs%& the sender identification (normally the calling user) is given.
36178 .next
36179 .cindex "log" "subject"
36180 .cindex "subject, logging"
36181 &%subject%&: The subject of the message is added to the arrival log line,
36182 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36183 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36184 specifies whether characters with values greater than 127 should be logged
36185 unchanged, or whether they should be rendered as escape sequences.
36186 .next
36187 .cindex "log" "certificate verification"
36188 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36189 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36190 verified, and &`CV=no`& if not.
36191 .next
36192 .cindex "log" "TLS cipher"
36193 .cindex "TLS" "logging cipher"
36194 &%tls_cipher%&: When a message is sent or received over an encrypted
36195 connection, the cipher suite used is added to the log line, preceded by X=.
36196 .next
36197 .cindex "log" "TLS peer DN"
36198 .cindex "TLS" "logging peer DN"
36199 &%tls_peerdn%&: When a message is sent or received over an encrypted
36200 connection, and a certificate is supplied by the remote host, the peer DN is
36201 added to the log line, preceded by DN=.
36202 .next
36203 .cindex "log" "TLS SNI"
36204 .cindex "TLS" "logging SNI"
36205 &%tls_sni%&: When a message is received over an encrypted connection, and
36206 the remote host provided the Server Name Indication extension, the SNI is
36207 added to the log line, preceded by SNI=.
36208 .next
36209 .cindex "log" "DNS failure in list"
36210 &%unknown_in_list%&: This setting causes a log entry to be written when the
36211 result of a list match is failure because a DNS lookup failed.
36212 .endlist
36213
36214
36215 .section "Message log" "SECID260"
36216 .cindex "message" "log file for"
36217 .cindex "log" "message log; description of"
36218 .cindex "&_msglog_& directory"
36219 .oindex "&%preserve_message_logs%&"
36220 In addition to the general log files, Exim writes a log file for each message
36221 that it handles. The names of these per-message logs are the message ids, and
36222 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36223 message log contains copies of the log lines that apply to the message. This
36224 makes it easier to inspect the status of an individual message without having
36225 to search the main log. A message log is deleted when processing of the message
36226 is complete, unless &%preserve_message_logs%& is set, but this should be used
36227 only with great care because they can fill up your disk very quickly.
36228
36229 On a heavily loaded system, it may be desirable to disable the use of
36230 per-message logs, in order to reduce disk I/O. This can be done by setting the
36231 &%message_logs%& option false.
36232 .ecindex IIDloggen
36233
36234
36235
36236
36237 . ////////////////////////////////////////////////////////////////////////////
36238 . ////////////////////////////////////////////////////////////////////////////
36239
36240 .chapter "Exim utilities" "CHAPutils"
36241 .scindex IIDutils "utilities"
36242 A number of utility scripts and programs are supplied with Exim and are
36243 described in this chapter. There is also the Exim Monitor, which is covered in
36244 the next chapter. The utilities described here are:
36245
36246 .itable none 0 0 3  7* left  15* left  40* left
36247 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36248   "list what Exim processes are doing"
36249 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36250 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36251 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36252 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36253                                                 various criteria"
36254 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36255 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36256   "extract statistics from the log"
36257 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36258   "check address acceptance from given IP"
36259 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36260 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36261 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36262 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36263 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36264 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36265 .endtable
36266
36267 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36268 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36269 &url(http://duncanthrax.net/exilog/) for details.
36270
36271
36272
36273
36274 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36275 .cindex "&'exiwhat'&"
36276 .cindex "process, querying"
36277 .cindex "SIGUSR1"
36278 On operating systems that can restart a system call after receiving a signal
36279 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36280 a line describing what it is doing to the file &_exim-process.info_& in the
36281 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36282 processes it can find, having first emptied the file. It then waits for one
36283 second to allow the Exim processes to react before displaying the results. In
36284 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36285 send the signal to the Exim processes, so it is normally run as root.
36286
36287 &*Warning*&: This is not an efficient process. It is intended for occasional
36288 use by system administrators. It is not sensible, for example, to set up a
36289 script that sends SIGUSR1 signals to Exim processes at short intervals.
36290
36291
36292 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36293 varies in different operating systems. Not only are different options used,
36294 but the format of the output is different. For this reason, there are some
36295 system configuration options that configure exactly how &'exiwhat'& works. If
36296 it doesn't seem to be working for you, check the following compile-time
36297 options:
36298 .display
36299 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36300 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36301 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36302 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36303 .endd
36304 An example of typical output from &'exiwhat'& is
36305 .code
36306 164 daemon: -q1h, listening on port 25
36307 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36308 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36309   [10.19.42.42] (editor@ref.example)
36310 10592 handling incoming call from [192.168.243.242]
36311 10628 accepting a local non-SMTP message
36312 .endd
36313 The first number in the output line is the process number. The third line has
36314 been split here, in order to fit it on the page.
36315
36316
36317
36318 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36319 .cindex "&'exiqgrep'&"
36320 .cindex "queue" "grepping"
36321 This utility is a Perl script contributed by Matt Hubbard. It runs
36322 .code
36323 exim -bpu
36324 .endd
36325 or (in case &*-a*& switch is specified)
36326 .code
36327 exim -bp
36328 .endd
36329 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36330 contain alternate exim configuration the queue management might be using.
36331
36332 to obtain a queue listing, and then greps the output to select messages
36333 that match given criteria. The following selection options are available:
36334
36335 .vlist
36336 .vitem &*-f*&&~<&'regex'&>
36337 Match the sender address using a case-insensitive search. The field that is
36338 tested is enclosed in angle brackets, so you can test for bounce messages with
36339 .code
36340 exiqgrep -f '^<>$'
36341 .endd
36342 .vitem &*-r*&&~<&'regex'&>
36343 Match a recipient address using a case-insensitive search. The field that is
36344 tested is not enclosed in angle brackets.
36345
36346 .vitem &*-s*&&~<&'regex'&>
36347 Match against the size field.
36348
36349 .vitem &*-y*&&~<&'seconds'&>
36350 Match messages that are younger than the given time.
36351
36352 .vitem &*-o*&&~<&'seconds'&>
36353 Match messages that are older than the given time.
36354
36355 .vitem &*-z*&
36356 Match only frozen messages.
36357
36358 .vitem &*-x*&
36359 Match only non-frozen messages.
36360 .endlist
36361
36362 The following options control the format of the output:
36363
36364 .vlist
36365 .vitem &*-c*&
36366 Display only the count of matching messages.
36367
36368 .vitem &*-l*&
36369 Long format &-- display the full message information as output by Exim. This is
36370 the default.
36371
36372 .vitem &*-i*&
36373 Display message ids only.
36374
36375 .vitem &*-b*&
36376 Brief format &-- one line per message.
36377
36378 .vitem &*-R*&
36379 Display messages in reverse order.
36380
36381 .vitem &*-a*&
36382 Include delivered recipients in queue listing.
36383 .endlist
36384
36385 There is one more option, &%-h%&, which outputs a list of options.
36386
36387
36388
36389 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36390 .cindex "&'exiqsumm'&"
36391 .cindex "queue" "summary"
36392 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36393 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36394 running a command such as
36395 .code
36396 exim -bp | exiqsumm
36397 .endd
36398 The output consists of one line for each domain that has messages waiting for
36399 it, as in the following example:
36400 .code
36401 3   2322   74m   66m  msn.com.example
36402 .endd
36403 Each line lists the number of pending deliveries for a domain, their total
36404 volume, and the length of time that the oldest and the newest messages have
36405 been waiting. Note that the number of pending deliveries is greater than the
36406 number of messages when messages have more than one recipient.
36407
36408 A summary line is output at the end. By default the output is sorted on the
36409 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36410 the output to be sorted by oldest message and by count of messages,
36411 respectively. There are also three options that split the messages for each
36412 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36413 separates frozen messages, and &%-s%& separates messages according to their
36414 sender.
36415
36416 The output of &'exim -bp'& contains the original addresses in the message, so
36417 this also applies to the output from &'exiqsumm'&. No domains from addresses
36418 generated by aliasing or forwarding are included (unless the &%one_time%&
36419 option of the &(redirect)& router has been used to convert them into &"top
36420 level"& addresses).
36421
36422
36423
36424
36425 .section "Extracting specific information from the log (exigrep)" &&&
36426          "SECTextspeinf"
36427 .cindex "&'exigrep'&"
36428 .cindex "log" "extracts; grepping for"
36429 The &'exigrep'& utility is a Perl script that searches one or more main log
36430 files for entries that match a given pattern. When it finds a match, it
36431 extracts all the log entries for the relevant message, not just those that
36432 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36433 given message, or all mail for a given user, or for a given host, for example.
36434 The input files can be in Exim log format or syslog format.
36435 If a matching log line is not associated with a specific message, it is
36436 included in &'exigrep'&'s output without any additional lines. The usage is:
36437 .display
36438 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36439 .endd
36440 If no log file names are given on the command line, the standard input is read.
36441
36442 The &%-t%& argument specifies a number of seconds. It adds an additional
36443 condition for message selection. Messages that are complete are shown only if
36444 they spent more than <&'n'&> seconds on the queue.
36445
36446 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36447 makes it case-sensitive. This may give a performance improvement when searching
36448 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36449 option; with &%-I%& they do not. In both cases it is possible to change the
36450 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36451
36452 The &%-l%& option means &"literal"&, that is, treat all characters in the
36453 pattern as standing for themselves. Otherwise the pattern must be a Perl
36454 regular expression.
36455
36456 The &%-v%& option inverts the matching condition. That is, a line is selected
36457 if it does &'not'& match the pattern.
36458
36459 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36460 that are generated as a result/response to a message that &'exigrep'& matched
36461 normally.
36462
36463 Example of &%-M%&:
36464 user_a sends a message to user_b, which generates a bounce back to user_b. If
36465 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36466 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36467 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36468 when searching for &"user_a"& will show both messages since the bounce is
36469 &"related"& to or a &"result"& of the first message that was found by the
36470 search term.
36471
36472 If the location of a &'zcat'& command is known from the definition of
36473 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36474 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36475 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36476 autodetection of some well known compression extensions.
36477
36478
36479 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36480 .cindex "&'exipick'&"
36481 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36482 lists messages from the queue according to a variety of criteria. For details
36483 of &'exipick'&'s facilities, visit the web page at
36484 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36485 the &%--help%& option.
36486
36487
36488 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36489 .cindex "log" "cycling local files"
36490 .cindex "cycling logs"
36491 .cindex "&'exicyclog'&"
36492 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36493 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36494 you are using log files with datestamps in their names (see section
36495 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36496 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36497 There are two command line options for &'exicyclog'&:
36498 .ilist
36499 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36500 default that is set when Exim is built. The default default is 10.
36501 .next
36502 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36503 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36504 overriding the script's default, which is to find the setting from Exim's
36505 configuration.
36506 .endlist
36507
36508 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36509 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36510 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36511 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36512 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36513 logs are handled similarly.
36514
36515 If the limit is greater than 99, the script uses 3-digit numbers such as
36516 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36517 to one that is greater, or &'vice versa'&, you will have to fix the names of
36518 any existing log files.
36519
36520 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36521 the end are deleted. All files with numbers greater than 01 are compressed,
36522 using a compression command which is configured by the COMPRESS_COMMAND
36523 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36524 root &%crontab%& entry of the form
36525 .code
36526 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36527 .endd
36528 assuming you have used the name &"exim"& for the Exim user. You can run
36529 &'exicyclog'& as root if you wish, but there is no need.
36530
36531
36532
36533 .section "Mail statistics (eximstats)" "SECTmailstat"
36534 .cindex "statistics"
36535 .cindex "&'eximstats'&"
36536 A Perl script called &'eximstats'& is provided for extracting statistical
36537 information from log files. The output is either plain text, or HTML.
36538 Exim log files are also supported by the &'Lire'& system produced by the
36539 LogReport Foundation &url(http://www.logreport.org).
36540
36541 The &'eximstats'& script has been hacked about quite a bit over time. The
36542 latest version is the result of some extensive revision by Steve Campbell. A
36543 lot of information is given by default, but there are options for suppressing
36544 various parts of it. Following any options, the arguments to the script are a
36545 list of files, which should be main log files. For example:
36546 .code
36547 eximstats -nr /var/spool/exim/log/mainlog.01
36548 .endd
36549 By default, &'eximstats'& extracts information about the number and volume of
36550 messages received from or delivered to various hosts. The information is sorted
36551 both by message count and by volume, and the top fifty hosts in each category
36552 are listed on the standard output. Similar information, based on email
36553 addresses or domains instead of hosts can be requested by means of various
36554 options. For messages delivered and received locally, similar statistics are
36555 also produced per user.
36556
36557 The output also includes total counts and statistics about delivery errors, and
36558 histograms showing the number of messages received and deliveries made in each
36559 hour of the day. A delivery with more than one address in its envelope (for
36560 example, an SMTP transaction with more than one RCPT command) is counted
36561 as a single delivery by &'eximstats'&.
36562
36563 Though normally more deliveries than receipts are reported (as messages may
36564 have multiple recipients), it is possible for &'eximstats'& to report more
36565 messages received than delivered, even though the queue is empty at the start
36566 and end of the period in question. If an incoming message contains no valid
36567 recipients, no deliveries are recorded for it. A bounce message is handled as
36568 an entirely separate message.
36569
36570 &'eximstats'& always outputs a grand total summary giving the volume and number
36571 of messages received and deliveries made, and the number of hosts involved in
36572 each case. It also outputs the number of messages that were delayed (that is,
36573 not completely delivered at the first attempt), and the number that had at
36574 least one address that failed.
36575
36576 The remainder of the output is in sections that can be independently disabled
36577 or modified by various options. It consists of a summary of deliveries by
36578 transport, histograms of messages received and delivered per time interval
36579 (default per hour), information about the time messages spent on the queue,
36580 a list of relayed messages, lists of the top fifty sending hosts, local
36581 senders, destination hosts, and destination local users by count and by volume,
36582 and a list of delivery errors that occurred.
36583
36584 The relay information lists messages that were actually relayed, that is, they
36585 came from a remote host and were directly delivered to some other remote host,
36586 without being processed (for example, for aliasing or forwarding) locally.
36587
36588 There are quite a few options for &'eximstats'& to control exactly what it
36589 outputs. These are documented in the Perl script itself, and can be extracted
36590 by running the command &(perldoc)& on the script. For example:
36591 .code
36592 perldoc /usr/exim/bin/eximstats
36593 .endd
36594
36595 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36596 .cindex "&'exim_checkaccess'&"
36597 .cindex "policy control" "checking access"
36598 .cindex "checking access"
36599 The &%-bh%& command line argument allows you to run a fake SMTP session with
36600 debugging output, in order to check what Exim is doing when it is applying
36601 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36602 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36603 sometimes you just want to answer the question &"Does this address have
36604 access?"& without bothering with any further details.
36605
36606 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36607 two arguments, an IP address and an email address:
36608 .code
36609 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36610 .endd
36611 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36612 given email address would be accepted in a RCPT command in a TCP/IP
36613 connection from the host with the given IP address. The output of the utility
36614 is either the word &"accepted"&, or the SMTP error response, for example:
36615 .code
36616 Rejected:
36617 550 Relay not permitted
36618 .endd
36619 When running this test, the utility uses &`<>`& as the envelope sender address
36620 for the MAIL command, but you can change this by providing additional
36621 options. These are passed directly to the Exim command. For example, to specify
36622 that the test is to be run with the sender address &'himself@there.example'&
36623 you can use:
36624 .code
36625 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36626                  -f himself@there.example
36627 .endd
36628 Note that these additional Exim command line items must be given after the two
36629 mandatory arguments.
36630
36631 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36632 while running its checks. You can run checks that include callouts by using
36633 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36634
36635
36636
36637 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36638 .cindex "DBM" "building dbm files"
36639 .cindex "building DBM files"
36640 .cindex "&'exim_dbmbuild'&"
36641 .cindex "lower casing"
36642 .cindex "binary zero" "in lookup key"
36643 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36644 the format used by the &(lsearch)& lookup (see section
36645 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36646 names as keys and the remainder of the information as data. The lower-casing
36647 can be prevented by calling the program with the &%-nolc%& option.
36648
36649 A terminating zero is included as part of the key string. This is expected by
36650 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36651 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36652 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36653 files.
36654
36655 The program requires two arguments: the name of the input file (which can be a
36656 single hyphen to indicate the standard input), and the name of the output file.
36657 It creates the output under a temporary name, and then renames it if all went
36658 well.
36659
36660 .cindex "USE_DB"
36661 If the native DB interface is in use (USE_DB is set in a compile-time
36662 configuration file &-- this is common in free versions of Unix) the two file
36663 names must be different, because in this mode the Berkeley DB functions create
36664 a single output file using exactly the name given. For example,
36665 .code
36666 exim_dbmbuild /etc/aliases /etc/aliases.db
36667 .endd
36668 reads the system alias file and creates a DBM version of it in
36669 &_/etc/aliases.db_&.
36670
36671 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36672 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36673 environment, the suffixes are added to the second argument of
36674 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36675 when the Berkeley functions are used in compatibility mode (though this is not
36676 recommended), because in that case it adds a &_.db_& suffix to the file name.
36677
36678 If a duplicate key is encountered, the program outputs a warning, and when it
36679 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36680 option is used. By default, only the first of a set of duplicates is used &--
36681 this makes it compatible with &(lsearch)& lookups. There is an option
36682 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36683 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36684 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36685 return code is 2.
36686
36687
36688
36689
36690 .section "Finding individual retry times (exinext)" "SECTfinindret"
36691 .cindex "retry" "times"
36692 .cindex "&'exinext'&"
36693 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36694 fish specific information out of the retry database. Given a mail domain (or a
36695 complete address), it looks up the hosts for that domain, and outputs any retry
36696 information for the hosts or for the domain. At present, the retry information
36697 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36698 output. For example:
36699 .code
36700 $ exinext piglet@milne.fict.example
36701 kanga.milne.example:192.168.8.1 error 146: Connection refused
36702   first failed: 21-Feb-1996 14:57:34
36703   last tried:   21-Feb-1996 14:57:34
36704   next try at:  21-Feb-1996 15:02:34
36705 roo.milne.example:192.168.8.3 error 146: Connection refused
36706   first failed: 20-Jan-1996 13:12:08
36707   last tried:   21-Feb-1996 11:42:03
36708   next try at:  21-Feb-1996 19:42:03
36709   past final cutoff time
36710 .endd
36711 You can also give &'exinext'& a local part, without a domain, and it
36712 will give any retry information for that local part in your default domain.
36713 A message id can be used to obtain retry information pertaining to a specific
36714 message. This exists only when an attempt to deliver a message to a remote host
36715 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36716 &'exinext'& is not particularly efficient, but then it is not expected to be
36717 run very often.
36718
36719 The &'exinext'& utility calls Exim to find out information such as the location
36720 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36721 passed on to the &'exim'& commands. The first specifies an alternate Exim
36722 configuration file, and the second sets macros for use within the configuration
36723 file. These features are mainly to help in testing, but might also be useful in
36724 environments where more than one configuration file is in use.
36725
36726
36727
36728 .section "Hints database maintenance" "SECThindatmai"
36729 .cindex "hints database" "maintenance"
36730 .cindex "maintaining Exim's hints database"
36731 Three utility programs are provided for maintaining the DBM files that Exim
36732 uses to contain its delivery hint information. Each program requires two
36733 arguments. The first specifies the name of Exim's spool directory, and the
36734 second is the name of the database it is to operate on. These are as follows:
36735
36736 .ilist
36737 &'retry'&: the database of retry information
36738 .next
36739 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36740 for remote hosts
36741 .next
36742 &'callout'&: the callout cache
36743 .next
36744 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36745 .next
36746 &'misc'&: other hints data
36747 .endlist
36748
36749 The &'misc'& database is used for
36750
36751 .ilist
36752 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36753 .next
36754 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36755 &(smtp)& transport)
36756 .next
36757 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36758 in a transport)
36759 .endlist
36760
36761
36762
36763 .section "exim_dumpdb" "SECID261"
36764 .cindex "&'exim_dumpdb'&"
36765 The entire contents of a database are written to the standard output by the
36766 &'exim_dumpdb'& program, which has no options or arguments other than the
36767 spool and database names. For example, to dump the retry database:
36768 .code
36769 exim_dumpdb /var/spool/exim retry
36770 .endd
36771 Two lines of output are produced for each entry:
36772 .code
36773 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36774 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36775 .endd
36776 The first item on the first line is the key of the record. It starts with one
36777 of the letters R, or T, depending on whether it refers to a routing or
36778 transport retry. For a local delivery, the next part is the local address; for
36779 a remote delivery it is the name of the remote host, followed by its failing IP
36780 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36781 transport). If the remote port is not the standard one (port 25), it is added
36782 to the IP address. Then there follows an error code, an additional error code,
36783 and a textual description of the error.
36784
36785 The three times on the second line are the time of first failure, the time of
36786 the last delivery attempt, and the computed time for the next attempt. The line
36787 ends with an asterisk if the cutoff time for the last retry rule has been
36788 exceeded.
36789
36790 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36791 consists of a host name followed by a list of ids for messages that are or were
36792 waiting to be delivered to that host. If there are a very large number for any
36793 one host, continuation records, with a sequence number added to the host name,
36794 may be seen. The data in these records is often out of date, because a message
36795 may be routed to several alternative hosts, and Exim makes no effort to keep
36796 cross-references.
36797
36798
36799
36800 .section "exim_tidydb" "SECID262"
36801 .cindex "&'exim_tidydb'&"
36802 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36803 database. If run with no options, it removes all records that are more than 30
36804 days old. The age is calculated from the date and time that the record was last
36805 updated. Note that, in the case of the retry database, it is &'not'& the time
36806 since the first delivery failure. Information about a host that has been down
36807 for more than 30 days will remain in the database, provided that the record is
36808 updated sufficiently often.
36809
36810 The cutoff date can be altered by means of the &%-t%& option, which must be
36811 followed by a time. For example, to remove all records older than a week from
36812 the retry database:
36813 .code
36814 exim_tidydb -t 7d /var/spool/exim retry
36815 .endd
36816 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36817 message ids. In the former these appear as data in records keyed by host &--
36818 they were messages that were waiting for that host &-- and in the latter they
36819 are the keys for retry information for messages that have suffered certain
36820 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36821 message ids in database records are those of messages that are still on the
36822 queue. Message ids for messages that no longer exist are removed from
36823 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36824 For the &'retry'& database, records whose keys are non-existent message ids are
36825 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36826 whenever it removes information from the database.
36827
36828 Certain records are automatically removed by Exim when they are no longer
36829 needed, but others are not. For example, if all the MX hosts for a domain are
36830 down, a retry record is created for each one. If the primary MX host comes back
36831 first, its record is removed when Exim successfully delivers to it, but the
36832 records for the others remain because Exim has not tried to use those hosts.
36833
36834 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36835 hints databases. You should do this at a quiet time of day, because it requires
36836 a database to be locked (and therefore inaccessible to Exim) while it does its
36837 work. Removing records from a DBM file does not normally make the file smaller,
36838 but all the common DBM libraries are able to re-use the space that is released.
36839 After an initial phase of increasing in size, the databases normally reach a
36840 point at which they no longer get any bigger, as long as they are regularly
36841 tidied.
36842
36843 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36844 databases is likely to keep on increasing.
36845
36846
36847
36848
36849 .section "exim_fixdb" "SECID263"
36850 .cindex "&'exim_fixdb'&"
36851 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36852 Its main use is for testing Exim, but it might also be occasionally useful for
36853 getting round problems in a live system. It has no options, and its interface
36854 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36855 key of a database record can then be entered, and the data for that record is
36856 displayed.
36857
36858 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36859 except the &'retry'& database, that is the only operation that can be carried
36860 out. For the &'retry'& database, each field is output preceded by a number, and
36861 data for individual fields can be changed by typing the field number followed
36862 by new data, for example:
36863 .code
36864 > 4 951102:1000
36865 .endd
36866 resets the time of the next delivery attempt. Time values are given as a
36867 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36868 used as optional separators.
36869
36870
36871
36872
36873 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36874 .cindex "mailbox" "maintenance"
36875 .cindex "&'exim_lock'&"
36876 .cindex "locking mailboxes"
36877 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36878 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36879 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36880 a user agent while investigating a problem. The utility requires the name of
36881 the file as its first argument. If the locking is successful, the second
36882 argument is run as a command (using C's &[system()]& function); if there is no
36883 second argument, the value of the SHELL environment variable is used; if this
36884 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36885 is unlocked and the utility ends. The following options are available:
36886
36887 .vlist
36888 .vitem &%-fcntl%&
36889 Use &[fcntl()]& locking on the open mailbox.
36890
36891 .vitem &%-flock%&
36892 Use &[flock()]& locking on the open mailbox, provided the operating system
36893 supports it.
36894
36895 .vitem &%-interval%&
36896 This must be followed by a number, which is a number of seconds; it sets the
36897 interval to sleep between retries (default 3).
36898
36899 .vitem &%-lockfile%&
36900 Create a lock file before opening the mailbox.
36901
36902 .vitem &%-mbx%&
36903 Lock the mailbox using MBX rules.
36904
36905 .vitem &%-q%&
36906 Suppress verification output.
36907
36908 .vitem &%-retries%&
36909 This must be followed by a number; it sets the number of times to try to get
36910 the lock (default 10).
36911
36912 .vitem &%-restore_time%&
36913 This option causes &%exim_lock%& to restore the modified and read times to the
36914 locked file before exiting. This allows you to access a locked mailbox (for
36915 example, to take a backup copy) without disturbing the times that the user
36916 subsequently sees.
36917
36918 .vitem &%-timeout%&
36919 This must be followed by a number, which is a number of seconds; it sets a
36920 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36921 default), a non-blocking call is used.
36922
36923 .vitem &%-v%&
36924 Generate verbose output.
36925 .endlist
36926
36927 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36928 default is to create a lock file and also to use &[fcntl()]& locking on the
36929 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36930 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36931 requires that the directory containing the file be writeable. Locking by lock
36932 file does not last for ever; Exim assumes that a lock file is expired if it is
36933 more than 30 minutes old.
36934
36935 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36936 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36937 to be taken out on the open mailbox, and an exclusive lock on the file
36938 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36939 number of the mailbox file. When the locking is released, if an exclusive lock
36940 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36941
36942 The default output contains verification of the locking that takes place. The
36943 &%-v%& option causes some additional information to be given. The &%-q%& option
36944 suppresses all output except error messages.
36945
36946 A command such as
36947 .code
36948 exim_lock /var/spool/mail/spqr
36949 .endd
36950 runs an interactive shell while the file is locked, whereas
36951 .display
36952 &`exim_lock -q /var/spool/mail/spqr <<End`&
36953 <&'some commands'&>
36954 &`End`&
36955 .endd
36956 runs a specific non-interactive sequence of commands while the file is locked,
36957 suppressing all verification output. A single command can be run by a command
36958 such as
36959 .code
36960 exim_lock -q /var/spool/mail/spqr \
36961   "cp /var/spool/mail/spqr /some/where"
36962 .endd
36963 Note that if a command is supplied, it must be entirely contained within the
36964 second argument &-- hence the quotes.
36965 .ecindex IIDutils
36966
36967
36968 . ////////////////////////////////////////////////////////////////////////////
36969 . ////////////////////////////////////////////////////////////////////////////
36970
36971 .chapter "The Exim monitor" "CHAPeximon"
36972 .scindex IIDeximon "Exim monitor" "description"
36973 .cindex "X-windows"
36974 .cindex "&'eximon'&"
36975 .cindex "Local/eximon.conf"
36976 .cindex "&_exim_monitor/EDITME_&"
36977 The Exim monitor is an application which displays in an X window information
36978 about the state of Exim's queue and what Exim is doing. An admin user can
36979 perform certain operations on messages from this GUI interface; however all
36980 such facilities are also available from the command line, and indeed, the
36981 monitor itself makes use of the command line to perform any actions requested.
36982
36983
36984
36985 .section "Running the monitor" "SECID264"
36986 The monitor is started by running the script called &'eximon'&. This is a shell
36987 script that sets up a number of environment variables, and then runs the
36988 binary called &_eximon.bin_&. The default appearance of the monitor window can
36989 be changed by editing the &_Local/eximon.conf_& file created by editing
36990 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36991 parameters are for.
36992
36993 The parameters that get built into the &'eximon'& script can be overridden for
36994 a particular invocation by setting up environment variables of the same names,
36995 preceded by &`EXIMON_`&. For example, a shell command such as
36996 .code
36997 EXIMON_LOG_DEPTH=400 eximon
36998 .endd
36999 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37000 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37001 overrides the Exim log file configuration. This makes it possible to have
37002 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37003 syslog messages are routed to a file on the local host.
37004
37005 X resources can be used to change the appearance of the window in the normal
37006 way. For example, a resource setting of the form
37007 .code
37008 Eximon*background: gray94
37009 .endd
37010 changes the colour of the background to light grey rather than white. The
37011 stripcharts are drawn with both the data lines and the reference lines in
37012 black. This means that the reference lines are not visible when on top of the
37013 data. However, their colour can be changed by setting a resource called
37014 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37015 For example, if your X server is running Unix, you could set up lighter
37016 reference lines in the stripcharts by obeying
37017 .code
37018 xrdb -merge <<End
37019 Eximon*highlight: gray
37020 End
37021 .endd
37022 .cindex "admin user"
37023 In order to see the contents of messages on the queue, and to operate on them,
37024 &'eximon'& must either be run as root or by an admin user.
37025
37026 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37027 contain X11 resource parameters interpreted by the X11 library.  In addition,
37028 if the first parameter starts with the string "gdb" then it is removed and the
37029 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37030 versioned variants of gdb can be invoked).
37031
37032 The monitor's window is divided into three parts. The first contains one or
37033 more stripcharts and two action buttons, the second contains a &"tail"& of the
37034 main log file, and the third is a display of the queue of messages awaiting
37035 delivery, with two more action buttons. The following sections describe these
37036 different parts of the display.
37037
37038
37039
37040
37041 .section "The stripcharts" "SECID265"
37042 .cindex "stripchart"
37043 The first stripchart is always a count of messages on the queue. Its name can
37044 be configured by setting QUEUE_STRIPCHART_NAME in the
37045 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37046 configuration script by regular expression matches on log file entries, making
37047 it possible to display, for example, counts of messages delivered to certain
37048 hosts or using certain transports. The supplied defaults display counts of
37049 received and delivered messages, and of local and SMTP deliveries. The default
37050 period between stripchart updates is one minute; this can be adjusted by a
37051 parameter in the &_Local/eximon.conf_& file.
37052
37053 The stripchart displays rescale themselves automatically as the value they are
37054 displaying changes. There are always 10 horizontal lines in each chart; the
37055 title string indicates the value of each division when it is greater than one.
37056 For example, &"x2"& means that each division represents a value of 2.
37057
37058 It is also possible to have a stripchart which shows the percentage fullness of
37059 a particular disk partition, which is useful when local deliveries are confined
37060 to a single partition.
37061
37062 .cindex "&%statvfs%& function"
37063 This relies on the availability of the &[statvfs()]& function or equivalent in
37064 the operating system. Most, but not all versions of Unix that support Exim have
37065 this. For this particular stripchart, the top of the chart always represents
37066 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37067 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37068 &_Local/eximon.conf_& file.
37069
37070
37071
37072
37073 .section "Main action buttons" "SECID266"
37074 .cindex "size" "of monitor window"
37075 .cindex "Exim monitor" "window size"
37076 .cindex "window size"
37077 Below the stripcharts there is an action button for quitting the monitor. Next
37078 to this is another button marked &"Size"&. They are placed here so that
37079 shrinking the window to its default minimum size leaves just the queue count
37080 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37081 the window to expand to its maximum size, unless it is already at the maximum,
37082 in which case it is reduced to its minimum.
37083
37084 When expanding to the maximum, if the window cannot be fully seen where it
37085 currently is, it is moved back to where it was the last time it was at full
37086 size. When it is expanding from its minimum size, the old position is
37087 remembered, and next time it is reduced to the minimum it is moved back there.
37088
37089 The idea is that you can keep a reduced window just showing one or two
37090 stripcharts at a convenient place on your screen, easily expand it to show
37091 the full window when required, and just as easily put it back to what it was.
37092 The idea is copied from what the &'twm'& window manager does for its
37093 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37094 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37095
37096 Normally, the monitor starts up with the window at its full size, but it can be
37097 built so that it starts up with the window at its smallest size, by setting
37098 START_SMALL=yes in &_Local/eximon.conf_&.
37099
37100
37101
37102 .section "The log display" "SECID267"
37103 .cindex "log" "tail of; in monitor"
37104 The second section of the window is an area in which a display of the tail of
37105 the main log is maintained.
37106 To save space on the screen, the timestamp on each log line is shortened by
37107 removing the date and, if &%log_timezone%& is set, the timezone.
37108 The log tail is not available when the only destination for logging data is
37109 syslog, unless the syslog lines are routed to a local file whose name is passed
37110 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37111
37112 The log sub-window has a scroll bar at its lefthand side which can be used to
37113 move back to look at earlier text, and the up and down arrow keys also have a
37114 scrolling effect. The amount of log that is kept depends on the setting of
37115 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37116 to use. When this is full, the earlier 50% of data is discarded &-- this is
37117 much more efficient than throwing it away line by line. The sub-window also has
37118 a horizontal scroll bar for accessing the ends of long log lines. This is the
37119 only means of horizontal scrolling; the right and left arrow keys are not
37120 available. Text can be cut from this part of the window using the mouse in the
37121 normal way. The size of this subwindow is controlled by parameters in the
37122 configuration file &_Local/eximon.conf_&.
37123
37124 Searches of the text in the log window can be carried out by means of the ^R
37125 and ^S keystrokes, which default to a reverse and a forward search,
37126 respectively. The search covers only the text that is displayed in the window.
37127 It cannot go further back up the log.
37128
37129 The point from which the search starts is indicated by a caret marker. This is
37130 normally at the end of the text in the window, but can be positioned explicitly
37131 by pointing and clicking with the left mouse button, and is moved automatically
37132 by a successful search. If new text arrives in the window when it is scrolled
37133 back, the caret remains where it is, but if the window is not scrolled back,
37134 the caret is moved to the end of the new text.
37135
37136 Pressing ^R or ^S pops up a window into which the search text can be typed.
37137 There are buttons for selecting forward or reverse searching, for carrying out
37138 the search, and for cancelling. If the &"Search"& button is pressed, the search
37139 happens and the window remains so that further searches can be done. If the
37140 &"Return"& key is pressed, a single search is done and the window is closed. If
37141 ^C is typed the search is cancelled.
37142
37143 The searching facility is implemented using the facilities of the Athena text
37144 widget. By default this pops up a window containing both &"search"& and
37145 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37146 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37147 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37148 provided version of &%TextPop%& when the remaining parts of the text widget
37149 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37150 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37151 on these systems, at the expense of having unwanted items in the search popup
37152 window.
37153
37154
37155
37156 .section "The queue display" "SECID268"
37157 .cindex "queue" "display in monitor"
37158 The bottom section of the monitor window contains a list of all messages that
37159 are on the queue, which includes those currently being received or delivered,
37160 as well as those awaiting delivery. The size of this subwindow is controlled by
37161 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37162 at which it is updated is controlled by another parameter in the same file &--
37163 the default is 5 minutes, since queue scans can be quite expensive. However,
37164 there is an &"Update"& action button just above the display which can be used
37165 to force an update of the queue display at any time.
37166
37167 When a host is down for some time, a lot of pending mail can build up for it,
37168 and this can make it hard to deal with other messages on the queue. To help
37169 with this situation there is a button next to &"Update"& called &"Hide"&. If
37170 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37171 type anything in here and press &"Return"&, the text is added to a chain of
37172 such texts, and if every undelivered address in a message matches at least one
37173 of the texts, the message is not displayed.
37174
37175 If there is an address that does not match any of the texts, all the addresses
37176 are displayed as normal. The matching happens on the ends of addresses so, for
37177 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37178 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37179 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37180 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37181 a hide request is automatically cancelled after one hour.
37182
37183 While the dialogue box is displayed, you can't press any buttons or do anything
37184 else to the monitor window. For this reason, if you want to cut text from the
37185 queue display to use in the dialogue box, you have to do the cutting before
37186 pressing the &"Hide"& button.
37187
37188 The queue display contains, for each unhidden queued message, the length of
37189 time it has been on the queue, the size of the message, the message id, the
37190 message sender, and the first undelivered recipient, all on one line. If it is
37191 a bounce message, the sender is shown as &"<>"&. If there is more than one
37192 recipient to which the message has not yet been delivered, subsequent ones are
37193 listed on additional lines, up to a maximum configured number, following which
37194 an ellipsis is displayed. Recipients that have already received the message are
37195 not shown.
37196
37197 .cindex "frozen messages" "display"
37198 If a message is frozen, an asterisk is displayed at the left-hand side.
37199
37200 The queue display has a vertical scroll bar, and can also be scrolled by means
37201 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37202 The text searching facilities, as described above for the log window, are also
37203 available, but the caret is always moved to the end of the text when the queue
37204 display is updated.
37205
37206
37207
37208 .section "The queue menu" "SECID269"
37209 .cindex "queue" "menu in monitor"
37210 If the &%shift%& key is held down and the left button is clicked when the mouse
37211 pointer is over the text for any message, an action menu pops up, and the first
37212 line of the queue display for the message is highlighted. This does not affect
37213 any selected text.
37214
37215 If you want to use some other event for popping up the menu, you can set the
37216 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37217 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37218 value set in this parameter is a standard X event description. For example, to
37219 run eximon using &%ctrl%& rather than &%shift%& you could use
37220 .code
37221 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37222 .endd
37223 The title of the menu is the message id, and it contains entries which act as
37224 follows:
37225
37226 .ilist
37227 &'message log'&: The contents of the message log for the message are displayed
37228 in a new text window.
37229 .next
37230 &'headers'&: Information from the spool file that contains the envelope
37231 information and headers is displayed in a new text window. See chapter
37232 &<<CHAPspool>>& for a description of the format of spool files.
37233 .next
37234 &'body'&: The contents of the spool file containing the body of the message are
37235 displayed in a new text window. There is a default limit of 20,000 bytes to the
37236 amount of data displayed. This can be changed by setting the BODY_MAX
37237 option at compile time, or the EXIMON_BODY_MAX option at run time.
37238 .next
37239 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37240 delivery of the message. This causes an automatic thaw if the message is
37241 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37242 a new text window. The delivery is run in a separate process, to avoid holding
37243 up the monitor while the delivery proceeds.
37244 .next
37245 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37246 that the message be frozen.
37247 .next
37248 .cindex "thawing messages"
37249 .cindex "unfreezing messages"
37250 .cindex "frozen messages" "thawing"
37251 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37252 that the message be thawed.
37253 .next
37254 .cindex "delivery" "forcing failure"
37255 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37256 that Exim gives up trying to deliver the message. A bounce message is generated
37257 for any remaining undelivered addresses.
37258 .next
37259 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37260 that the message be deleted from the system without generating a bounce
37261 message.
37262 .next
37263 &'add recipient'&: A dialog box is displayed into which a recipient address can
37264 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37265 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37266 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37267 causes a call to Exim to be made using the &%-Mar%& option to request that an
37268 additional recipient be added to the message, unless the entry box is empty, in
37269 which case no action is taken.
37270 .next
37271 &'mark delivered'&: A dialog box is displayed into which a recipient address
37272 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37273 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37274 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37275 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37276 recipient address as already delivered, unless the entry box is empty, in which
37277 case no action is taken.
37278 .next
37279 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37280 mark all recipient addresses as already delivered.
37281 .next
37282 &'edit sender'&: A dialog box is displayed initialized with the current
37283 sender's address. Pressing RETURN causes a call to Exim to be made using the
37284 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37285 in which case no action is taken. If you want to set an empty sender (as in
37286 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37287 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37288 the address is qualified with that domain.
37289 .endlist
37290
37291 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37292 other cases when a call to Exim is made, if there is any output from Exim (in
37293 particular, if the command fails) a window containing the command and the
37294 output is displayed. Otherwise, the results of the action are normally apparent
37295 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37296 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37297 if no output is generated.
37298
37299 The queue display is automatically updated for actions such as freezing and
37300 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37301 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37302 force an update of the display after one of these actions.
37303
37304 In any text window that is displayed as result of a menu action, the normal
37305 cut-and-paste facility is available, and searching can be carried out using ^R
37306 and ^S, as described above for the log tail window.
37307 .ecindex IIDeximon
37308
37309
37310
37311
37312
37313 . ////////////////////////////////////////////////////////////////////////////
37314 . ////////////////////////////////////////////////////////////////////////////
37315
37316 .chapter "Security considerations" "CHAPsecurity"
37317 .scindex IIDsecurcon "security" "discussion of"
37318 This chapter discusses a number of issues concerned with security, some of
37319 which are also covered in other parts of this manual.
37320
37321 For reasons that this author does not understand, some people have promoted
37322 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37323 existence of this chapter in the documentation. However, the intent of the
37324 chapter is simply to describe the way Exim works in relation to certain
37325 security concerns, not to make any specific claims about the effectiveness of
37326 its security as compared with other MTAs.
37327
37328 What follows is a description of the way Exim is supposed to be. Best efforts
37329 have been made to try to ensure that the code agrees with the theory, but an
37330 absence of bugs can never be guaranteed. Any that are reported will get fixed
37331 as soon as possible.
37332
37333
37334 .section "Building a more &""hardened""& Exim" "SECID286"
37335 .cindex "security" "build-time features"
37336 There are a number of build-time options that can be set in &_Local/Makefile_&
37337 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37338 Exim administrator who does not have the root password, or by someone who has
37339 penetrated the Exim (but not the root) account. These options are as follows:
37340
37341 .ilist
37342 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37343 start of any file names used with the &%-C%& option. When it is set, these file
37344 names are also not allowed to contain the sequence &"/../"&. (However, if the
37345 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37346 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37347 default setting for &%ALT_CONFIG_PREFIX%&.
37348
37349 If the permitted configuration files are confined to a directory to
37350 which only root has access, this guards against someone who has broken
37351 into the Exim account from running a privileged Exim with an arbitrary
37352 configuration file, and using it to break into other accounts.
37353 .next
37354
37355 If a non-trusted configuration file (i.e. not the default configuration file
37356 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37357 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37358 the next item), then root privilege is retained only if the caller of Exim is
37359 root. This locks out the possibility of testing a configuration using &%-C%&
37360 right through message reception and delivery, even if the caller is root. The
37361 reception works, but by that time, Exim is running as the Exim user, so when
37362 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37363 privilege to be lost. However, root can test reception and delivery using two
37364 separate commands.
37365
37366 .next
37367 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37368 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37369 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37370 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37371 the restrictive side.  Requiring build-time selection of safe macros is onerous
37372 but this option is intended solely as a transition mechanism to permit
37373 previously-working configurations to continue to work after release 4.73.
37374 .next
37375 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37376 is disabled.
37377 .next
37378 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37379 never to be used for any deliveries. This is like the &%never_users%& runtime
37380 option, but it cannot be overridden; the runtime option adds additional users
37381 to the list. The default setting is &"root"&; this prevents a non-root user who
37382 is permitted to modify the runtime file from using Exim as a way to get root.
37383 .endlist
37384
37385
37386
37387 .section "Root privilege" "SECID270"
37388 .cindex "setuid"
37389 .cindex "root privilege"
37390 The Exim binary is normally setuid to root, which means that it gains root
37391 privilege (runs as root) when it starts execution. In some special cases (for
37392 example, when the daemon is not in use and there are no local deliveries), it
37393 may be possible to run Exim setuid to some user other than root. This is
37394 discussed in the next section. However, in most installations, root privilege
37395 is required for two things:
37396
37397 .ilist
37398 To set up a socket connected to the standard SMTP port (25) when initialising
37399 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37400 not required.
37401 .next
37402 To be able to change uid and gid in order to read users' &_.forward_& files and
37403 perform local deliveries as the receiving user or as specified in the
37404 configuration.
37405 .endlist
37406
37407 It is not necessary to be root to do any of the other things Exim does, such as
37408 receiving messages and delivering them externally over SMTP, and it is
37409 obviously more secure if Exim does not run as root except when necessary.
37410 For this reason, a user and group for Exim to use must be defined in
37411 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37412 group"&. Their values can be changed by the run time configuration, though this
37413 is not recommended. Often a user called &'exim'& is used, but some sites use
37414 &'mail'& or another user name altogether.
37415
37416 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37417 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37418 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37419
37420 After a new Exim process has interpreted its command line options, it changes
37421 uid and gid in the following cases:
37422
37423 .ilist
37424 .oindex "&%-C%&"
37425 .oindex "&%-D%&"
37426 If the &%-C%& option is used to specify an alternate configuration file, or if
37427 the &%-D%& option is used to define macro values for the configuration, and the
37428 calling process is not running as root, the uid and gid are changed to those of
37429 the calling process.
37430 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37431 option may not be used at all.
37432 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37433 can be supplied if the calling process is running as root, the Exim run-time
37434 user or CONFIGURE_OWNER, if defined.
37435 .next
37436 .oindex "&%-be%&"
37437 .oindex "&%-bf%&"
37438 .oindex "&%-bF%&"
37439 If the expansion test option (&%-be%&) or one of the filter testing options
37440 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37441 calling process.
37442 .next
37443 If the process is not a daemon process or a queue runner process or a delivery
37444 process or a process for testing address routing (started with &%-bt%&), the
37445 uid and gid are changed to the Exim user and group. This means that Exim always
37446 runs under its own uid and gid when receiving messages. This also applies when
37447 testing address verification
37448 .oindex "&%-bv%&"
37449 .oindex "&%-bh%&"
37450 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37451 option).
37452 .next
37453 For a daemon, queue runner, delivery, or address testing process, the uid
37454 remains as root at this stage, but the gid is changed to the Exim group.
37455 .endlist
37456
37457 The processes that initially retain root privilege behave as follows:
37458
37459 .ilist
37460 A daemon process changes the gid to the Exim group and the uid to the Exim
37461 user after setting up one or more listening sockets. The &[initgroups()]&
37462 function is called, so that if the Exim user is in any additional groups, they
37463 will be used during message reception.
37464 .next
37465 A queue runner process retains root privilege throughout its execution. Its
37466 job is to fork a controlled sequence of delivery processes.
37467 .next
37468 A delivery process retains root privilege throughout most of its execution,
37469 but any actual deliveries (that is, the transports themselves) are run in
37470 subprocesses which always change to a non-root uid and gid. For local
37471 deliveries this is typically the uid and gid of the owner of the mailbox; for
37472 remote deliveries, the Exim uid and gid are used. Once all the delivery
37473 subprocesses have been run, a delivery process changes to the Exim uid and gid
37474 while doing post-delivery tidying up such as updating the retry database and
37475 generating bounce and warning messages.
37476
37477 While the recipient addresses in a message are being routed, the delivery
37478 process runs as root. However, if a user's filter file has to be processed,
37479 this is done in a subprocess that runs under the individual user's uid and
37480 gid. A system filter is run as root unless &%system_filter_user%& is set.
37481 .next
37482 A process that is testing addresses (the &%-bt%& option) runs as root so that
37483 the routing is done in the same environment as a message delivery.
37484 .endlist
37485
37486
37487
37488
37489 .section "Running Exim without privilege" "SECTrunexiwitpri"
37490 .cindex "privilege, running without"
37491 .cindex "unprivileged running"
37492 .cindex "root privilege" "running without"
37493 Some installations like to run Exim in an unprivileged state for more of its
37494 operation, for added security. Support for this mode of operation is provided
37495 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37496 gid are changed to the Exim user and group at the start of a delivery process
37497 (and also queue runner and address testing processes). This means that address
37498 routing is no longer run as root, and the deliveries themselves cannot change
37499 to any other uid.
37500
37501 .cindex SIGHUP
37502 .cindex "daemon" "restarting"
37503 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37504 that the daemon can still be started in the usual way, and it can respond
37505 correctly to SIGHUP because the re-invocation regains root privilege.
37506
37507 An alternative approach is to make Exim setuid to the Exim user and also setgid
37508 to the Exim group. If you do this, the daemon must be started from a root
37509 process. (Calling Exim from a root process makes it behave in the way it does
37510 when it is setuid root.) However, the daemon cannot restart itself after a
37511 SIGHUP signal because it cannot regain privilege.
37512
37513 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37514 stops Exim from trying to re-invoke itself to do a delivery after a message has
37515 been received. Such a re-invocation is a waste of resources because it has no
37516 effect.
37517
37518 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37519 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37520 to the Exim user seems a clean approach, but there is one complication:
37521
37522 In this style of operation, Exim is running with the real uid and gid set to
37523 those of the calling process, and the effective uid/gid set to Exim's values.
37524 Ideally, any association with the calling process' uid/gid should be dropped,
37525 that is, the real uid/gid should be reset to the effective values so as to
37526 discard any privileges that the caller may have. While some operating systems
37527 have a function that permits this action for a non-root effective uid, quite a
37528 number of them do not. Because of this lack of standardization, Exim does not
37529 address this problem at this time.
37530
37531 For this reason, the recommended approach for &"mostly unprivileged"& running
37532 is to keep the Exim binary setuid to root, and to set
37533 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37534 be used in the most straightforward way.
37535
37536 If you configure Exim not to run delivery processes as root, there are a
37537 number of restrictions on what you can do:
37538
37539 .ilist
37540 You can deliver only as the Exim user/group. You should  explicitly use the
37541 &%user%& and &%group%& options to override routers or local transports that
37542 normally deliver as the recipient. This makes sure that configurations that
37543 work in this mode function the same way in normal mode. Any implicit or
37544 explicit specification of another user causes an error.
37545 .next
37546 Use of &_.forward_& files is severely restricted, such that it is usually
37547 not worthwhile to include them in the configuration.
37548 .next
37549 Users who wish to use &_.forward_& would have to make their home directory and
37550 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37551 and their equivalents in Exim filters, cannot be used. While they could be
37552 enabled in the Exim user's name, that would be insecure and not very useful.
37553 .next
37554 Unless the local user mailboxes are all owned by the Exim user (possible in
37555 some POP3 or IMAP-only environments):
37556
37557 .olist
37558 They must be owned by the Exim group and be writeable by that group. This
37559 implies you must set &%mode%& in the appendfile configuration, as well as the
37560 mode of the mailbox files themselves.
37561 .next
37562 You must set &%no_check_owner%&, since most or all of the files will not be
37563 owned by the Exim user.
37564 .next
37565 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37566 on a newly created mailbox when unprivileged. This also implies that new
37567 mailboxes need to be created manually.
37568 .endlist olist
37569 .endlist ilist
37570
37571
37572 These restrictions severely restrict what can be done in local deliveries.
37573 However, there are no restrictions on remote deliveries. If you are running a
37574 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37575 gives more security at essentially no cost.
37576
37577 If you are using the &%mua_wrapper%& facility (see chapter
37578 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37579
37580
37581
37582
37583 .section "Delivering to local files" "SECID271"
37584 Full details of the checks applied by &(appendfile)& before it writes to a file
37585 are given in chapter &<<CHAPappendfile>>&.
37586
37587
37588
37589 .section "Running local commands" "SECTsecconslocalcmds"
37590 .cindex "security" "local commands"
37591 .cindex "security" "command injection attacks"
37592 There are a number of ways in which an administrator can configure Exim to run
37593 commands based upon received, untrustworthy, data. Further, in some
37594 configurations a user who can control a &_.forward_& file can also arrange to
37595 run commands. Configuration to check includes, but is not limited to:
37596
37597 .ilist
37598 Use of &%use_shell%& in the pipe transport: various forms of shell command
37599 injection may be possible with this option present. It is dangerous and should
37600 be used only with considerable caution. Consider constraints which whitelist
37601 allowed characters in a variable which is to be used in a pipe transport that
37602 has &%use_shell%& enabled.
37603 .next
37604 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37605 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37606 &_.forward_& files in a redirect router. If Exim is running on a central mail
37607 hub to which ordinary users do not have shell access, but home directories are
37608 NFS mounted (for instance) then administrators should review the list of these
37609 forbid options available, and should bear in mind that the options that may
37610 need forbidding can change as new features are added between releases.
37611 .next
37612 The &%${run...}%& expansion item does not use a shell by default, but
37613 administrators can configure use of &_/bin/sh_& as part of the command.
37614 Such invocations should be viewed with prejudicial suspicion.
37615 .next
37616 Administrators who use embedded Perl are advised to explore how Perl's
37617 taint checking might apply to their usage.
37618 .next
37619 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37620 administrators are well advised to view its use with suspicion, in case (for
37621 instance) it allows a local-part to contain embedded Exim directives.
37622 .next
37623 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37624 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37625 each can reference arbitrary lists and files, rather than just being a list
37626 of opaque strings.
37627 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37628 real-world security vulnerabilities caused by its use with untrustworthy data
37629 injected in, for SQL injection attacks.
37630 Consider the use of the &%inlisti%& expansion condition instead.
37631 .endlist
37632
37633
37634
37635
37636 .section "Trust in configuration data" "SECTsecconfdata"
37637 .cindex "security" "data sources"
37638 .cindex "security" "regular expressions"
37639 .cindex "regular expressions" "security"
37640 .cindex "PCRE" "security"
37641 If configuration data for Exim can come from untrustworthy sources, there
37642 are some issues to be aware of:
37643
37644 .ilist
37645 Use of &%${expand...}%& may provide a path for shell injection attacks.
37646 .next
37647 Letting untrusted data provide a regular expression is unwise.
37648 .next
37649 Using &%${match...}%& to apply a fixed regular expression against untrusted
37650 data may result in pathological behaviour within PCRE.  Be aware of what
37651 "backtracking" means and consider options for being more strict with a regular
37652 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37653 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37654 possessive quantifiers or just not using regular expressions against untrusted
37655 data.
37656 .next
37657 It can be important to correctly use &%${quote:...}%&,
37658 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37659 items to ensure that data is correctly constructed.
37660 .next
37661 Some lookups might return multiple results, even though normal usage is only
37662 expected to yield one result.
37663 .endlist
37664
37665
37666
37667
37668 .section "IPv4 source routing" "SECID272"
37669 .cindex "source routing" "in IP packets"
37670 .cindex "IP source routing"
37671 Many operating systems suppress IP source-routed packets in the kernel, but
37672 some cannot be made to do this, so Exim does its own check. It logs incoming
37673 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37674 IPv6. No special checking is currently done.
37675
37676
37677
37678 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37679 Support for these SMTP commands is disabled by default. If required, they can
37680 be enabled by defining suitable ACLs.
37681
37682
37683
37684
37685 .section "Privileged users" "SECID274"
37686 .cindex "trusted users"
37687 .cindex "admin user"
37688 .cindex "privileged user"
37689 .cindex "user" "trusted"
37690 .cindex "user" "admin"
37691 Exim recognizes two sets of users with special privileges. Trusted users are
37692 able to submit new messages to Exim locally, but supply their own sender
37693 addresses and information about a sending host. For other users submitting
37694 local messages, Exim sets up the sender address from the uid, and doesn't
37695 permit a remote host to be specified.
37696
37697 .oindex "&%-f%&"
37698 However, an untrusted user is permitted to use the &%-f%& command line option
37699 in the special form &%-f <>%& to indicate that a delivery failure for the
37700 message should not cause an error report. This affects the message's envelope,
37701 but it does not affect the &'Sender:'& header. Untrusted users may also be
37702 permitted to use specific forms of address with the &%-f%& option by setting
37703 the &%untrusted_set_sender%& option.
37704
37705 Trusted users are used to run processes that receive mail messages from some
37706 other mail domain and pass them on to Exim for delivery either locally, or over
37707 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37708 as any user listed in the &%trusted_users%& configuration option, or under any
37709 group listed in the &%trusted_groups%& option.
37710
37711 Admin users are permitted to do things to the messages on Exim's queue. They
37712 can freeze or thaw messages, cause them to be returned to their senders, remove
37713 them entirely, or modify them in various ways. In addition, admin users can run
37714 the Exim monitor and see all the information it is capable of providing, which
37715 includes the contents of files on the spool.
37716
37717 .oindex "&%-M%&"
37718 .oindex "&%-q%&"
37719 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37720 delivery of messages on its queue is restricted to admin users. This
37721 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37722 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37723 queue is also restricted to admin users. This restriction can be relaxed by
37724 setting &%no_queue_list_requires_admin%&.
37725
37726 Exim recognizes an admin user if the calling process is running as root or as
37727 the Exim user or if any of the groups associated with the calling process is
37728 the Exim group. It is not necessary actually to be running under the Exim
37729 group. However, if admin users who are not root or the Exim user are to access
37730 the contents of files on the spool via the Exim monitor (which runs
37731 unprivileged), Exim must be built to allow group read access to its spool
37732 files.
37733
37734
37735
37736 .section "Spool files" "SECID275"
37737 .cindex "spool directory" "files"
37738 Exim's spool directory and everything it contains is owned by the Exim user and
37739 set to the Exim group. The mode for spool files is defined in the
37740 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37741 any user who is a member of the Exim group can access these files.
37742
37743
37744
37745 .section "Use of argv[0]" "SECID276"
37746 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37747 of specific strings, Exim assumes certain options. For example, calling Exim
37748 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37749 to calling it with the option &%-bS%&. There are no security implications in
37750 this.
37751
37752
37753
37754 .section "Use of %f formatting" "SECID277"
37755 The only use made of &"%f"& by Exim is in formatting load average values. These
37756 are actually stored in integer variables as 1000 times the load average.
37757 Consequently, their range is limited and so therefore is the length of the
37758 converted output.
37759
37760
37761
37762 .section "Embedded Exim path" "SECID278"
37763 Exim uses its own path name, which is embedded in the code, only when it needs
37764 to re-exec in order to regain root privilege. Therefore, it is not root when it
37765 does so. If some bug allowed the path to get overwritten, it would lead to an
37766 arbitrary program's being run as exim, not as root.
37767
37768
37769
37770 .section "Dynamic module directory" "SECTdynmoddir"
37771 Any dynamically loadable modules must be installed into the directory
37772 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37773 loading it.
37774
37775
37776 .section "Use of sprintf()" "SECID279"
37777 .cindex "&[sprintf()]&"
37778 A large number of occurrences of &"sprintf"& in the code are actually calls to
37779 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37780 The intermediate formatting is done into a large fixed buffer by a function
37781 that runs through the format string itself, and checks the length of each
37782 conversion before performing it, thus preventing buffer overruns.
37783
37784 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37785 the output buffer is known to be sufficiently long to contain the converted
37786 string.
37787
37788
37789
37790 .section "Use of debug_printf() and log_write()" "SECID280"
37791 Arbitrary strings are passed to both these functions, but they do their
37792 formatting by calling the function &'string_vformat()'&, which runs through
37793 the format string itself, and checks the length of each conversion.
37794
37795
37796
37797 .section "Use of strcat() and strcpy()" "SECID281"
37798 These are used only in cases where the output buffer is known to be large
37799 enough to hold the result.
37800 .ecindex IIDsecurcon
37801
37802
37803
37804
37805 . ////////////////////////////////////////////////////////////////////////////
37806 . ////////////////////////////////////////////////////////////////////////////
37807
37808 .chapter "Format of spool files" "CHAPspool"
37809 .scindex IIDforspo1 "format" "spool files"
37810 .scindex IIDforspo2 "spool directory" "format of files"
37811 .scindex IIDforspo3 "spool files" "format of"
37812 .cindex "spool files" "editing"
37813 A message on Exim's queue consists of two files, whose names are the message id
37814 followed by -D and -H, respectively. The data portion of the message is kept in
37815 the -D file on its own. The message's envelope, status, and headers are all
37816 kept in the -H file, whose format is described in this chapter. Each of these
37817 two files contains the final component of its own name as its first line. This
37818 is insurance against disk crashes where the directory is lost but the files
37819 themselves are recoverable.
37820
37821 Some people are tempted into editing -D files in order to modify messages. You
37822 need to be extremely careful if you do this; it is not recommended and you are
37823 on your own if you do it. Here are some of the pitfalls:
37824
37825 .ilist
37826 You must ensure that Exim does not try to deliver the message while you are
37827 fiddling with it. The safest way is to take out a write lock on the -D file,
37828 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37829 place, the lock will be retained. If you write a new file and rename it, the
37830 lock will be lost at the instant of rename.
37831 .next
37832 .vindex "&$body_linecount$&"
37833 If you change the number of lines in the file, the value of
37834 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37835 present, this value is not used by Exim, but there is no guarantee that this
37836 will always be the case.
37837 .next
37838 If the message is in MIME format, you must take care not to break it.
37839 .next
37840 If the message is cryptographically signed, any change will invalidate the
37841 signature.
37842 .endlist
37843 All in all, modifying -D files is fraught with danger.
37844
37845 Files whose names end with -J may also be seen in the &_input_& directory (or
37846 its subdirectories when &%split_spool_directory%& is set). These are journal
37847 files, used to record addresses to which the message has been delivered during
37848 the course of a delivery attempt. If there are still undelivered recipients at
37849 the end, the -H file is updated, and the -J file is deleted. If, however, there
37850 is some kind of crash (for example, a power outage) before this happens, the -J
37851 file remains in existence. When Exim next processes the message, it notices the
37852 -J file and uses it to update the -H file before starting the next delivery
37853 attempt.
37854
37855 .section "Format of the -H file" "SECID282"
37856 .cindex "uid (user id)" "in spool file"
37857 .cindex "gid (group id)" "in spool file"
37858 The second line of the -H file contains the login name for the uid of the
37859 process that called Exim to read the message, followed by the numerical uid and
37860 gid. For a locally generated message, this is normally the user who sent the
37861 message. For a message received over TCP/IP via the daemon, it is
37862 normally the Exim user.
37863
37864 The third line of the file contains the address of the message's sender as
37865 transmitted in the envelope, contained in angle brackets. The sender address is
37866 empty for bounce messages. For incoming SMTP mail, the sender address is given
37867 in the MAIL command. For locally generated mail, the sender address is
37868 created by Exim from the login name of the current user and the configured
37869 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37870 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37871 &"<>"& or an address that matches &%untrusted_set_senders%&.
37872
37873 The fourth line contains two numbers. The first is the time that the message
37874 was received, in the conventional Unix form &-- the number of seconds since the
37875 start of the epoch. The second number is a count of the number of messages
37876 warning of delayed delivery that have been sent to the sender.
37877
37878 There follow a number of lines starting with a hyphen. These can appear in any
37879 order, and are omitted when not relevant:
37880
37881 .vlist
37882 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37883 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37884 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37885 recognized, to provide backward compatibility. In the old format, a line of
37886 this form is present for every ACL variable that is not empty. The number
37887 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37888 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37889 the data string for the variable. The string itself starts at the beginning of
37890 the next line, and is followed by a newline character. It may contain internal
37891 newlines.
37892
37893 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37894 A line of this form is present for every ACL connection variable that is
37895 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37896 The length is the length of the data string for the variable. The string itself
37897 starts at the beginning of the next line, and is followed by a newline
37898 character. It may contain internal newlines.
37899
37900 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37901 A line of this form is present for every ACL message variable that is defined.
37902 Note that there is a space between &%-aclm%& and the rest of the name. The
37903 length is the length of the data string for the variable. The string itself
37904 starts at the beginning of the next line, and is followed by a newline
37905 character. It may contain internal newlines.
37906
37907 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37908 This is present if, when the message was received over SMTP, the value of
37909 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37910
37911 .vitem &%-allow_unqualified_recipient%&
37912 This is present if unqualified recipient addresses are permitted in header
37913 lines (to stop such addresses from being qualified if rewriting occurs at
37914 transport time). Local messages that were input using &%-bnq%& and remote
37915 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37916
37917 .vitem &%-allow_unqualified_sender%&
37918 This is present if unqualified sender addresses are permitted in header lines
37919 (to stop such addresses from being qualified if rewriting occurs at transport
37920 time). Local messages that were input using &%-bnq%& and remote messages from
37921 hosts that match &%sender_unqualified_hosts%& set this flag.
37922
37923 .vitem "&%-auth_id%&&~<&'text'&>"
37924 The id information for a message received on an authenticated SMTP connection
37925 &-- the value of the &$authenticated_id$& variable.
37926
37927 .vitem "&%-auth_sender%&&~<&'address'&>"
37928 The address of an authenticated sender &-- the value of the
37929 &$authenticated_sender$& variable.
37930
37931 .vitem "&%-body_linecount%&&~<&'number'&>"
37932 This records the number of lines in the body of the message, and is always
37933 present.
37934
37935 .vitem "&%-body_zerocount%&&~<&'number'&>"
37936 This records the number of binary zero bytes in the body of the message, and is
37937 present if the number is greater than zero.
37938
37939 .vitem &%-deliver_firsttime%&
37940 This is written when a new message is first added to the spool. When the spool
37941 file is updated after a deferral, it is omitted.
37942
37943 .vitem "&%-frozen%&&~<&'time'&>"
37944 .cindex "frozen messages" "spool data"
37945 The message is frozen, and the freezing happened at <&'time'&>.
37946
37947 .vitem "&%-helo_name%&&~<&'text'&>"
37948 This records the host name as specified by a remote host in a HELO or EHLO
37949 command.
37950
37951 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37952 This records the IP address of the host from which the message was received and
37953 the remote port number that was used. It is omitted for locally generated
37954 messages.
37955
37956 .vitem "&%-host_auth%&&~<&'text'&>"
37957 If the message was received on an authenticated SMTP connection, this records
37958 the name of the authenticator &-- the value of the
37959 &$sender_host_authenticated$& variable.
37960
37961 .vitem &%-host_lookup_failed%&
37962 This is present if an attempt to look up the sending host's name from its IP
37963 address failed. It corresponds to the &$host_lookup_failed$& variable.
37964
37965 .vitem "&%-host_name%&&~<&'text'&>"
37966 .cindex "reverse DNS lookup"
37967 .cindex "DNS" "reverse lookup"
37968 This records the name of the remote host from which the message was received,
37969 if the host name was looked up from the IP address when the message was being
37970 received. It is not present if no reverse lookup was done.
37971
37972 .vitem "&%-ident%&&~<&'text'&>"
37973 For locally submitted messages, this records the login of the originating user,
37974 unless it was a trusted user and the &%-oMt%& option was used to specify an
37975 ident value. For messages received over TCP/IP, this records the ident string
37976 supplied by the remote host, if any.
37977
37978 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37979 This records the IP address of the local interface and the port number through
37980 which a message was received from a remote host. It is omitted for locally
37981 generated messages.
37982
37983 .vitem &%-local%&
37984 The message is from a local sender.
37985
37986 .vitem &%-localerror%&
37987 The message is a locally-generated bounce message.
37988
37989 .vitem "&%-local_scan%&&~<&'string'&>"
37990 This records the data string that was returned by the &[local_scan()]& function
37991 when the message was received &-- the value of the &$local_scan_data$&
37992 variable. It is omitted if no data was returned.
37993
37994 .vitem &%-manual_thaw%&
37995 The message was frozen but has been thawed manually, that is, by an explicit
37996 Exim command rather than via the auto-thaw process.
37997
37998 .vitem &%-N%&
37999 A testing delivery process was started using the &%-N%& option to suppress any
38000 actual deliveries, but delivery was deferred. At any further delivery attempts,
38001 &%-N%& is assumed.
38002
38003 .vitem &%-received_protocol%&
38004 This records the value of the &$received_protocol$& variable, which contains
38005 the name of the protocol by which the message was received.
38006
38007 .vitem &%-sender_set_untrusted%&
38008 The envelope sender of this message was set by an untrusted local caller (used
38009 to ensure that the caller is displayed in queue listings).
38010
38011 .vitem "&%-spam_score_int%&&~<&'number'&>"
38012 If a message was scanned by SpamAssassin, this is present. It records the value
38013 of &$spam_score_int$&.
38014
38015 .vitem &%-tls_certificate_verified%&
38016 A TLS certificate was received from the client that sent this message, and the
38017 certificate was verified by the server.
38018
38019 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38020 When the message was received over an encrypted connection, this records the
38021 name of the cipher suite that was used.
38022
38023 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38024 When the message was received over an encrypted connection, and a certificate
38025 was received from the client, this records the Distinguished Name from that
38026 certificate.
38027 .endlist
38028
38029 Following the options there is a list of those addresses to which the message
38030 is not to be delivered. This set of addresses is initialized from the command
38031 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38032 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38033 the address is added to this set. The addresses are kept internally as a
38034 balanced binary tree, and it is a representation of that tree which is written
38035 to the spool file. If an address is expanded via an alias or forward file, the
38036 original address is added to the tree when deliveries to all its child
38037 addresses are complete.
38038
38039 If the tree is empty, there is a single line in the spool file containing just
38040 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38041 Y or N, followed by an address. The address is the value for the node of the
38042 tree, and the letters indicate whether the node has a left branch and/or a
38043 right branch attached to it, respectively. If branches exist, they immediately
38044 follow. Here is an example of a three-node tree:
38045 .code
38046 YY darcy@austen.fict.example
38047 NN alice@wonderland.fict.example
38048 NN editor@thesaurus.ref.example
38049 .endd
38050 After the non-recipients tree, there is a list of the message's recipients.
38051 This is a simple list, preceded by a count. It includes all the original
38052 recipients of the message, including those to whom the message has already been
38053 delivered. In the simplest case, the list contains one address per line. For
38054 example:
38055 .code
38056 4
38057 editor@thesaurus.ref.example
38058 darcy@austen.fict.example
38059 rdo@foundation
38060 alice@wonderland.fict.example
38061 .endd
38062 However, when a child address has been added to the top-level addresses as a
38063 result of the use of the &%one_time%& option on a &(redirect)& router, each
38064 line is of the following form:
38065 .display
38066 <&'top-level address'&> <&'errors_to address'&> &&&
38067   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38068 .endd
38069 The 01 flag bit indicates the presence of the three other fields that follow
38070 the top-level address. Other bits may be used in future to support additional
38071 fields. The <&'parent number'&> is the offset in the recipients list of the
38072 original parent of the &"one time"& address. The first two fields are the
38073 envelope sender that is associated with this address and its length. If the
38074 length is zero, there is no special envelope sender (there are then two space
38075 characters in the line). A non-empty field can arise from a &(redirect)& router
38076 that has an &%errors_to%& setting.
38077
38078
38079 A blank line separates the envelope and status information from the headers
38080 which follow. A header may occupy several lines of the file, and to save effort
38081 when reading it in, each header is preceded by a number and an identifying
38082 character. The number is the number of characters in the header, including any
38083 embedded newlines and the terminating newline. The character is one of the
38084 following:
38085
38086 .table2 50pt
38087 .row <&'blank'&>         "header in which Exim has no special interest"
38088 .row &`B`&               "&'Bcc:'& header"
38089 .row &`C`&               "&'Cc:'& header"
38090 .row &`F`&               "&'From:'& header"
38091 .row &`I`&               "&'Message-id:'& header"
38092 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38093 .row &`R`&               "&'Reply-To:'& header"
38094 .row &`S`&               "&'Sender:'& header"
38095 .row &`T`&               "&'To:'& header"
38096 .row &`*`&               "replaced or deleted header"
38097 .endtable
38098
38099 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38100 purposes. They are not transmitted when the message is delivered. Here is a
38101 typical set of headers:
38102 .code
38103 111P Received: by hobbit.fict.example with local (Exim 4.00)
38104 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38105 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38106 038* X-rewrote-sender: bb@hobbit.fict.example
38107 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38108 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38109 099* To: alice@wonderland.fict.example, rdo@foundation,
38110 darcy@austen.fict.example, editor@thesaurus.ref.example
38111 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38112 darcy@austen.fict.example, editor@thesaurus.ref.example
38113 038  Date: Fri, 11 May 2001 10:28:59 +0100
38114 .endd
38115 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38116 &'To:'& header have been rewritten, the last one because routing expanded the
38117 unqualified domain &'foundation'&.
38118 .ecindex IIDforspo1
38119 .ecindex IIDforspo2
38120 .ecindex IIDforspo3
38121
38122 . ////////////////////////////////////////////////////////////////////////////
38123 . ////////////////////////////////////////////////////////////////////////////
38124
38125 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38126          "DKIM Support"
38127 .cindex "DKIM"
38128
38129 DKIM is a mechanism by which messages sent by some entity can be provably
38130 linked to a domain which that entity controls.  It permits reputation to
38131 be tracked on a per-domain basis, rather than merely upon source IP address.
38132 DKIM is documented in RFC 4871.
38133
38134 DKIM support is compiled into Exim by default if TLS support is present.
38135 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38136
38137 Exim's DKIM implementation allows for
38138 .olist
38139 Signing outgoing messages: This function is implemented in the SMTP transport.
38140 It can co-exist with all other Exim features
38141 (including transport filters)
38142 except cutthrough delivery.
38143 .next
38144 Verifying signatures in incoming messages: This is implemented by an additional
38145 ACL (acl_smtp_dkim), which can be called several times per message, with
38146 different signature contexts.
38147 .endlist
38148
38149 In typical Exim style, the verification implementation does not include any
38150 default "policy". Instead it enables you to build your own policy using
38151 Exim's standard controls.
38152
38153 Please note that verification of DKIM signatures in incoming mail is turned
38154 on by default for logging purposes. For each signature in incoming email,
38155 exim will log a line displaying the most important signature details, and the
38156 signature status. Here is an example (with line-breaks added for clarity):
38157 .code
38158 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38159     d=facebookmail.com s=q1-2009b
38160     c=relaxed/relaxed a=rsa-sha1
38161     i=@facebookmail.com t=1252484542 [verification succeeded]
38162 .endd
38163 You might want to turn off DKIM verification processing entirely for internal
38164 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38165 control modifier. This should typically be done in the RCPT ACL, at points
38166 where you accept mail from relay sources (internal hosts or authenticated
38167 senders).
38168
38169
38170 .section "Signing outgoing messages" "SECDKIMSIGN"
38171 .cindex "DKIM" "signing"
38172
38173 Signing is enabled by setting private options on the SMTP transport.
38174 These options take (expandable) strings as arguments.
38175
38176 .option dkim_domain smtp string&!! unset
38177 MANDATORY:
38178 The domain you want to sign with. The result of this expanded
38179 option is put into the &%$dkim_domain%& expansion variable.
38180
38181 .option dkim_selector smtp string&!! unset
38182 MANDATORY:
38183 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38184 variable to look up a matching selector. The result is put in the expansion
38185 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38186 option along with &%$dkim_domain%&.
38187
38188 .option dkim_private_key smtp string&!! unset
38189 MANDATORY:
38190 This sets the private key to use. You can use the &%$dkim_domain%& and
38191 &%$dkim_selector%& expansion variables to determine the private key to use.
38192 The result can either
38193 .ilist
38194 be a valid RSA private key in ASCII armor, including line breaks.
38195 .next
38196 start with a slash, in which case it is treated as a file that contains
38197 the private key.
38198 .next
38199 be "0", "false" or the empty string, in which case the message will not
38200 be signed. This case will not result in an error, even if &%dkim_strict%&
38201 is set.
38202 .endlist
38203
38204 .option dkim_canon smtp string&!! unset
38205 OPTIONAL:
38206 This option sets the canonicalization method used when signing a message.
38207 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38208 The option defaults to "relaxed" when unset. Note: the current implementation
38209 only supports using the same canonicalization method for both headers and body.
38210
38211 .option dkim_strict smtp string&!! unset
38212 OPTIONAL:
38213 This  option  defines  how  Exim  behaves  when  signing a message that
38214 should be signed fails for some reason.  When the expansion evaluates to
38215 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38216 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38217 variables here.
38218
38219 .option dkim_sign_headers smtp string&!! unset
38220 OPTIONAL:
38221 When set, this option must expand to (or be specified as) a colon-separated
38222 list of header names. Headers with these names will be included in the message
38223 signature. When unspecified, the header names recommended in RFC4871 will be
38224 used.
38225
38226
38227 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38228 .cindex "DKIM" "verification"
38229
38230 Verification of DKIM signatures in SMTP incoming email is implemented via the
38231 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38232 syntactically(!) correct signature in the incoming message.
38233 A missing ACL definition defaults to accept.
38234 If any ACL call does not accept, the message is not accepted.
38235 If a cutthrough delivery was in progress for the message it is
38236 summarily dropped (having wasted the transmission effort).
38237
38238 To evaluate the signature in the ACL a large number of expansion variables
38239 containing the signature status and its details are set up during the
38240 runtime of the ACL.
38241
38242 Calling the ACL only for existing signatures is not sufficient to build
38243 more advanced policies. For that reason, the global option
38244 &%dkim_verify_signers%&, and a global expansion variable
38245 &%$dkim_signers%& exist.
38246
38247 The global option &%dkim_verify_signers%& can be set to a colon-separated
38248 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38249 called. It is expanded when the message has been received. At this point,
38250 the expansion variable &%$dkim_signers%& already contains a colon-separated
38251 list of signer domains and identities for the message. When
38252 &%dkim_verify_signers%& is not specified in the main configuration,
38253 it defaults as:
38254 .code
38255 dkim_verify_signers = $dkim_signers
38256 .endd
38257 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38258 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38259 call the ACL for known domains or identities. This would be achieved as follows:
38260 .code
38261 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38262 .endd
38263 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38264 and "ebay.com", plus all domains and identities that have signatures in the message.
38265 You can also be more creative in constructing your policy. For example:
38266 .code
38267 dkim_verify_signers = $sender_address_domain:$dkim_signers
38268 .endd
38269
38270 If a domain or identity is listed several times in the (expanded) value of
38271 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38272
38273
38274 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38275 available (from most to least important):
38276
38277
38278 .vlist
38279 .vitem &%$dkim_cur_signer%&
38280 The signer that is being evaluated in this ACL run. This can be a domain or
38281 an identity. This is one of the list items from the expanded main option
38282 &%dkim_verify_signers%& (see above).
38283
38284 .vitem &%$dkim_verify_status%&
38285 A string describing the general status of the signature. One of
38286 .ilist
38287 &%none%&: There is no signature in the message for the current domain or
38288 identity (as reflected by &%$dkim_cur_signer%&).
38289 .next
38290 &%invalid%&: The signature could not be verified due to a processing error.
38291 More detail is available in &%$dkim_verify_reason%&.
38292 .next
38293 &%fail%&: Verification of the signature failed.  More detail is
38294 available in &%$dkim_verify_reason%&.
38295 .next
38296 &%pass%&: The signature passed verification. It is valid.
38297 .endlist
38298
38299 .vitem &%$dkim_verify_reason%&
38300 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38301 "fail" or "invalid". One of
38302 .ilist
38303 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38304 key for the domain could not be retrieved. This may be a temporary problem.
38305 .next
38306 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38307 record for the domain is syntactically invalid.
38308 .next
38309 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38310 body hash does not match the one specified in the signature header. This
38311 means that the message body was modified in transit.
38312 .next
38313 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38314 could not be verified. This may mean that headers were modified,
38315 re-written or otherwise changed in a way which is incompatible with
38316 DKIM verification. It may of course also mean that the signature is forged.
38317 .endlist
38318
38319 .vitem &%$dkim_domain%&
38320 The signing domain. IMPORTANT: This variable is only populated if there is
38321 an actual signature in the message for the current domain or identity (as
38322 reflected by &%$dkim_cur_signer%&).
38323
38324 .vitem &%$dkim_identity%&
38325 The signing identity, if present. IMPORTANT: This variable is only populated
38326 if there is an actual signature in the message for the current domain or
38327 identity (as reflected by &%$dkim_cur_signer%&).
38328
38329 .vitem &%$dkim_selector%&
38330 The key record selector string.
38331
38332 .vitem &%$dkim_algo%&
38333 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38334
38335 .vitem &%$dkim_canon_body%&
38336 The body canonicalization method. One of 'relaxed' or 'simple'.
38337
38338 .vitem &%dkim_canon_headers%&
38339 The header canonicalization method. One of 'relaxed' or 'simple'.
38340
38341 .vitem &%$dkim_copiedheaders%&
38342 A transcript of headers and their values which are included in the signature
38343 (copied from the 'z=' tag of the signature).
38344 .new
38345 Note that RFC6376 requires that verification fail if the From: header is
38346 not included in the signature.  Exim does not enforce this; sites wishing
38347 strict enforcement should code the check explicitly.
38348 .wen
38349
38350 .vitem &%$dkim_bodylength%&
38351 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38352 limit was set by the signer, "9999999999999" is returned. This makes sure
38353 that this variable always expands to an integer value.
38354
38355 .vitem &%$dkim_created%&
38356 UNIX timestamp reflecting the date and time when the signature was created.
38357 When this was not specified by the signer, "0" is returned.
38358
38359 .vitem &%$dkim_expires%&
38360 UNIX timestamp reflecting the date and time when the signer wants the
38361 signature to be treated as "expired". When this was not specified by the
38362 signer, "9999999999999" is returned. This makes it possible to do useful
38363 integer size comparisons against this value.
38364
38365 .vitem &%$dkim_headernames%&
38366 A colon-separated list of names of headers included in the signature.
38367
38368 .vitem &%$dkim_key_testing%&
38369 "1" if the key record has the "testing" flag set, "0" if not.
38370
38371 .vitem &%$dkim_key_nosubdomains%&
38372 "1" if the key record forbids subdomaining, "0" otherwise.
38373
38374 .vitem &%$dkim_key_srvtype%&
38375 Service type (tag s=) from the key record. Defaults to "*" if not specified
38376 in the key record.
38377
38378 .vitem &%$dkim_key_granularity%&
38379 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38380 in the key record.
38381
38382 .vitem &%$dkim_key_notes%&
38383 Notes from the key record (tag n=).
38384
38385 .vitem &%$dkim_key_length%&
38386 Number of bits in the key.
38387 .endlist
38388
38389 In addition, two ACL conditions are provided:
38390
38391 .vlist
38392 .vitem &%dkim_signers%&
38393 ACL condition that checks a colon-separated list of domains or identities
38394 for a match against the domain or identity that the ACL is currently verifying
38395 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38396 verb to a group of domains or identities. For example:
38397
38398 .code
38399 # Warn when Mail purportedly from GMail has no gmail signature
38400 warn log_message = GMail sender without gmail.com DKIM signature
38401      sender_domains = gmail.com
38402      dkim_signers = gmail.com
38403      dkim_status = none
38404 .endd
38405
38406 .new
38407 Note that the above does not check for a total lack of DKIM signing;
38408 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38409 .wen
38410
38411 .vitem &%dkim_status%&
38412 ACL condition that checks a colon-separated list of possible DKIM verification
38413 results against the actual result of verification. This is typically used
38414 to restrict an ACL verb to a list of verification outcomes, for example:
38415
38416 .code
38417 deny message = Mail from Paypal with invalid/missing signature
38418      sender_domains = paypal.com:paypal.de
38419      dkim_signers = paypal.com:paypal.de
38420      dkim_status = none:invalid:fail
38421 .endd
38422
38423 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38424 see the documentation of the &%$dkim_verify_status%& expansion variable above
38425 for more information of what they mean.
38426 .endlist
38427
38428 . ////////////////////////////////////////////////////////////////////////////
38429 . ////////////////////////////////////////////////////////////////////////////
38430
38431 .chapter "Proxies" "CHAPproxies" &&&
38432          "Proxy support"
38433 .cindex "proxy support"
38434 .cindex "proxy" "access via"
38435
38436 A proxy is an intermediate system through which communication is passed.
38437 Proxies may provide a security, availability or load-distribution function.
38438
38439
38440 .section "Inbound proxies" SECTproxyInbound
38441 .cindex proxy inbound
38442 .cindex proxy "server side"
38443 .cindex proxy "Proxy protocol"
38444 .cindex "Proxy protocol" proxy
38445
38446 Exim has support for receiving inbound SMTP connections via a proxy
38447 that uses &"Proxy Protocol"& to speak to it.
38448 To include this support, include &"SUPPORT_PROXY=yes"&
38449 in Local/Makefile.
38450
38451 It was built on specifications from:
38452 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38453 That URL was revised in May 2014 to version 2 spec:
38454 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38455
38456 The purpose of this facility is so that an application load balancer,
38457 such as HAProxy, can sit in front of several Exim servers
38458 to distribute load.
38459 Exim uses the local protocol communication with the proxy to obtain
38460 the remote SMTP system IP address and port information.
38461 There is no logging if a host passes or
38462 fails Proxy Protocol negotiation, but it can easily be determined and
38463 recorded in an ACL (example is below).
38464
38465 Use of a proxy is enabled by setting the &%hosts_proxy%&
38466 main configuration option to a hostlist; connections from these
38467 hosts will use Proxy Protocol.
38468
38469 .new
38470 The following expansion variables are usable
38471 (&"internal"& and &"external"& here refer to the interfaces
38472 of the proxy):
38473 .display
38474 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38475 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38476 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38477 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38478 &'proxy_session        '& boolean: SMTP connection via proxy
38479 .endd
38480 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38481 there was a protocol error.
38482 .wen
38483
38484 Since the real connections are all coming from the proxy, and the
38485 per host connection tracking is done before Proxy Protocol is
38486 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38487 handle all of the parallel volume you expect per inbound proxy.
38488 With the option set so high, you lose the ability
38489 to protect your server from many connections from one IP.
38490 In order to prevent your server from overload, you
38491 need to add a per connection ratelimit to your connect ACL.
38492 A possible solution is:
38493 .display
38494   # Set max number of connections per host
38495   LIMIT   = 5
38496   # Or do some kind of IP lookup in a flat file or database
38497   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38498
38499   defer   message        = Too many connections from this IP right now
38500           ratelimit      = LIMIT / 5s / per_conn / strict
38501 .endd
38502
38503
38504
38505 .section "Outbound proxies" SECTproxySOCKS
38506 .cindex proxy outbound
38507 .cindex proxy "client side"
38508 .cindex proxy SOCKS
38509 .cindex SOCKS proxy
38510 Exim has support for sending outbound SMTP via a proxy
38511 using a protocol called SOCKS5 (defined by RFC1928).
38512 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38513 Local/Makefile.
38514
38515 Use of a proxy is enabled by setting the &%socks_proxy%& option
38516 on an smtp transport.
38517 The option value is expanded and should then be a list
38518 (colon-separated by default) of proxy specifiers.
38519 Each proxy specifier is a list
38520 (space-separated by default) where the initial element
38521 is an IP address and any subsequent elements are options.
38522
38523 Options are a string <name>=<value>.
38524 The list of options is in the following table:
38525 .display
38526 &'auth   '& authentication method
38527 &'name   '& authentication username
38528 &'pass   '& authentication password
38529 &'port   '& tcp port
38530 &'tmo    '& connection timeout
38531 &'pri    '& priority
38532 &'weight '& selection bias
38533 .endd
38534
38535 More details on each of these options follows:
38536
38537 .ilist
38538 .cindex authentication "to proxy"
38539 .cindex proxy authentication
38540 &%auth%&: Either &"none"& (default) or &"name"&.
38541 Using &"name"& selects username/password authentication per RFC 1929
38542 for access to the proxy.
38543 Default is &"none"&.
38544 .next
38545 &%name%&: sets the username for the &"name"& authentication method.
38546 Default is empty.
38547 .next
38548 &%pass%&: sets the password for the &"name"& authentication method.
38549 Default is empty.
38550 .next
38551 &%port%&: the TCP port number to use for the connection to the proxy.
38552 Default is 1080.
38553 .next
38554 &%tmo%&: sets a connection timeout in seconds for this proxy.
38555 Default is 5.
38556 .next
38557 &%pri%&: specifies a priority for the proxy within the list,
38558 higher values being tried first.
38559 The default priority is 1.
38560 .next
38561 &%weight%&: specifies a selection bias.
38562 Within a priority set servers are queried in a random fashion,
38563 weighted by this value.
38564 The default value for selection bias is 1.
38565 .endlist
38566
38567 Proxies from the list are tried according to their priority
38568 and weight settings until one responds.  The timeout for the
38569 overall connection applies to the set of proxied attempts.
38570
38571 .section Logging SECTproxyLog
38572 To log the (local) IP of a proxy in the incoming or delivery logline,
38573 add &"+proxy"& to the &%log_selector%& option.
38574 This will add a component tagged with &"PRX="& to the line.
38575
38576 . ////////////////////////////////////////////////////////////////////////////
38577 . ////////////////////////////////////////////////////////////////////////////
38578
38579 .chapter "Internationalisation" "CHAPi18n" &&&
38580          "Internationalisation""
38581 .cindex internationalisation "email address"
38582 .cindex EAI
38583 .cindex i18n
38584 .cindex UTF-8 "mail name handling"
38585
38586 Exim has support for Internationalised mail names.
38587 To include this it must be built with SUPPORT_I18N and the libidn library.
38588 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38589
38590 .section "MTA operations" SECTi18nMTA
38591 .cindex SMTPUTF8 "ESMTP option"
38592 The main configuration option &%smtputf8_advertise_hosts%& specifies
38593 a host list.  If this matches the sending host and
38594 accept_8bitmime is true (the default) then the ESMTP option
38595 SMTPUTF8 will be advertised.
38596
38597 If the sender specifies the SMTPUTF8 option on a MAIL command
38598 international handling for the message is enabled and
38599 the expansion variable &$message_smtputf8$& will have value TRUE.
38600
38601 The option &%allow_utf8_domains%& is set to true for this
38602 message. All DNS lookups are converted to a-label form
38603 whatever the setting of &%allow_utf8_domains%&
38604 when Exim is built with SUPPORT_I18N.
38605
38606 Both localparts and domain are maintained as the original
38607 UTF-8 form internally; any comparison or regular-expression use will
38608 require appropriate care.  Filenames created, eg. by
38609 the appendfile transport, will have UTF-8 names.
38610
38611 HELO names sent by the smtp transport will have any UTF-8
38612 components expanded to a-label form,
38613 and any certificate name checks will be done using the a-label
38614 form of the name.
38615
38616 .cindex log protocol
38617 .cindex SMTPUTF8 logging
38618 Log lines and Received-by: header lines will acquire a "utf8"
38619 prefix on the protocol element, eg. utf8esmtp.
38620
38621 The following expansion operators can be used:
38622 .code
38623 ${utf8_domain_to_alabel:str}
38624 ${utf8_domain_from_alabel:str}
38625 ${utf8_localpart_to_alabel:str}
38626 ${utf8_localpart_from_alabel:str}
38627 .endd
38628
38629 ACLs may use the following modifier:
38630 .display
38631 control = utf8_downconvert
38632 control = utf8_downconvert/<value>
38633 .endd
38634 This sets a flag requiring that addresses are converted to
38635 a-label form before smtp delivery, for use in a
38636 Message Submission Agent context.
38637 If a value is appended it may be:
38638 .display
38639 &`1  `& (default) mandatory downconversion
38640 &`0  `& no downconversion
38641 &`-1 `& if SMTPUTF8 not supported by destination host
38642 .endd
38643
38644 If mua_wrapper is set, the utf8_downconvert control
38645 is initially set to -1.
38646
38647
38648 There is no explicit support for VRFY and EXPN.
38649 Configurations supporting these should inspect
38650 &$smtp_command_argument$& for an SMTPUTF8 argument.
38651
38652 There is no support for LMTP on Unix sockets.
38653 Using the "lmtp" protocol option on an smtp transport,
38654 for LMTP over TCP, should work as expected.
38655
38656 There is no support for DSN unitext handling,
38657 and no provision for converting logging from or to UTF-8.
38658
38659
38660
38661 .section "MDA operations" SECTi18nMDA
38662 To aid in constructing names suitable for IMAP folders
38663 the following expansion operator can be used:
38664 .code
38665 ${imapfolder {<string>} {<sep>} {<specials>}}
38666 .endd
38667
38668 The string is converted from the charset specified by
38669 the "headers charset" command (in a filter file)
38670 or &%headers_charset%& main configuration option (otherwise),
38671 to the
38672 modified UTF-7 encoding specified by RFC 2060,
38673 with the following exception: All occurences of <sep>
38674 (which has to be a single character)
38675 are replaced with periods ("."), and all periods and slashes that are not
38676 <sep> and are not in the <specials> string are BASE64 encoded.
38677
38678 The third argument can be omitted, defaulting to an empty string.
38679 The second argument can be omitted, defaulting to "/".
38680
38681 This is the encoding used by Courier for Maildir names on disk, and followed
38682 by many other IMAP servers.
38683
38684 Examples:
38685 .display
38686 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38687 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38688 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38689 .endd
38690
38691 Note that the source charset setting is vital, and also that characters
38692 must be representable in UTF-16.
38693
38694
38695 . ////////////////////////////////////////////////////////////////////////////
38696 . ////////////////////////////////////////////////////////////////////////////
38697
38698 .chapter "Events" "CHAPevents" &&&
38699          "Events"
38700 .cindex events
38701
38702 The events mechanism in Exim can be used to intercept processing at a number
38703 of points.  It was originally invented to giave a way to do customised logging
38704 actions (for example, to a database) but can also be used to modify some
38705 processing actions.
38706
38707 Most installations will never need to use Events.
38708 The support can be left out of a build by defining DISABLE_EVENT=yes
38709 in &_Local/Makefile_&.
38710
38711 There are two major classes of events: main and transport.
38712 The main configuration option &%event_action%& controls reception events;
38713 a transport option &%event_action%& controls delivery events.
38714
38715 Both options are a string which is expanded when the event fires.
38716 An example might look like:
38717 .cindex logging custom
38718 .code
38719 event_action = ${if eq {msg:delivery}{$event_name} \
38720 {${lookup pgsql {SELECT * FROM record_Delivery( \
38721     '${quote_pgsql:$sender_address_domain}',\
38722     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38723     '${quote_pgsql:$domain}', \
38724     '${quote_pgsql:${lc:$local_part}}', \
38725     '${quote_pgsql:$host_address}', \
38726     '${quote_pgsql:${lc:$host}}', \
38727     '${quote_pgsql:$message_exim_id}')}} \
38728 } {}}
38729 .endd
38730
38731 Events have names which correspond to the point in process at which they fire.
38732 The name is placed in the variable &$event_name$& and the event action
38733 expansion must check this, as it will be called for every possible event type.
38734
38735 The current list of events is:
38736 .display
38737 &`msg:complete           after    main       `& per message
38738 &`msg:delivery           after    transport  `& per recipient
38739 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38740 &`msg:rcpt:defer         after    transport  `& per recipient
38741 &`msg:host:defer         after    transport  `& per attempt
38742 &`msg:fail:delivery      after    main       `& per recipient
38743 &`msg:fail:internal      after    main       `& per recipient
38744 &`tcp:connect            before   transport  `& per connection
38745 &`tcp:close              after    transport  `& per connection
38746 &`tls:cert               before   both       `& per certificate in verification chain
38747 &`smtp:connect           after    transport  `& per connection
38748 .endd
38749 New event types may be added in future.
38750
38751 The event name is a colon-separated list, defining the type of
38752 event in a tree of possibilities.  It may be used as a list
38753 or just matched on as a whole.  There will be no spaces in the name.
38754
38755 The second column in the table above describes whether the event fires
38756 before or after the action is associates with.  Those which fire before
38757 can be used to affect that action (more on this below).
38758
38759 An additional variable, &$event_data$&, is filled with information varying
38760 with the event type:
38761 .display
38762 &`msg:delivery         `& smtp confirmation mssage
38763 &`msg:rcpt:host:defer  `& error string
38764 &`msg:rcpt:defer       `& error string
38765 &`msg:host:defer       `& error string
38766 &`tls:cert             `& verification chain depth
38767 &`smtp:connect         `& smtp banner
38768 .endd
38769
38770 The :defer events populate one extra variable: &$event_defer_errno$&.
38771
38772 For complex operations an ACL expansion can be used in &%event_action%&
38773 however due to the multiple contextx that Exim operates in during
38774 the course of its processing:
38775 .ilist
38776 variables set in transport events will not be visible outside that
38777 transport call
38778 .next
38779 acl_m variables in a server context are lost on a new connection,
38780 and after smtp helo/ehlo/mail/starttls/rset commands
38781 .endlist
38782 Using an ACL expansion with the logwrite modifier can be
38783 a useful way of writing to the main log.
38784
38785 The expansion of the event_action option should normally
38786 return an empty string.  Should it return anything else the
38787 following will be forced:
38788 .display
38789 &`msg:delivery     `&  (ignored)
38790 &`msg:host:defer   `&  (ignored)
38791 &`msg:fail:delivery`&  (ignored)
38792 &`tcp:connect      `&  do not connect
38793 &`tcp:close        `&  (ignored)
38794 &`tls:cert         `&  refuse verification
38795 &`smtp:connect     `&  close connection
38796 .endd
38797 No other use is made of the result string.
38798
38799 For a tcp:connect event, if the connection is being made to a proxy
38800 then the address and port variables will be that of the proxy and not
38801 the target system.
38802
38803 For tls:cert events, if GnuTLS is in use this will trigger only per
38804 chain element received on the connection.
38805 For OpenSSL it will trigger for every chain element including those
38806 loaded locally.
38807
38808 . ////////////////////////////////////////////////////////////////////////////
38809 . ////////////////////////////////////////////////////////////////////////////
38810
38811 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38812          "Adding drivers or lookups"
38813 .cindex "adding drivers"
38814 .cindex "new drivers, adding"
38815 .cindex "drivers" "adding new"
38816 The following actions have to be taken in order to add a new router, transport,
38817 authenticator, or lookup type to Exim:
38818
38819 .olist
38820 Choose a name for the driver or lookup type that does not conflict with any
38821 existing name; I will use &"newdriver"& in what follows.
38822 .next
38823 Add to &_src/EDITME_& the line:
38824 .display
38825 <&'type'&>&`_NEWDRIVER=yes`&
38826 .endd
38827 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38828 code is not to be included in the binary by default, comment this line out. You
38829 should also add any relevant comments about the driver or lookup type.
38830 .next
38831 Add to &_src/config.h.defaults_& the line:
38832 .code
38833 #define <type>_NEWDRIVER
38834 .endd
38835 .next
38836 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38837 and create a table entry as is done for all the other drivers and lookup types.
38838 .next
38839 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38840 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38841 Add your &`NEWDRIVER`& to that list.
38842 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38843 simple form that most lookups have.
38844 .next
38845 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38846 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38847 driver or lookup type and add it to the definition of OBJ.
38848 .next
38849 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38850 &_src_&.
38851 .next
38852 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38853 as for other drivers and lookups.
38854 .endlist
38855
38856 Then all you need to do is write the code! A good way to start is to make a
38857 proforma by copying an existing module of the same type, globally changing all
38858 occurrences of the name, and cutting out most of the code. Note that any
38859 options you create must be listed in alphabetical order, because the tables are
38860 searched using a binary chop procedure.
38861
38862 There is a &_README_& file in each of the sub-directories of &_src_& describing
38863 the interface that is expected.
38864
38865
38866
38867
38868 . ////////////////////////////////////////////////////////////////////////////
38869 . ////////////////////////////////////////////////////////////////////////////
38870
38871 . /////////////////////////////////////////////////////////////////////////////
38872 . These lines are processing instructions for the Simple DocBook Processor that
38873 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38874 . PDFs than using xmlto and fop. They will be ignored by all other XML
38875 . processors.
38876 . /////////////////////////////////////////////////////////////////////////////
38877
38878 .literal xml
38879 <?sdop
38880   format="newpage"
38881   foot_right_recto="&chaptertitle;"
38882   foot_right_verso="&chaptertitle;"
38883 ?>
38884 .literal off
38885
38886 .makeindex "Options index"   "option"
38887 .makeindex "Variables index" "variable"
38888 .makeindex "Concept index"   "concept"
38889
38890
38891 . /////////////////////////////////////////////////////////////////////////////
38892 . /////////////////////////////////////////////////////////////////////////////