Fix build with DISABLE_EVENT (proper spelling)
[exim.git] / doc / doc-docbook / filter.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the document that describes Exim's filtering
3 . facilities. It is an xfpt document that is converted into DocBook XML for
4 . subsequent conversion into printing and online formats. The markup used
5 . herein is "standard" xfpt markup, with some extras. The markup is summarized
6 . in a file called Markup.txt.
7 . /////////////////////////////////////////////////////////////////////////////
8
9 .include stdflags
10 .include stdmacs
11 .include ./local_params
12 .docbook
13
14 . /////////////////////////////////////////////////////////////////////////////
15 . These lines are processing instructions for the Simple DocBook Processor that
16 . Philip Hazel has developed as a less cumbersome way of making PostScript and
17 . PDFs than using xmlto and fop. They will be ignored by all other XML
18 . processors.
19 . /////////////////////////////////////////////////////////////////////////////
20
21 .literal xml
22 <?sdop
23   foot_right_recto="&chaptertitle;"
24   foot_right_verso="&chaptertitle;"
25   table_warn_overflow="overprint"
26   toc_chapter_blanks="yes,yes"
27   toc_title="Exim's interfaces to mail filtering"
28 ?>
29 .literal off
30
31 .book
32
33 . ===========================================================================
34 . Additional xfpt markup used by this document, over and above the default
35 . provided in the xfpt library.
36
37 . Override the &$ flag to automatically insert a $ with the variable name
38
39 .flag &$  $&   "<varname>$"  "</varname>"
40
41 . A macro for the common 2-column tables
42
43 .macro table2 100pt 300pt
44 .itable none 0 0 2 $1 left $2 left
45 .endmacro
46 . ===========================================================================
47
48 . Copyright year.  Update this (only) when changing content.
49
50 .macro copyyear
51 2023
52 .endmacro
53
54 . ===========================================================================
55
56 . /////////////////////////////////////////////////////////////////////////////
57 . /////////////////////////////////////////////////////////////////////////////
58
59 . This preliminary stuff creates a <bookinfo> entry in the XML. This is removed
60 . when creating the PostScript/PDF output, because we do not want a full-blown
61 . title page created for those versions. When fop is being used to create
62 . PS/PDF, the stylesheet fudges up a title line to replace the text "Table of
63 . contents". When SDoP is being used, a processing instruction does this job.
64 . For the other forms of output, the <bookinfo> element is retained and used.
65
66 .literal xml
67 <bookinfo>
68 <title>Exim's interfaces to mail filtering</title>
69 <titleabbrev>Exim filtering</titleabbrev>
70 <date>
71 .fulldate
72 </date>
73 <author><firstname>Philip</firstname><surname>Hazel</surname></author>
74 <authorinitials>PH</authorinitials>
75 <revhistory><revision>
76 .versiondatexml
77   <authorinitials>PH</authorinitials>
78 </revision></revhistory>
79 <copyright><year>
80 .copyyear
81            </year><holder>The Exim Maintainers</holder></copyright>
82 </bookinfo>
83 .literal off
84
85 . /////////////////////////////////////////////////////////////////////////////
86 . /////////////////////////////////////////////////////////////////////////////
87
88
89 .chapter "Forwarding and filtering in Exim" "CHAPforandfilt"
90 This document describes the user interfaces to Exim's in-built mail filtering
91 facilities, and is copyright &copy; The Exim Maintainers &copyyear(). It
92 corresponds to Exim version &version().
93
94
95
96 .section "Introduction" "SEC00"
97 Most Unix mail transfer agents (programs that deliver mail) permit individual
98 users to specify automatic forwarding of their mail, usually by placing a list
99 of forwarding addresses in a file called &_.forward_& in their home
100 directories. Exim extends this facility by allowing the forwarding instructions
101 to be a set of rules rather than just a list of addresses, in effect providing
102 &"&_.forward_& with conditions"&. Operating the set of rules is called
103 &'filtering'&, and the file that contains them is called a &'filter file'&.
104
105 Exim supports two different kinds of filter file. An &'Exim filter'& contains
106 instructions in a format that is unique to Exim. A &'Sieve filter'& contains
107 instructions in the Sieve format that is defined by RFC 3028. As this is a
108 standard format, Sieve filter files may already be familiar to some users.
109 Sieve files should also be portable between different environments. However,
110 the Exim filtering facility contains more features (such as variable
111 expansion), and better integration with the host environment (such as the use
112 of external processes and pipes).
113
114 The choice of which kind of filter to use can be left to the end-user, provided
115 that the system administrator has configured Exim appropriately for both kinds
116 of filter. However, if interoperability is important, Sieve is the only
117 choice.
118
119 The ability to use filtering or traditional forwarding has to be enabled by the
120 system administrator, and some of the individual facilities can be separately
121 enabled or disabled. A local document should be provided to describe exactly
122 what has been enabled. In the absence of this, consult your system
123 administrator.
124
125 This document describes how to use a filter file and the format of its
126 contents. It is intended for use by end-users. Both Sieve filters and Exim
127 filters are covered. However, for Sieve filters, only issues that relate to the
128 Exim implementation are discussed, since Sieve itself is described elsewhere.
129
130 The contents of traditional &_.forward_& files are not described here. They
131 normally contain just a list of addresses, file names, or pipe commands,
132 separated by commas or newlines, but other types of item are also available.
133 The full details can be found in the chapter on the &(redirect)& router in the
134 Exim specification, which also describes how the system administrator can set
135 up and control the use of filtering.
136
137
138
139 .section "Filter operation" "SEC01"
140 It is important to realize that, in Exim, no deliveries are actually made while
141 a filter or traditional &_.forward_& file is being processed. Running a filter
142 or processing a traditional &_.forward_& file sets up future delivery
143 operations, but does not carry them out.
144
145 The result of filter or &_.forward_& file processing is a list of destinations
146 to which a message should be delivered. The deliveries themselves take place
147 later, along with all other deliveries for the message. This means that it is
148 not possible to test for successful deliveries while filtering. It also means
149 that any duplicate addresses that are generated are dropped, because Exim never
150 delivers the same message to the same address more than once.
151
152
153
154
155 .section "Testing a new filter file" "SECTtesting"
156 Filter files, especially the more complicated ones, should always be tested, as
157 it is easy to make mistakes. Exim provides a facility for preliminary testing
158 of a filter file before installing it. This tests the syntax of the file and
159 its basic operation, and can also be used with traditional &_.forward_& files.
160
161 Because a filter can do tests on the content of messages, a test message is
162 required. Suppose you have a new filter file called &_myfilter_& and a test
163 message in a file called &_test-message_&. Assuming that Exim is installed with
164 the conventional path name &_/usr/sbin/sendmail_& (some operating systems use
165 &_/usr/lib/sendmail_&), the following command can be used:
166 .code
167 /usr/sbin/sendmail -bf myfilter <test-message
168 .endd
169 The &%-bf%& option tells Exim that the following item on the command line is
170 the name of a filter file that is to be tested. There is also a &%-bF%& option,
171 which is similar, but which is used for testing system filter files, as opposed
172 to user filter files, and which is therefore of use only to the system
173 administrator.
174
175 The test message is supplied on the standard input. If there are no
176 message-dependent tests in the filter, an empty file (&_/dev/null_&) can be
177 used. A supplied message must start with header lines or the &"From&~"& message
178 separator line that is found in many multi-message folder files. Note that
179 blank lines at the start terminate the header lines. A warning is given if no
180 header lines are read.
181
182 The result of running this command, provided no errors are detected in the
183 filter file, is a list of the actions that Exim would try to take if presented
184 with the message for real. For example, for an Exim filter, the output
185 .code
186 Deliver message to: gulliver@lilliput.fict.example
187 Save message to: /home/lemuel/mail/archive
188 .endd
189 means that one copy of the message would be sent to
190 &'gulliver@lilliput.fict.example'&, and another would be added to the file
191 &_/home/lemuel/mail/archive_&, if all went well.
192
193 The actions themselves are not attempted while testing a filter file in this
194 way; there is no check, for example, that any forwarding addresses are valid.
195 For an Exim filter, if you want to know why a particular action is being taken,
196 add the &%-v%& option to the command. This causes Exim to output the results of
197 any conditional tests and to indent its output according to the depth of
198 nesting of &(if)& commands. Further additional output from a filter test can be
199 generated by the &(testprint)& command, which is described below.
200
201 When Exim is outputting a list of the actions it would take, if any text
202 strings are included in the output, non-printing characters therein are
203 converted to escape sequences. In particular, if any text string contains a
204 newline character, this is shown as &"\n"& in the testing output.
205
206 When testing a filter in this way, Exim makes up an &"envelope"& for the
207 message. The recipient is by default the user running the command, and so is
208 the sender, but the command can be run with the &%-f%& option to supply a
209 different sender. For example,
210 .code
211 /usr/sbin/sendmail -bf myfilter \
212    -f islington@never.where <test-message
213 .endd
214 Alternatively, if the &%-f%& option is not used, but the first line of the
215 supplied message is a &"From&~"& separator from a message folder file (not the
216 same thing as a &'From:'& header line), the sender is taken from there. If
217 &%-f%& is present, the contents of any &"From&~"& line are ignored.
218
219 The &"return path"& is the same as the envelope sender, unless the message
220 contains a &'Return-path:'& header, in which case it is taken from there. You
221 need not worry about any of this unless you want to test out features of a
222 filter file that rely on the sender address or the return path.
223
224 It is possible to change the envelope recipient by specifying further options.
225 The &%-bfd%& option changes the domain of the recipient address, while the
226 &%-bfl%& option changes the &"local part"&, that is, the part before the @
227 sign. An adviser could make use of these to test someone else's filter file.
228
229 The &%-bfp%& and &%-bfs%& options specify the prefix or suffix for the local
230 part. These are relevant only when support for multiple personal mailboxes is
231 implemented; see the description in section &<<SECTmbox>>& below.
232
233
234 .section "Installing a filter file" "SEC02"
235 A filter file is normally installed under the name &_.forward_& in your home
236 directory &-- it is distinguished from a conventional &_.forward_& file by its
237 first line (described below). However, the file name is configurable, and some
238 system administrators may choose to use some different name or location for
239 filter files.
240
241
242 .section "Testing an installed filter file" "SEC03"
243 Testing a filter file before installation cannot find every potential problem;
244 for example, it does not actually run commands to which messages are piped.
245 Some &"live"& tests should therefore also be done once a filter is installed.
246
247 If at all possible, test your filter file by sending messages from some other
248 account. If you send a message to yourself from the filtered account, and
249 delivery fails, the error message will be sent back to the same account, which
250 may cause another delivery failure. It won't cause an infinite sequence of such
251 messages, because delivery failure messages do not themselves generate further
252 messages. However, it does mean that the failure won't be returned to you, and
253 also that the postmaster will have to investigate the stuck message.
254
255 If you have to test an Exim filter from the same account, a sensible precaution
256 is to include the line
257 .code
258 if error_message then finish endif
259 .endd
260 as the first filter command, at least while testing. This causes filtering to
261 be abandoned for a delivery failure message, and since no destinations are
262 generated, the message goes on to be delivered to the original address. Unless
263 there is a good reason for not doing so, it is recommended that the above test
264 be left in all Exim filter files. (This does not apply to Sieve files.)
265
266
267
268 .section "Details of filtering commands" "SEC04"
269 The filtering commands for Sieve and Exim filters are completely different in
270 syntax and semantics. The Sieve mechanism is defined in RFC 3028; in the next
271 chapter we describe how it is integrated into Exim. The subsequent chapter
272 covers Exim filtering commands in detail.
273
274
275
276 .chapter "Sieve filter files" "CHAPsievefilter"
277 The code for Sieve filtering in Exim was contributed by Michael Haardt, and
278 most of the content of this chapter is taken from the notes he provided. Since
279 Sieve is an extensible language, it is important to understand &"Sieve"& in
280 this context as &"the specific implementation of Sieve for Exim"&.
281
282 This chapter does not contain a description of Sieve, since that can be found
283 in RFC 3028, which should be read in conjunction with these notes.
284
285 The Exim Sieve implementation offers the core as defined by RFC 3028,
286 comparison tests, the subaddress parameter, the &*copy*&, &*envelope*&,
287 &*fileinto*&, &*notify*&, and &*vacation*& extensions, but not the &*reject*&
288 extension.
289 .new
290 Exim did not support message delivery notifications (MDNs) when Sieve handling
291 was introduced, so &*reject*& (which need them) could not be supported.
292 .wen
293
294 In order for Sieve to work properly in Exim, the system administrator needs to
295 make some adjustments to the Exim configuration. These are described in the
296 chapter on the &(redirect)& router in the full Exim specification.
297
298
299 .section "Recognition of Sieve filters" "SEC05"
300 A filter file is interpreted as a Sieve filter if its first line is
301 .code
302 # Sieve filter
303 .endd
304 This is what distinguishes it from a conventional &_.forward_& file or an Exim
305 filter file.
306
307
308
309 .section "Saving to specified folders" "SEC06"
310 If the system administrator has set things up as suggested in the Exim
311 specification, and you use &(keep)& or &(fileinto)& to save a mail into a
312 folder, absolute files are stored where specified, relative files are stored
313 relative to &$home$&, and &_inbox_& goes to the standard mailbox location.
314
315
316
317 .section "Strings containing header names" "SEC07"
318 RFC 3028 does not specify what happens if a string denoting a header field does
319 not contain a valid header name, for example, it contains a colon. This
320 implementation generates an error instead of ignoring the header field in order
321 to ease script debugging, which fits in with the common picture of Sieve.
322
323
324
325 .section "Exists test with empty list of headers" "SEC08"
326 The &*exists*& test succeeds only if all the specified headers exist. RFC 3028
327 does not explicitly specify what happens on an empty list of headers. This
328 implementation evaluates that condition as true, interpreting the RFC in a
329 strict sense.
330
331
332
333 .section "Header test with invalid MIME encoding in header" "SEC09"
334 Some MUAs process invalid base64 encoded data, generating junk. Others ignore
335 junk after seeing an equal sign in base64 encoded data. RFC 2047 does not
336 specify how to react in this case, other than stating that a client must not
337 forbid to process a message for that reason. RFC 2045 specifies that invalid
338 data should be ignored (apparently looking at end of line characters). It also
339 specifies that invalid data may lead to rejecting messages containing them (and
340 there it appears to talk about true encoding violations), which is a clear
341 contradiction to ignoring them.
342
343 RFC 3028 does not specify how to process incorrect MIME words. This
344 implementation treats them literally, as it does if the word is correct but its
345 character set cannot be converted to UTF-8.
346
347
348
349 .section "Address test for multiple addresses per header" "SEC10"
350 A header may contain multiple addresses. RFC 3028 does not explicitly specify
351 how to deal with them, but since the address test checks if anything matches
352 anything else, matching one address suffices to satisfy the condition. That
353 makes it impossible to test if a header contains a certain set of addresses and
354 no more, but it is more logical than letting the test fail if the header
355 contains an additional address besides the one the test checks for.
356
357
358
359 .section "Semantics of keep" "SEC11"
360 The &(keep)& command is equivalent to
361 .code
362 fileinto "inbox";
363 .endd
364 It saves the message and resets the implicit keep flag. It does not set the
365 implicit keep flag; there is no command to set it once it has been reset.
366
367
368
369 .section "Semantics of fileinto" "SEC12"
370 RFC 3028 does not specify whether &(fileinto)& should try to create a mail
371 folder if it does not exist. This implementation allows the sysadmin to
372 configure that aspect using the &(appendfile)& transport options
373 &%create_directory%&, &%create_file%&, and &%file_must_exist%&. See the
374 &(appendfile)& transport in the Exim specification for details.
375
376
377
378 .section "Semantics of redirect" "SEC13"
379 Sieve scripts are supposed to be interoperable between servers, so this
380 implementation does not allow mail to be redirected to unqualified addresses,
381 because the domain would depend on the system being used. On systems with
382 virtual mail domains, the default domain is probably not what the user expects
383 it to be.
384
385
386
387 .section "String arguments" "SEC14"
388 There has been confusion if the string arguments to &(require)& are to be
389 matched case-sensitively or not. This implementation matches them with the
390 match type &(:is)& (default, see section 2.7.1 of the RFC) and the comparator
391 &(i;ascii-casemap)& (default, see section 2.7.3 of the RFC). The RFC defines
392 the command defaults clearly, so any different implementations violate RFC
393 3028. The same is valid for comparator names, also specified as strings.
394
395
396
397 .section "Number units" "SEC15"
398 There is a mistake in RFC 3028: the suffix G denotes gibi-, not tebibyte.
399 The mistake is obvious, because RFC 3028 specifies G to denote 2^30
400 (which is gibi, not tebi), and that is what this implementation uses as
401 the scaling factor for the suffix G.
402
403
404
405 .section "RFC compliance" "SEC16"
406 Exim requires the first line of a Sieve filter to be
407 .code
408 # Sieve filter
409 .endd
410 Of course the RFC does not specify that line. Do not expect examples to work
411 without adding it, though.
412
413 RFC 3028 requires the use of CRLF to terminate a line. The rationale was that
414 CRLF is universally used in network protocols to mark the end of the line. This
415 implementation does not embed Sieve in a network protocol, but uses Sieve
416 scripts as part of the Exim MTA. Since all parts of Exim use LF as the newline
417 character, this implementation does, too, by default, though the system
418 administrator may choose (at Exim compile time) to use CRLF instead.
419
420 Exim violates RFC 2822, section 3.6.8, by accepting 8-bit header names, so this
421 implementation repeats this violation to stay consistent with Exim. This is in
422 preparation for UTF-8 data.
423
424 Sieve scripts cannot contain NUL characters in strings, but mail headers could
425 contain MIME encoded NUL characters, which could never be matched by Sieve
426 scripts using exact comparisons. For that reason, this implementation extends
427 the Sieve quoted string syntax with \0 to describe a NUL character, violating
428 \0 being the same as 0 in RFC 3028. Even without using \0, the following tests
429 are all true in this implementation. Implementations that use C-style strings
430 will only evaluate the first test as true.
431 .code
432 Subject: =?iso-8859-1?q?abc=00def
433
434 header :contains "Subject" ["abc"]
435 header :contains "Subject" ["def"]
436 header :matches "Subject" ["abc?def"]
437 .endd
438 Note that by considering Sieve to be an MUA, RFC 2047 can be interpreted in a
439 way that NUL characters truncating strings is allowed for Sieve
440 implementations, although not recommended. It is further allowed to use encoded
441 NUL characters in headers, but that's not recommended either. The above example
442 shows why.
443
444 RFC 3028 states that if an implementation fails to convert a character set to
445 UTF-8, two strings cannot be equal if one contains octets greater than 127.
446 Assuming that all unknown character sets are one-byte character sets with the
447 lower 128 octets being US-ASCII is not sound, so this implementation violates
448 RFC 3028 and treats such MIME words literally. That way at least something
449 could be matched.
450
451 The folder specified by &(fileinto)& must not contain the character sequence
452 &".."& to avoid security problems. RFC 3028 does not specify the syntax of
453 folders apart from &(keep)& being equivalent to
454 .code
455 fileinto "INBOX";
456 .endd
457 This implementation uses &_inbox_& instead.
458
459 Sieve script errors currently cause messages to be silently filed into
460 &_inbox_&.  RFC 3028 requires that the user is notified of that condition.
461 This may be implemented in the future by adding a header line to mails that
462 are filed into &_inbox_& due to an error in the filter.
463
464
465
466 .chapter "Exim filter files" "CHAPeximfilter"
467 This chapter contains a full description of the contents of Exim filter files.
468
469
470 .section "Format of Exim filter files" "SEC17"
471 Apart from leading white space, the first text in an Exim filter file must be
472 .code
473 # Exim filter
474 .endd
475 This is what distinguishes it from a conventional &_.forward_& file or a Sieve
476 filter file. If the file does not have this initial line (or the equivalent for
477 a Sieve filter), it is treated as a conventional &_.forward_& file, both when
478 delivering mail and when using the &%-bf%& testing mechanism. The white space
479 in the line is optional, and any capitalization may be used. Further text on
480 the same line is treated as a comment. For example, you could have
481 .code
482 #   Exim filter   <<== do not edit or remove this line!
483 .endd
484 The remainder of the file is a sequence of filtering commands, which consist of
485 keywords and data values. For example, in the command
486 .code
487 deliver gulliver@lilliput.fict.example
488 .endd
489 the keyword is &`deliver`& and the data value is
490 &`gulliver@lilliput.fict.example`&. White space or line breaks separate the
491 components of a command, except in the case of conditions for the &(if)&
492 command, where round brackets (parentheses) also act as separators. Complete
493 commands are separated from each other by white space or line breaks; there are
494 no special terminators. Thus, several commands may appear on one line, or one
495 command may be spread over a number of lines.
496
497 If the character # follows a separator anywhere in a command, everything from
498 # up to the next newline is ignored. This provides a way of including comments
499 in a filter file.
500
501
502 .section "Data values in filter commands" "SEC18"
503 There are two ways in which a data value can be input:
504
505 .ilist
506 If the text contains no white space, it can be typed verbatim. However, if it
507 is part of a condition, it must also be free of round brackets (parentheses),
508 as these are used for grouping in conditions.
509 .next
510 Otherwise, text must be enclosed in double quotation marks. In this case, the
511 character \ (backslash) is treated as an &"escape character"& within the
512 string, causing the following character or characters to be treated specially:
513 .display
514 &`\n`&   is replaced by a newline
515 &`\r`&   is replaced by a carriage return
516 &`\t`&   is replaced by a tab
517 .endd
518 .endlist
519
520 Backslash followed by up to three octal digits is replaced by the character
521 specified by those digits, and &`\x`& followed by up to two hexadecimal digits
522 is treated similarly. Backslash followed by any other character is replaced by
523 the second character, so that in particular, &`\"`& becomes &`"`& and &`\\`&
524 becomes &`\`&. A data item enclosed in double quotes can be continued onto the
525 next line by ending the first line with a backslash. Any leading white space at
526 the start of the continuation line is ignored.
527
528 In addition to the escape character processing that occurs when strings are
529 enclosed in quotes, most data values are also subject to &'string expansion'&
530 (as described in the next section), in which case the characters &`$`& and
531 &`\`& are also significant. This means that if a single backslash is actually
532 required in such a string, and the string is also quoted, &`\\\\`& has to be
533 entered.
534
535 The maximum permitted length of a data string, before expansion, is 1024
536 characters.
537
538
539 .section "String expansion" "SECTfilterstringexpansion"
540 Most data values are expanded before use. Expansion consists of replacing
541 substrings beginning with &`$`& with other text. The full expansion facilities
542 available in Exim are extensive. If you want to know everything that Exim can
543 do with strings, you should consult the chapter on string expansion in the Exim
544 documentation.
545
546 In filter files, by far the most common use of string expansion is the
547 substitution of the contents of a variable. For example, the substring
548 .code
549 $reply_address
550 .endd
551 is replaced by the address to which replies to the message should be sent. If
552 such a variable name is followed by a letter or digit or underscore, it must be
553 enclosed in curly brackets (braces), for example,
554 .code
555 ${reply_address}
556 .endd
557 If a &`$`& character is actually required in an expanded string, it must be
558 escaped with a backslash, and because backslash is also an escape character in
559 quoted input strings, it must be doubled in that case. The following two
560 examples illustrate two different ways of testing for a &`$`& character in a
561 message:
562 .code
563 if $message_body contains \$ then ...
564 if $message_body contains "\\$" then ...
565 .endd
566 You can prevent part of a string from being expanded by enclosing it between
567 two occurrences of &`\N`&. For example,
568 .code
569 if $message_body contains \N$$$$\N then ...
570 .endd
571 tests for a run of four dollar characters.
572
573
574 .section "Some useful general variables" "SEC19"
575 A complete list of the available variables is given in the Exim documentation.
576 This shortened list contains the ones that are most likely to be useful in
577 personal filter files:
578
579 &$body_linecount$&: The number of lines in the body of the message.
580
581 &$body_zerocount$&: The number of binary zero characters in the body of the
582 message.
583
584 &$home$&: In conventional configurations, this variable normally contains the
585 user's home directory. The system administrator can, however, change this.
586
587 &$local_part$&: The part of the email address that precedes the @ sign &--
588 normally the user's login name. If support for multiple personal mailboxes is
589 enabled (see section &<<SECTmbox>>& below) and a prefix or suffix for the local
590 part was recognized, it is removed from the string in this variable.
591
592 &$local_part_prefix$&: If support for multiple personal mailboxes is enabled
593 (see section &<<SECTmbox>>& below), and a local part prefix was recognized,
594 this variable contains the prefix. Otherwise it contains an empty string.
595
596 &$local_part_suffix$&: If support for multiple personal mailboxes is enabled
597 (see section &<<SECTmbox>>& below), and a local part suffix was recognized,
598 this variable contains the suffix. Otherwise it contains an empty string.
599
600 &$message_body$&: The initial portion of the body of the message. By default,
601 up to 500 characters are read into this variable, but the system administrator
602 can configure this to some other value. Newlines in the body are converted into
603 single spaces.
604
605 &$message_body_end$&: The final portion of the body of the message, formatted
606 and limited in the same way as &$message_body$&.
607
608 &$message_body_size$&: The size of the body of the message, in bytes.
609
610 &$message_exim_id$&: The message's local identification string, which is unique
611 for each message handled by a single host.
612
613 &$message_headers$&: The header lines of the message, concatenated into a
614 single string, with newline characters between them.
615
616 &$message_size$&: The size of the entire message, in bytes.
617
618 &$original_local_part$&: When an address that arrived with the message is
619 being processed, this contains the same value as the variable &$local_part$&.
620 However, if an address generated by an alias, forward, or filter file is being
621 processed, this variable contains the local part of the original address.
622
623 &$reply_address$&: The contents of the &'Reply-to:'& header, if the message
624 has one; otherwise the contents of the &'From:'& header. It is the address to
625 which normal replies to the message should be sent.
626
627 &$return_path$&: The return path &-- that is, the sender field that will be
628 transmitted as part of the message's envelope if the message is sent to another
629 host. This is the address to which delivery errors are sent. In many cases,
630 this variable has the same value as &$sender_address$&, but if, for example,
631 an incoming message to a mailing list has been expanded, &$return_path$& may
632 have been changed to contain the address of the list maintainer.
633
634 &$sender_address$&: The sender address that was received in the envelope of
635 the message. This is not necessarily the same as the contents of the &'From:'&
636 or &'Sender:'& header lines. For delivery error messages (&"bounce messages"&)
637 there is no sender address, and this variable is empty.
638
639 &$tod_full$&: A full version of the time and date, for example: Wed, 18 Oct
640 1995 09:51:40 +0100. The timezone is always given as a numerical offset from
641 GMT.
642
643 &$tod_log$&: The time and date in the format used for writing Exim's log files,
644 without the timezone, for example: 1995-10-12 15:32:29.
645
646 &$tod_zone$&: The local timezone offset, for example: +0100.
647
648
649
650 .section "Header variables" "SECTheadervariables"
651 There is a special set of expansion variables containing the header lines of
652 the message being processed. These variables have names beginning with
653 &$header_$& followed by the name of the header line, terminated by a colon.
654 For example,
655 .code
656 $header_from:
657 $header_subject:
658 .endd
659 The whole item, including the terminating colon, is replaced by the contents of
660 the message header line. If there is more than one header line with the same
661 name, their contents are concatenated. For header lines whose data consists of
662 a list of addresses (for example, &'From:'& and &'To:'&), a comma and newline
663 is inserted between each set of data. For all other header lines, just a
664 newline is used.
665
666 Leading and trailing white space is removed from header line data, and if there
667 are any MIME &"words"& that are encoded as defined by RFC 2047 (because they
668 contain non-ASCII characters), they are decoded and translated, if possible, to
669 a local character set. Translation is attempted only on operating systems that
670 have the &[iconv()]& function. This makes the header line look the same as it
671 would when displayed by an MUA. The default character set is ISO-8859-1, but
672 this can be changed by means of the &(headers)& command (see below).
673
674 If you want to see the actual characters that make up a header line, you can
675 specify &$rheader_$& instead of &$header_$&. This inserts the &"raw"&
676 header line, unmodified.
677
678 There is also an intermediate form, requested by &$bheader_$&, which removes
679 leading and trailing space and decodes MIME &"words"&, but does not do any
680 character translation. If an attempt to decode what looks superficially like a
681 MIME &"word"& fails, the raw string is returned. If decoding produces a binary
682 zero character, it is replaced by a question mark.
683
684 The capitalization of the name following &$header_$& is not significant.
685 Because any printing character except colon may appear in the name of a
686 message's header (this is a requirement of RFC 2822, the document that
687 describes the format of a mail message) curly brackets must &'not'& be used in
688 this case, as they will be taken as part of the header name. Two shortcuts are
689 allowed in naming header variables:
690
691 .ilist
692 The initiating &$header_$&, &$rheader_$&, or &$bheader_$& can be
693 abbreviated to &$h_$&, &$rh_$&, or &$bh_$&, respectively.
694 .next
695 The terminating colon can be omitted if the next character is white space. The
696 white space character is retained in the expanded string. However, this is not
697 recommended, because it makes it easy to forget the colon when it really is
698 needed.
699 .endlist
700
701 If the message does not contain a header of the given name, an empty string is
702 substituted. Thus it is important to spell the names of headers correctly. Do
703 not use &$header_Reply_to$& when you really mean &$header_Reply-to$&.
704
705
706 .section "User variables" "SEC20"
707 There are ten user variables with names &$n0$& &-- &$n9$& that can be
708 incremented by the &(add)& command (see section &<<SECTadd>>&). These can be
709 used for &"scoring"& messages in various ways. If Exim is configured to run a
710 &"system filter"& on every message, the values left in these variables are
711 copied into the variables &$sn0$& &-- &$sn9$& at the end of the system filter,
712 thus making them available to users' filter files. How these values are used is
713 entirely up to the individual installation.
714
715
716 .section "Current directory" "SEC21"
717 The contents of your filter file should not make any assumptions about the
718 current directory. It is best to use absolute paths for file names; you can
719 normally make use of the &$home$& variable to refer to your home directory. The
720 &(save)& command automatically inserts &$home$& at the start of non-absolute
721 paths.
722
723
724
725
726 .section "Significant deliveries" "SECTsigdel"
727 When in the course of delivery a message is processed by a filter file, what
728 happens next, that is, after the filter file has been processed, depends on
729 whether or not the filter sets up any &'significant deliveries'&. If at least
730 one significant delivery is set up, the filter is considered to have handled
731 the entire delivery arrangements for the current address, and no further
732 processing of the address takes place. If, however, no significant deliveries
733 are set up, Exim continues processing the current address as if there were no
734 filter file, and typically sets up a delivery of a copy of the message into a
735 local mailbox. In particular, this happens in the special case of a filter file
736 containing only comments.
737
738 The delivery commands &(deliver)&, &(save)&, and &(pipe)& are by default
739 significant. However, if such a command is preceded by the word &"unseen"&, its
740 delivery is not considered to be significant. In contrast, other commands such
741 as &(mail)& and &(vacation)& do not set up significant deliveries unless
742 preceded by the word &"seen"&. The following example commands set up
743 significant deliveries:
744 .code
745 deliver jack@beanstalk.example
746 pipe $home/bin/mymailscript
747 seen mail subject "message discarded"
748 seen finish
749 .endd
750 The following example commands do not set up significant deliveries:
751 .code
752 unseen deliver jack@beanstalk.example
753 unseen pipe $home/bin/mymailscript
754 mail subject "message discarded"
755 finish
756 .endd
757
758
759
760 .section "Filter commands" "SEC222"
761 The filter commands that are described in subsequent sections are listed
762 below, with the section in which they are described in brackets:
763
764 .table2
765 .row &(add)&        "&~&~increment a user variable (section &<<SECTadd>>&)"
766 .row &(deliver)&    "&~&~deliver to an email address (section &<<SECTdeliver>>&)"
767 .row &(fail)&       "&~&~force delivery failure (sysadmin use) (section &<<SECTfail>>&)"
768 .row &(finish)&     "&~&~end processing (section &<<SECTfinish>>&)"
769 .row &(freeze)&     "&~&~freeze message (sysadmin use) (section &<<SECTfreeze>>&)"
770 .row &(headers)&    "&~&~set the header character set (section &<<SECTheaders>>&)"
771 .row &(if)&         "&~&~test condition(s) (section &<<SECTif>>&)"
772 .row &(logfile)&    "&~&~define log file (section &<<SECTlog>>&)"
773 .row &(logwrite)&   "&~&~write to log file (section &<<SECTlog>>&)"
774 .row &(mail)&       "&~&~send a reply message (section &<<SECTmail>>&)"
775 .row &(pipe)&       "&~&~pipe to a command (section &<<SECTpipe>>&)"
776 .row &(save)&       "&~&~save to a file (section &<<SECTsave>>&)"
777 .row &(testprint)&  "&~&~print while testing (section &<<SECTtestprint>>&)"
778 .row &(vacation)&   "&~&~tailored form of &(mail)& (section &<<SECTmail>>&)"
779 .endtable
780
781 The &(headers)& command has additional parameters that can be used only in a
782 system filter. The &(fail)& and &(freeze)& commands are available only when
783 Exim's filtering facilities are being used as a system filter, and are
784 therefore usable only by the system administrator and not by ordinary users.
785 They are mentioned only briefly in this document; for more information, see the
786 main Exim specification.
787
788
789
790 .section "The add command" "SECTadd"
791 .display
792 &`     add `&<&'number'&>&` to `&<&'user variable'&>
793 &`e.g. add 2 to n3`&
794 .endd
795
796 There are 10 user variables of this type, with names &$n0$& &-- &$n9$&. Their
797 values can be obtained by the normal expansion syntax (for example &$n3$&) in
798 other commands. At the start of filtering, these variables all contain zero.
799 Both arguments of the &(add)& command are expanded before use, making it
800 possible to add variables to each other. Subtraction can be obtained by adding
801 negative numbers.
802
803
804
805 .section "The deliver command" "SECTdeliver"
806 .display
807 &`     deliver`& <&'mail address'&>
808 &`e.g. deliver "Dr Livingstone <David@somewhere.africa.example>"`&
809 .endd
810
811 This command provides a forwarding operation. The delivery that it sets up is
812 significant unless the command is preceded by &"unseen"& (see section
813 &<<SECTsigdel>>&). The message is sent on to the given address, exactly as
814 happens if the address had appeared in a traditional &_.forward_& file. If you
815 want to deliver the message to a number of different addresses, you can use
816 more than one &(deliver)& command (each one may have only one address).
817 However, duplicate addresses are discarded.
818
819 To deliver a copy of the message to your normal mailbox, your login name can be
820 given as the address. Once an address has been processed by the filtering
821 mechanism, an identical generated address will not be so processed again, so
822 doing this does not cause a loop.
823
824 However, if you have a mail alias, you should &'not'& refer to it here. For
825 example, if the mail address &'L.Gulliver'& is aliased to &'lg303'& then all
826 references in Gulliver's &_.forward_& file should be to &'lg303'&. A reference
827 to the alias will not work for messages that are addressed to that alias,
828 since, like &_.forward_& file processing, aliasing is performed only once on an
829 address, in order to avoid looping.
830
831 Following the new address, an optional second address, preceded by
832 &"errors_to"& may appear. This changes the address to which delivery errors on
833 the forwarded message will be sent. Instead of going to the message's original
834 sender, they go to this new address. For ordinary users, the only value that is
835 permitted for this address is the user whose filter file is being processed.
836 For example, the user &'lg303'& whose mailbox is in the domain
837 &'lilliput.example'& could have a filter file that contains
838 .code
839 deliver jon@elsewhere.example errors_to lg303@lilliput.example
840 .endd
841 Clearly, using this feature makes sense only in situations where not all
842 messages are being forwarded. In particular, bounce messages must not be
843 forwarded in this way, as this is likely to create a mail loop if something
844 goes wrong.
845
846
847
848 .section "The save command" "SECTsave"
849 .display
850 &`     save `&<&'file name'&>
851 &`e.g. save $home/mail/bookfolder`&
852 .endd
853
854 This command specifies that a copy of the message is to be appended to the
855 given file (that is, the file is to be used as a mail folder). The delivery
856 that &(save)& sets up is significant unless the command is preceded by
857 &"unseen"& (see section &<<SECTsigdel>>&).
858
859 More than one &(save)& command may be obeyed; each one causes a copy of the
860 message to be written to its argument file, provided they are different
861 (duplicate &(save)& commands are ignored).
862
863 If the file name does not start with a / character, the contents of the
864 &$home$& variable are prepended, unless it is empty, or the system
865 administrator has disabled this feature. In conventional configurations, this
866 variable is normally set in a user filter to the user's home directory, but the
867 system administrator may set it to some other path. In some configurations,
868 &$home$& may be unset, or prepending may be disabled, in which case a
869 non-absolute path name may be generated. Such configurations convert this to an
870 absolute path when the delivery takes place. In a system filter, &$home$& is
871 never set.
872
873 The user must of course have permission to write to the file, and the writing
874 of the file takes place in a process that is running as the user, under the
875 user's primary group. Any secondary groups to which the user may belong are not
876 normally taken into account, though the system administrator can configure Exim
877 to set them up. In addition, the ability to use this command at all is
878 controlled by the system administrator &-- it may be forbidden on some systems.
879
880 An optional mode value may be given after the file name. The value for the mode
881 is interpreted as an octal number, even if it does not begin with a zero. For
882 example:
883 .code
884 save /some/folder 640
885 .endd
886 This makes it possible for users to override the system-wide mode setting for
887 file deliveries, which is normally 600. If an existing file does not have the
888 correct mode, it is changed.
889
890 An alternative form of delivery may be enabled on your system, in which each
891 message is delivered into a new file in a given directory. If this is the case,
892 this functionality can be requested by giving the directory name terminated by
893 a slash after the &(save)& command, for example
894 .code
895 save separated/messages/
896 .endd
897 There are several different formats for such deliveries; check with your system
898 administrator or local documentation to find out which (if any) are available
899 on your system. If this functionality is not enabled, the use of a path name
900 ending in a slash causes an error.
901
902
903
904 .section "The pipe command" "SECTpipe"
905 .display
906 &`     pipe `&<&'command'&>
907 &`e.g. pipe "$home/bin/countmail $sender_address"`&
908 .endd
909
910 This command specifies that the message is to be delivered to the specified
911 command using a pipe. The delivery that it sets up is significant unless the
912 command is preceded by &"unseen"& (see section &<<SECTsigdel>>&). Remember,
913 however, that no deliveries are done while the filter is being processed. All
914 deliveries happen later on. Therefore, the result of running the pipe is not
915 available to the filter.
916
917 When the deliveries are done, a separate process is run, and a copy of the
918 message is passed on its standard input. The process runs as the user, under
919 the user's primary group. Any secondary groups to which the user may belong are
920 not normally taken into account, though the system administrator can configure
921 Exim to set them up. More than one &(pipe)& command may appear; each one causes
922 a copy of the message to be written to its argument pipe, provided they are
923 different (duplicate &(pipe)& commands are ignored).
924
925 When the time comes to transport the message, the command supplied to &(pipe)&
926 is split up by Exim into a command name and a number of arguments. These are
927 delimited by white space except for arguments enclosed in double quotes, in
928 which case backslash is interpreted as an escape, or in single quotes, in which
929 case no escaping is recognized. Note that as the whole command is normally
930 supplied in double quotes, a second level of quoting is required for internal
931 double quotes. For example:
932 .code
933 pipe "$home/myscript \"size is $message_size\""
934 .endd
935 String expansion is performed on the separate components after the line has
936 been split up, and the command is then run directly by Exim; it is not run
937 under a shell. Therefore, substitution cannot change the number of arguments,
938 nor can quotes, backslashes or other shell metacharacters in variables cause
939 confusion.
940
941 Documentation for some programs that are normally run via this kind of pipe
942 often suggest that the command should start with
943 .code
944 IFS=" "
945 .endd
946 This is a shell command, and should &'not'& be present in Exim filter files,
947 since it does not normally run the command under a shell.
948
949 However, there is an option that the administrator can set to cause a shell to
950 be used. In this case, the entire command is expanded as a single string and
951 passed to the shell for interpretation. It is recommended that this be avoided
952 if at all possible, since it can lead to problems when inserted variables
953 contain shell metacharacters.
954
955 The default PATH set up for the command is determined by the system
956 administrator, usually containing at least &_/bin_& and &_/usr/bin_& so that
957 common commands are available without having to specify an absolute file name.
958 However, it is possible for the system administrator to restrict the pipe
959 facility so that the command name must not contain any / characters, and must
960 be found in one of the directories in the configured PATH. It is also possible
961 for the system administrator to lock out the use of the &(pipe)& command
962 altogether.
963
964 When the command is run, a number of environment variables are set up. The
965 complete list for pipe deliveries may be found in the Exim reference manual.
966 Those that may be useful for pipe deliveries from user filter files are:
967
968 .display
969 &`DOMAIN            `&   the domain of the address
970 &`HOME              `&   your home directory
971 &`LOCAL_PART        `&   see below
972 &`LOCAL_PART_PREFIX `&   see below
973 &`LOCAL_PART_SUFFIX `&   see below
974 &`LOGNAME           `&   your login name
975 &`MESSAGE_ID        `&   the unique id of the message
976 &`PATH              `&   the command search path
977 &`RECIPIENT         `&   the complete recipient address
978 &`SENDER            `&   the sender of the message
979 &`SHELL             `&   &`/bin/sh`&
980 &`USER              `&   see below
981 .endd
982
983 LOCAL_PART, LOGNAME, and USER are all set to the same value, namely, your login
984 id. LOCAL_PART_PREFIX and LOCAL_PART_SUFFIX may be set if Exim is configured to
985 recognize prefixes or suffixes in the local parts of addresses. For example, a
986 message addressed to &'pat-suf2@domain.example'& may cause the filter for user
987 &'pat'& to be run. If this sets up a pipe delivery, LOCAL_PART_SUFFIX is
988 &`-suf2`& when the pipe command runs. The system administrator has to configure
989 Exim specially for this feature to be available.
990
991 If you run a command that is a shell script, be very careful in your use of
992 data from the incoming message in the commands in your script. RFC 2822 is very
993 generous in the characters that are permitted to appear in mail addresses, and
994 in particular, an address may begin with a vertical bar or a slash. For this
995 reason you should always use quotes round any arguments that involve data from
996 the message, like this:
997 .code
998 /some/command '$SENDER'
999 .endd
1000 so that inserted shell meta-characters do not cause unwanted effects.
1001
1002 Remember that, as was explained earlier, the pipe command is not run at the
1003 time the filter file is interpreted. The filter just defines what deliveries
1004 are required for one particular addressee of a message. The deliveries
1005 themselves happen later, once Exim has decided everything that needs to be done
1006 for the message.
1007
1008 A consequence of this is that you cannot inspect the return code from the pipe
1009 command from within the filter. Nevertheless, the code returned by the command
1010 is important, because Exim uses it to decide whether the delivery has succeeded
1011 or failed.
1012
1013 The command should return a zero completion code if all has gone well. Most
1014 non-zero codes are treated by Exim as indicating a failure of the pipe. This is
1015 treated as a delivery failure, causing the message to be returned to its
1016 sender. However, there are some completion codes that are treated as temporary
1017 errors. The message remains on Exim's spool disk, and the delivery is tried
1018 again later, though it will ultimately time out if the delivery failures go on
1019 too long. The completion codes to which this applies can be specified by the
1020 system administrator; the default values are 73 and 75.
1021
1022 The pipe command should not normally write anything to its standard output or
1023 standard error file descriptors. If it does, whatever is written is normally
1024 returned to the sender of the message as a delivery error, though this action
1025 can be varied by the system administrator.
1026
1027
1028
1029 .section "Mail commands" "SECTmail"
1030 There are two commands that cause the creation of a new mail message, neither
1031 of which count as a significant delivery unless the command is preceded by the
1032 word &"seen"& (see section &<<SECTsigdel>>&). This is a powerful facility, but
1033 it should be used with care, because of the danger of creating infinite
1034 sequences of messages. The system administrator can forbid the use of these
1035 commands altogether.
1036
1037 To help prevent runaway message sequences, these commands have no effect when
1038 the incoming message is a bounce (delivery error) message, and messages sent by
1039 this means are treated as if they were reporting delivery errors. Thus, they
1040 should never themselves cause a bounce message to be returned. The basic
1041 mail-sending command is
1042 .display
1043 &`mail [to `&<&'address-list'&>&`]`&
1044 &`     [cc `&<&'address-list'&>&`]`&
1045 &`     [bcc `&<&'address-list'&>&`]`&
1046 &`     [from `&<&'address'&>&`]`&
1047 &`     [reply_to `&<&'address'&>&`]`&
1048 &`     [subject `&<&'text'&>&`]`&
1049 &`     [extra_headers `&<&'text'&>&`]`&
1050 &`     [text `&<&'text'&>&`]`&
1051 &`     [[expand] file `&<&'filename'&>&`]`&
1052 &`     [return message]`&
1053 &`     [log `&<&'log file name'&>&`]`&
1054 &`     [once `&<&'note file name'&>&`]`&
1055 &`     [once_repeat `&<&'time interval'&>&`]`&
1056 &`e.g. mail text "Your message about $h_subject: has been received"`&
1057 .endd
1058 Each <&'address-list'&> can contain a number of addresses, separated by commas,
1059 in the format of a &'To:'& or &'Cc:'& header line. In fact, the text you supply
1060 here is copied exactly into the appropriate header line. It may contain
1061 additional information as well as email addresses. For example:
1062 .code
1063 mail to "Julius Caesar <jc@rome.example>, \
1064          <ma@rome.example> (Mark A.)"
1065 .endd
1066 Similarly, the texts supplied for &%from%& and &%reply_to%& are copied into
1067 their respective header lines.
1068
1069 As a convenience for use in one common case, there is also a command called
1070 &(vacation)&. It behaves in the same way as &(mail)&, except that the defaults
1071 for the &%subject%&, &%file%&, &%log%&, &%once%&, and &%once_repeat%& options
1072 are
1073 .code
1074 subject "On vacation"
1075 expand file .vacation.msg
1076 log  .vacation.log
1077 once .vacation
1078 once_repeat 7d
1079 .endd
1080 respectively. These are the same file names and repeat period used by the
1081 traditional Unix &(vacation)& command. The defaults can be overridden by
1082 explicit settings, but if a file name is given its contents are expanded only
1083 if explicitly requested.
1084
1085 &*Warning*&: The &(vacation)& command should always be used conditionally,
1086 subject to at least the &(personal)& condition (see section &<<SECTpersonal>>&
1087 below) so as not to send automatic replies to non-personal messages from
1088 mailing lists or elsewhere. Sending an automatic response to a mailing list or
1089 a mailing list manager is an Internet Sin.
1090
1091 For both commands, the key/value argument pairs can appear in any order. At
1092 least one of &%text%& or &%file%& must appear (except with &(vacation)&, where
1093 there is a default for &%file%&); if both are present, the text string appears
1094 first in the message. If &%expand%& precedes &%file%&, each line of the file is
1095 subject to string expansion before it is included in the message.
1096
1097 Several lines of text can be supplied to &%text%& by including the escape
1098 sequence &"\n"& in the string wherever a newline is required. If the command is
1099 output during filter file testing, newlines in the text are shown as &"\n"&.
1100
1101 Note that the keyword for creating a &'Reply-To:'& header is &%reply_to%&,
1102 because Exim keywords may contain underscores, but not hyphens. If the &%from%&
1103 keyword is present and the given address does not match the user who owns the
1104 forward file, Exim normally adds a &'Sender:'& header to the message, though it
1105 can be configured not to do this.
1106
1107 The &%extra_headers%& keyword allows you to add custom header lines to the
1108 message. The text supplied must be one or more syntactically valid RFC 2822
1109 header lines. You can use &"\n"& within quoted text to specify newlines between
1110 headers, and also to define continued header lines. For example:
1111 .code
1112 extra_headers "h1: first\nh2: second\n continued\nh3: third"
1113 .endd
1114 No newline should appear at the end of the final header line.
1115
1116 If no &%to%& argument appears, the message is sent to the address in the
1117 &$reply_address$& variable (see section &<<SECTfilterstringexpansion>>& above).
1118 An &'In-Reply-To:'& header is automatically included in the created message,
1119 giving a reference to the message identification of the incoming message.
1120
1121 If &%return message%& is specified, the incoming message that caused the filter
1122 file to be run is added to the end of the message, subject to a maximum size
1123 limitation.
1124
1125 If a log file is specified, a line is added to it for each message sent.
1126
1127 If a &%once%& file is specified, it is used to hold a database for remembering
1128 who has received a message, and no more than one message is ever sent to any
1129 particular address, unless &%once_repeat%& is set. This specifies a time
1130 interval after which another copy of the message is sent. The interval is
1131 specified as a sequence of numbers, each followed by the initial letter of one
1132 of &"seconds"&, &"minutes"&, &"hours"&, &"days"&, or &"weeks"&. For example,
1133 .code
1134 once_repeat 5d4h
1135 .endd
1136 causes a new message to be sent if at least 5 days and 4 hours have elapsed
1137 since the last one was sent. There must be no white space in a time interval.
1138
1139 Commonly, the file name specified for &%once%& is used as the base name for
1140 direct-access (DBM) file operations. There are a number of different DBM
1141 libraries in existence. Some operating systems provide one as a default, but
1142 even in this case a different one may have been used when building Exim. With
1143 some DBM libraries, specifying &%once%& results in two files being created,
1144 with the suffixes &_.dir_& and &_.pag_& being added to the given name. With
1145 some others a single file with the suffix &_.db_& is used, or the name is used
1146 unchanged.
1147
1148 Using a DBM file for implementing the &%once%& feature means that the file
1149 grows as large as necessary. This is not usually a problem, but some system
1150 administrators want to put a limit on it. The facility can be configured not to
1151 use a DBM file, but instead, to use a regular file with a maximum size. The
1152 data in such a file is searched sequentially, and if the file fills up, the
1153 oldest entry is deleted to make way for a new one. This means that some
1154 correspondents may receive a second copy of the message after an unpredictable
1155 interval. Consult your local information to see if your system is configured
1156 this way.
1157
1158 More than one &(mail)& or &(vacation)& command may be obeyed in a single filter
1159 run; they are all honoured, even when they are to the same recipient.
1160
1161
1162
1163 .section "Logging commands" "SECTlog"
1164 A log can be kept of actions taken by a filter file. This facility is normally
1165 available in conventional configurations, but there are some situations where
1166 it might not be. Also, the system administrator may choose to disable it. Check
1167 your local information if in doubt.
1168
1169 Logging takes place while the filter file is being interpreted. It does not
1170 queue up for later like the delivery commands. The reason for this is so that a
1171 log file need be opened only once for several write operations. There are two
1172 commands, neither of which constitutes a significant delivery. The first
1173 defines a file to which logging output is subsequently written:
1174 .display
1175 &`     logfile `&<&'file name'&>
1176 &`e.g. logfile $home/filter.log`&
1177 .endd
1178 The file name must be fully qualified. You can use &$home$&, as in this
1179 example, to refer to your home directory. The file name may optionally be
1180 followed by a mode for the file, which is used if the file has to be created.
1181 For example,
1182 .code
1183 logfile $home/filter.log 0644
1184 .endd
1185 The number is interpreted as octal, even if it does not begin with a zero.
1186 The default for the mode is 600. It is suggested that the &(logfile)& command
1187 normally appear as the first command in a filter file. Once a log file has
1188 been obeyed, the &(logwrite)& command can be used to write to it:
1189 .display
1190 &`     logwrite "`&<&'some text string'&>&`"`&
1191 &`e.g. logwrite "$tod_log $message_id processed"`&
1192 .endd
1193 It is possible to have more than one &(logfile)& command, to specify writing to
1194 different log files in different circumstances.
1195 A previously opened log is closed on a subsequent &(logfile)& command.
1196 Writing takes place at the end
1197 of the file, and a newline character is added to the end of each string if
1198 there isn't one already there. Newlines can be put in the middle of the string
1199 by using the &"\n"& escape sequence. Lines from simultaneous deliveries may get
1200 interleaved in the file, as there is no interlocking, so you should plan your
1201 logging with this in mind. However, data should not get lost.
1202
1203
1204
1205 .section "The finish command" "SECTfinish"
1206 The command &(finish)&, which has no arguments, causes Exim to stop
1207 interpreting the filter file. This is not a significant action unless preceded
1208 by &"seen"&. A filter file containing only &"seen finish"& is a black hole.
1209
1210
1211 .section "The testprint command" "SECTtestprint"
1212 It is sometimes helpful to be able to print out the values of variables when
1213 testing filter files. The command
1214 .display
1215 &`     testprint `&<&'text'&>
1216 &`e.g. testprint "home=$home reply_address=$reply_address"`&
1217 .endd
1218 does nothing when mail is being delivered. However, when the filtering code is
1219 being tested by means of the &%-bf%& option (see section &<<SECTtesting>>&
1220 above), the value of the string is written to the standard output.
1221
1222
1223 .section "The fail command" "SECTfail"
1224 When Exim's filtering facilities are being used as a system filter, the
1225 &(fail)& command is available, to force delivery failure. Because this command
1226 is normally usable only by the system administrator, and not enabled for use by
1227 ordinary users, it is described in more detail in the main Exim specification
1228 rather than in this document.
1229
1230
1231 .section "The freeze command" "SECTfreeze"
1232 When Exim's filtering facilities are being used as a system filter, the
1233 &(freeze)& command is available, to freeze a message on the queue. Because this
1234 command is normally usable only by the system administrator, and not enabled
1235 for use by ordinary users, it is described in more detail in the main Exim
1236 specification rather than in this document.
1237
1238
1239
1240 .section "The headers command" "SECTheaders"
1241 The &(headers)& command can be used to change the target character set that is
1242 used when translating the contents of encoded header lines for insertion by the
1243 &$header_$& mechanism (see section &<<SECTheadervariables>>& above). The
1244 default can be set in the Exim configuration; if not specified, ISO-8859-1 is
1245 used. The only currently supported format for the &(headers)& command in user
1246 filters is as in this example:
1247 .code
1248 headers charset "UTF-8"
1249 .endd
1250 That is, &(headers)& is followed by the word &"charset"& and then the name of a
1251 character set. This particular example would be useful if you wanted to compare
1252 the contents of a header to a UTF-8 string.
1253
1254 In system filter files, the &(headers)& command can be used to add or remove
1255 header lines from the message. These features are described in the main Exim
1256 specification.
1257
1258
1259
1260 .section "Obeying commands conditionally" "SECTif"
1261 Most of the power of filtering comes from the ability to test conditions and
1262 obey different commands depending on the outcome. The &(if)& command is used to
1263 specify conditional execution, and its general form is
1264 .display
1265 &`if    `&<&'condition'&>
1266 &`then  `&<&'commands'&>
1267 &`elif  `&<&'condition'&>
1268 &`then  `&<&'commands'&>
1269 &`else  `&<&'commands'&>
1270 &`endif`&
1271 .endd
1272 There may be any number of &(elif)& and &(then)& sections (including none) and
1273 the &(else)& section is also optional. Any number of commands, including nested
1274 &(if)& commands, may appear in any of the <&'commands'&> sections.
1275
1276 Conditions can be combined by using the words &(and)& and &(or)&, and round
1277 brackets (parentheses) can be used to specify how several conditions are to
1278 combine. Without brackets, &(and)& is more binding than &(or)&. For example:
1279 .code
1280 if
1281 $h_subject: contains "Make money" or
1282 $h_precedence: is "junk" or
1283 ($h_sender: matches ^\\d{8}@ and not personal) or
1284 $message_body contains "this is not spam"
1285 then
1286 seen finish
1287 endif
1288 .endd
1289 A condition can be preceded by &(not)& to negate it, and there are also some
1290 negative forms of condition that are more English-like.
1291
1292
1293
1294 .section "String testing conditions" "SEC23"
1295 There are a number of conditions that operate on text strings, using the words
1296 &"begins"&, &"ends"&, &"is"&, &"contains"& and &"matches"&. If you want to
1297 apply the same test to more than one header line, you can easily concatenate
1298 them into a single string for testing, as in this example:
1299 .code
1300 if "$h_to:, $h_cc:" contains me@domain.example then ...
1301 .endd
1302 If a string-testing condition name is written in lower case, the testing
1303 of letters is done without regard to case; if it is written in upper case
1304 (for example, &"CONTAINS"&), the case of letters is taken into account.
1305
1306 .display
1307 &`     `&<&'text1'&>&` begins `&<&'text2'&>
1308 &`     `&<&'text1'&>&` does not begin `&<&'text2'&>
1309 &`e.g. $header_from: begins "Friend@"`&
1310 .endd
1311
1312 A &"begins"& test checks for the presence of the second string at the start of
1313 the first, both strings having been expanded.
1314
1315 .display
1316 &`     `&<&'text1'&>&` ends `&<&'text2'&>
1317 &`     `&<&'text1'&>&` does not end `&<&'text2'&>
1318 &`e.g. $header_from: ends "public.com.example"`&
1319 .endd
1320
1321 An &"ends"& test checks for the presence of the second string at the end of
1322 the first, both strings having been expanded.
1323
1324 .display
1325 &`     `&<&'text1'&>&` is `&<&'text2'&>
1326 &`     `&<&'text1'&>&` is not `&<&'text2'&>
1327 &`e.g. $local_part_suffix is "-foo"`&
1328 .endd
1329
1330 An &"is"& test does an exact match between the strings, having first expanded
1331 both strings.
1332
1333 .display
1334 &`     `&<&'text1'&>&` contains `&<&'text2'&>
1335 &`     `&<&'text1'&>&` does not contain `&<&'text2'&>
1336 &`e.g. $header_subject: contains "evolution"`&
1337 .endd
1338
1339 A &"contains"& test does a partial string match, having expanded both strings.
1340
1341 .display
1342 &`     `&<&'text1'&>&` matches `&<&'text2'&>
1343 &`     `&<&'text1'&>&` does not match `&<&'text2'&>
1344 &`e.g. $sender_address matches "(bill|john)@"`&
1345 .endd
1346
1347 For a &"matches"& test, after expansion of both strings, the second one is
1348 interpreted as a regular expression. Exim uses the PCRE2 regular expression
1349 library, which provides regular expressions that are compatible with Perl.
1350
1351 The match succeeds if the regular expression matches any part of the first
1352 string. If you want a regular expression to match only at the start or end of
1353 the subject string, you must encode that requirement explicitly, using the
1354 &`^`& or &`$`& metacharacters. The above example, which is not so constrained,
1355 matches all these addresses:
1356 .code
1357 bill@test.example
1358 john@some.example
1359 spoonbill@example.com
1360 littlejohn@example.com
1361 .endd
1362 To match only the first two, you could use this:
1363 .code
1364 if $sender_address matches "^(bill|john)@" then ...
1365 .endd
1366 Care must be taken if you need a backslash in a regular expression, because
1367 backslashes are interpreted as escape characters both by the string expansion
1368 code and by Exim's normal processing of strings in quotes. For example, if you
1369 want to test the sender address for a domain ending in &'.com'& the regular
1370 expression is
1371 .code
1372 \.com$
1373 .endd
1374 The backslash and dollar sign in that expression have to be escaped when used
1375 in a filter command, as otherwise they would be interpreted by the expansion
1376 code. Thus, what you actually write is
1377 .code
1378 if $sender_address matches \\.com\$
1379 .endd
1380 An alternative way of handling this is to make use of the &`\N`& expansion
1381 flag for suppressing expansion:
1382 .code
1383 if $sender_address matches \N\.com$\N
1384 .endd
1385 Everything between the two occurrences of &`\N`& is copied without change by
1386 the string expander (and in fact you do not need the final one, because it is
1387 at the end of the string). If the regular expression is given in quotes
1388 (mandatory only if it contains white space) you have to write either
1389 .code
1390 if $sender_address matches "\\\\.com\\$"
1391 .endd
1392 or
1393 .code
1394 if $sender_address matches "\\N\\.com$\\N"
1395 .endd
1396
1397 If the regular expression contains bracketed sub-expressions, numeric
1398 variable substitutions such as &$1$& can be used in the subsequent actions
1399 after a successful match. If the match fails, the values of the numeric
1400 variables remain unchanged. Previous values are not restored after &(endif)&.
1401 In other words, only one set of values is ever available. If the condition
1402 contains several sub-conditions connected by &(and)& or &(or)&, it is the
1403 strings extracted from the last successful match that are available in
1404 subsequent actions. Numeric variables from any one sub-condition are also
1405 available for use in subsequent sub-conditions, because string expansion of a
1406 condition occurs just before it is tested.
1407
1408
1409 .section "Numeric testing conditions" "SEC24"
1410 The following conditions are available for performing numerical tests:
1411
1412 .display
1413 &`     `&<&'number1'&>&` is above `&<&'number2'&>
1414 &`     `&<&'number1'&>&` is not above `&<&'number2'&>
1415 &`     `&<&'number1'&>&` is below `&<&'number2'&>
1416 &`     `&<&'number1'&>&` is not below `&<&'number2'&>
1417 &`e.g. $message_size is not above 10k`&
1418 .endd
1419
1420 The <&'number'&> arguments must expand to strings of digits, optionally
1421 followed by one of the letters K or M (upper case or lower case) which cause
1422 multiplication by 1024 and 1024x1024 respectively.
1423
1424
1425 .section "Testing for significant deliveries" "SEC25"
1426 You can use the &(delivered)& condition to test whether or not any previously
1427 obeyed filter commands have set up a significant delivery. For example:
1428 .code
1429 if not delivered then save mail/anomalous endif
1430 .endd
1431 &"Delivered"& is perhaps a poor choice of name for this condition, because the
1432 message has not actually been delivered; rather, a delivery has been set up for
1433 later processing.
1434
1435
1436 .section "Testing for error messages" "SEC26"
1437 The condition &(error_message)& is true if the incoming message is a bounce
1438 (mail delivery error) message. Putting the command
1439 .code
1440 if error_message then finish endif
1441 .endd
1442 at the head of your filter file is a useful insurance against things going
1443 wrong in such a way that you cannot receive delivery error reports. &*Note*&:
1444 &(error_message)& is a condition, not an expansion variable, and therefore is
1445 not preceded by &`$`&.
1446
1447
1448 .section "Testing a list of addresses" "SEC27"
1449 There is a facility for looping through a list of addresses and applying a
1450 condition to each of them. It takes the form
1451 .display
1452 &`foranyaddress `&<&'string'&>&` (`&<&'condition'&>&`)`&
1453 .endd
1454 where <&'string'&> is interpreted as a list of RFC 2822 addresses, as in a
1455 typical header line, and <&'condition'&> is any valid filter condition or
1456 combination of conditions. The &"group"& syntax that is defined for certain
1457 header lines that contain addresses is supported.
1458
1459 The parentheses surrounding the condition are mandatory, to delimit it from
1460 possible further sub-conditions of the enclosing &(if)& command. Within the
1461 condition, the expansion variable &$thisaddress$& is set to the non-comment
1462 portion of each of the addresses in the string in turn. For example, if the
1463 string is
1464 .code
1465 B.Simpson <bart@sfld.example>, lisa@sfld.example (his sister)
1466 .endd
1467 then &$thisaddress$& would take on the values &`bart@sfld.example`& and
1468 &`lisa@sfld.example`& in turn.
1469
1470 If there are no valid addresses in the list, the whole condition is false. If
1471 the internal condition is true for any one address, the overall condition is
1472 true and the loop ends. If the internal condition is false for all addresses in
1473 the list, the overall condition is false. This example tests for the presence
1474 of an eight-digit local part in any address in a &'To:'& header:
1475 .code
1476 if foranyaddress $h_to: ( $thisaddress matches ^\\d{8}@ ) then ...
1477 .endd
1478 When the overall condition is true, the value of &$thisaddress$& in the
1479 commands that follow &(then)& is the last value it took on inside the loop. At
1480 the end of the &(if)& command, the value of &$thisaddress$& is reset to what it
1481 was before. It is best to avoid the use of multiple occurrences of
1482 &(foranyaddress)&, nested or otherwise, in a single &(if)& command, if the
1483 value of &$thisaddress$& is to be used afterwards, because it isn't always
1484 clear what the value will be. Nested &(if)& commands should be used instead.
1485
1486 Header lines can be joined together if a check is to be applied to more than
1487 one of them. For example:
1488 .code
1489 if foranyaddress $h_to:,$h_cc: ....
1490 .endd
1491 This scans through the addresses in both the &'To:'& and the &'Cc:'& headers.
1492
1493
1494 .section "Testing for personal mail" "SECTpersonal"
1495 A common requirement is to distinguish between incoming personal mail and mail
1496 from a mailing list, or from a robot or other automatic process (for example, a
1497 bounce message). In particular, this test is normally required for &"vacation
1498 messages"&.
1499
1500 The &(personal)& condition checks that the message is not a bounce message and
1501 that the current user's email address appears in the &'To:'& header. It also
1502 checks that the sender is not the current user or one of a number of common
1503 daemons, and that there are no header lines starting &'List-'& in the message.
1504 Finally, it checks the content of the &'Precedence:'& header line, if there is
1505 one.
1506
1507 You should always use the &(personal)& condition when generating automatic
1508 responses. This example shows the use of &(personal)& in a filter file that is
1509 sending out vacation messages:
1510 .code
1511 if personal then
1512 mail to $reply_address
1513 subject "I am on holiday"
1514 file $home/vacation/message
1515 once $home/vacation/once
1516 once_repeat 10d
1517 endif
1518 .endd
1519 It is tempting, when writing commands like the above, to quote the original
1520 subject in the reply. For example:
1521 .code
1522 subject "Re: $h_subject:"
1523 .endd
1524 There is a danger in doing this, however. It may allow a third party to
1525 subscribe you to an opt-in mailing list, provided that the list accepts bounce
1526 messages as subscription confirmations. (Messages sent from filters are always
1527 sent as bounce messages.) Well-managed lists require a non-bounce message to
1528 confirm a subscription, so the danger is relatively small.
1529
1530 If prefixes or suffixes are in use for local parts &-- something which depends
1531 on the configuration of Exim (see section &<<SECTmbox>>& below) &-- the tests
1532 for the current user are done with the full address (including the prefix and
1533 suffix, if any) as well as with the prefix and suffix removed. If the system is
1534 configured to rewrite local parts of mail addresses, for example, to rewrite
1535 &`dag46`& as &`Dirk.Gently`&, the rewritten form of the address is also used in
1536 the tests.
1537
1538
1539
1540 .section "Alias addresses for the personal condition" "SEC28"
1541 It is quite common for people who have mail accounts on a number of different
1542 systems to forward all their mail to one system, and in this case a check for
1543 personal mail should test all their various mail addresses. To allow for this,
1544 the &(personal)& condition keyword can be followed by
1545 .display
1546 &`alias `&<&'address'&>
1547 .endd
1548 any number of times, for example:
1549 .code
1550 if personal alias smith@else.where.example
1551             alias jones@other.place.example
1552 then ...
1553 .endd
1554 The alias addresses are treated as alternatives to the current user's email
1555 address when testing the contents of header lines.
1556
1557
1558 .section "Details of the personal condition" "SEC29"
1559 The basic &(personal)& test is roughly equivalent to the following:
1560 .code
1561 not error_message and
1562 $message_headers does not contain "\nList-Id:" and
1563 $message_headers does not contain "\nList-Help:" and
1564 $message_headers does not contain "\nList-Subscribe:" and
1565 $message_headers does not contain "\nList-Unsubscribe:" and
1566 $message_headers does not contain "\nList-Post:" and
1567 $message_headers does not contain "\nList-Owner:" and
1568 $message_headers does not contain "\nList-Archive:" and
1569 (
1570 "${if def:h_auto-submitted:{present}{absent}}" is "absent" or
1571 $header_auto-submitted: is "no"
1572 ) and
1573 $header_precedence: does not contain "bulk" and
1574 $header_precedence: does not contain "list" and
1575 $header_precedence: does not contain "junk" and
1576 foranyaddress $header_to:
1577 ( $thisaddress contains "$local_part$domain" ) and
1578 not foranyaddress $header_from:
1579 (
1580 $thisaddress contains "$local_part@$domain" or
1581 $thisaddress contains "server@" or
1582 $thisaddress contains "daemon@" or
1583 $thisaddress contains "root@" or
1584 $thisaddress contains "listserv@" or
1585 $thisaddress contains "majordomo@" or
1586 $thisaddress contains "-request@" or
1587 $thisaddress matches  "^owner-[^@]+@"
1588 )
1589 .endd
1590 The variable &$local_part$& contains the local part of the mail address of
1591 the user whose filter file is being run &-- it is normally your login id. The
1592 &$domain$& variable contains the mail domain. As explained above, if aliases
1593 or rewriting are defined, or if prefixes or suffixes are in use, the tests for
1594 the current user are also done with alternative addresses.
1595
1596
1597
1598
1599 .section "Testing delivery status" "SEC30"
1600 There are two conditions that are intended mainly for use in system filter
1601 files, but which are available in users' filter files as well. The condition
1602 &(first_delivery)& is true if this is the first process that is attempting to
1603 deliver the message, and false otherwise. This indicator is not reset until the
1604 first delivery process successfully terminates; if there is a crash or a power
1605 failure (for example), the next delivery attempt is also a &"first delivery"&.
1606
1607 In a user filter file &(first_delivery)& will be false if there was previously
1608 an error in the filter, or if a delivery for the user failed owing to, for
1609 example, a quota error, or if forwarding to a remote address was deferred for
1610 some reason.
1611
1612 The condition &(manually_thawed)& is true if the message was &"frozen"& for
1613 some reason, and was subsequently released by the system administrator. It is
1614 unlikely to be of use in users' filter files.
1615
1616
1617 .section "Multiple personal mailboxes" "SECTmbox" "SEC31"
1618 The system administrator can configure Exim so that users can set up variants
1619 on their email addresses and handle them separately. Consult your system
1620 administrator or local documentation to see if this facility is enabled on your
1621 system, and if so, what the details are.
1622
1623 The facility involves the use of a prefix or a suffix on an email address. For
1624 example, all mail addressed to &'lg303-'&<&'something'&> would be the property
1625 of user &'lg303'&, who could determine how it was to be handled, depending on
1626 the value of <&'something'&>.
1627
1628 There are two possible ways in which this can be set up. The first possibility
1629 is the use of multiple &_.forward_& files. In this case, mail to &'lg303-foo'&,
1630 for example, is handled by looking for a file called &_.forward-foo_& in
1631 &'lg303'&'s home directory. If such a file does not exist, delivery fails
1632 and the message is returned to its sender.
1633
1634 The alternative approach is to pass all messages through a single &_.forward_&
1635 file, which must be a filter file so that it can distinguish between the
1636 different cases by referencing the variables &$local_part_prefix$& or
1637 &$local_part_suffix$&, as in the final example in section &<<SECTex>>& below.
1638
1639 It is possible to configure Exim to support both schemes at once. In this case,
1640 a specific &_.forward-foo_& file is first sought; if it is not found, the basic
1641 &_.forward_& file is used.
1642
1643 The &(personal)& test (see section &<<SECTpersonal>>&) includes prefixes and
1644 suffixes in its checking.
1645
1646
1647
1648 .section "Ignoring delivery errors" "SEC43"
1649 As was explained above, filtering just sets up addresses for delivery &-- no
1650 deliveries are actually done while a filter file is active. If any of the
1651 generated addresses subsequently suffers a delivery failure, an error message
1652 is generated in the normal way. However, if a filter command that sets up a
1653 delivery is preceded by the word &"noerror"&, errors for that delivery,
1654 and any deliveries consequent on it (that is, from alias, forwarding, or
1655 filter files it invokes) are ignored.
1656
1657
1658
1659 .section "Examples of Exim filter commands" "SECTex"
1660 Simple forwarding:
1661
1662 .code
1663 # Exim filter
1664 deliver baggins@rivendell.middle-earth.example
1665 .endd
1666
1667 Vacation handling using traditional means, assuming that the &_.vacation.msg_&
1668 and other files have been set up in your home directory:
1669
1670 .code
1671 # Exim filter
1672 unseen pipe "/usr/ucb/vacation \"$local_part\""
1673 .endd
1674
1675 Vacation handling inside Exim, having first created a file called
1676 &_.vacation.msg_& in your home directory:
1677
1678 .code
1679 # Exim filter
1680 if personal then vacation endif
1681 .endd
1682
1683 File some messages by subject:
1684
1685 .code
1686 # Exim filter
1687 if $header_subject: contains "empire" or
1688 $header_subject: contains "foundation"
1689 then
1690 save $home/mail/f+e
1691 endif
1692 .endd
1693
1694 Save all non-urgent messages by weekday:
1695
1696 .code
1697 # Exim filter
1698 if $header_subject: does not contain "urgent" and
1699 $tod_full matches "^(...),"
1700 then
1701 save $home/mail/$1
1702 endif
1703 .endd
1704
1705 Throw away all mail from one site, except from postmaster:
1706
1707 .code
1708 # Exim filter
1709 if $reply_address contains "@spam.site.example" and
1710 $reply_address does not contain "postmaster@"
1711 then
1712 seen finish
1713 endif
1714 .endd
1715
1716 Handle multiple personal mailboxes:
1717
1718 .code
1719 # Exim filter
1720 if $local_part_suffix is "-foo"
1721 then
1722 save $home/mail/foo
1723 elif $local_part_suffix is "-bar"
1724 then
1725 save $home/mail/bar
1726 endif
1727 .endd
1728