Testsuite: ensure logging path is set
[exim.git] / doc / doc-txt / experimental-spec.txt
CommitLineData
7bafa7d9
TK
1From time to time, experimental features may be added to Exim.
2While a feature is experimental, there will be a build-time
3option whose name starts "EXPERIMENTAL_" that must be set in
4order to include the feature. This file contains information
d36a0501
PP
5about experimental features, all of which are unstable and
6liable to incompatible change.
ee161e8f
PH
7
8
4c04137d 9Brightmail AntiSpam (BMI) support
ee161e8f
PH
10--------------------------------------------------------------
11
12Brightmail AntiSpam is a commercial package. Please see
13http://www.brightmail.com for more information on
14the product. For the sake of clarity, we'll refer to it as
15"BMI" from now on.
16
17
180) BMI concept and implementation overview
19
20In contrast to how spam-scanning with SpamAssassin is
21implemented in exiscan-acl, BMI is more suited for per
22-recipient scanning of messages. However, each messages is
23scanned only once, but multiple "verdicts" for multiple
24recipients can be returned from the BMI server. The exiscan
25implementation passes the message to the BMI server just
26before accepting it. It then adds the retrieved verdicts to
27the messages header file in the spool. These verdicts can then
28be queried in routers, where operation is per-recipient
29instead of per-message. To use BMI, you need to take the
30following steps:
31
32 1) Compile Exim with BMI support
3ec3e3bb 33 2) Set up main BMI options (top section of Exim config file)
ee161e8f
PH
34 3) Set up ACL control statement (ACL section of the config
35 file)
36 4) Set up your routers to use BMI verdicts (routers section
37 of the config file).
38 5) (Optional) Set up per-recipient opt-in information.
39
8ff3788c 40These four steps are explained in more details below.
ee161e8f
PH
41
421) Adding support for BMI at compile time
43
44 To compile with BMI support, you need to link Exim against
4c04137d 45 the Brightmail client SDK, consisting of a library
ee161e8f
PH
46 (libbmiclient_single.so) and a header file (bmi_api.h).
47 You'll also need to explicitly set a flag in the Makefile to
48 include BMI support in the Exim binary. Both can be achieved
49 with these lines in Local/Makefile:
50
51 EXPERIMENTAL_BRIGHTMAIL=yes
47bbda99 52 CFLAGS=-I/path/to/the/dir/with/the/includefile
ee161e8f 53 EXTRALIBS_EXIM=-L/path/to/the/dir/with/the/library -lbmiclient_single
8ff3788c 54
ee161e8f
PH
55 If you use other CFLAGS or EXTRALIBS_EXIM settings then
56 merge the content of these lines with them.
57
7c0c8547 58 Note for BMI6.x users: You'll also have to add -lxml2_single
ee161e8f
PH
59 to the EXTRALIBS_EXIM line. Users of 5.5x do not need to do
60 this.
8ff3788c 61
ee161e8f
PH
62 You should also include the location of
63 libbmiclient_single.so in your dynamic linker configuration
64 file (usually /etc/ld.so.conf) and run "ldconfig"
65 afterwards, or else the produced Exim binary will not be
66 able to find the library file.
67
68
3ec3e3bb 692) Setting up BMI support in the Exim main configuration
ee161e8f 70
3ec3e3bb 71 To enable BMI support in the main Exim configuration, you
ee161e8f
PH
72 should set the path to the main BMI configuration file with
73 the "bmi_config_file" option, like this:
8ff3788c 74
ee161e8f 75 bmi_config_file = /opt/brightmail/etc/brightmail.cfg
8ff3788c 76
3ec3e3bb 77 This must go into section 1 of Exim's configuration file (You
ee161e8f
PH
78 can put it right on top). If you omit this option, it
79 defaults to /opt/brightmail/etc/brightmail.cfg.
80
81 Note for BMI6.x users: This file is in XML format in V6.xx
82 and its name is /opt/brightmail/etc/bmiconfig.xml. So BMI
83 6.x users MUST set the bmi_config_file option.
8ff3788c 84
ee161e8f
PH
85
863) Set up ACL control statement
87
88 To optimize performance, it makes sense only to process
89 messages coming from remote, untrusted sources with the BMI
90 server. To set up a messages for processing by the BMI
91 server, you MUST set the "bmi_run" control statement in any
92 ACL for an incoming message. You will typically do this in
93 an "accept" block in the "acl_check_rcpt" ACL. You should
94 use the "accept" block(s) that accept messages from remote
95 servers for your own domain(s). Here is an example that uses
3ec3e3bb 96 the "accept" blocks from Exim's default configuration file:
8ff3788c 97
ee161e8f
PH
98
99 accept domains = +local_domains
100 endpass
101 verify = recipient
102 control = bmi_run
103
104 accept domains = +relay_to_domains
105 endpass
106 verify = recipient
107 control = bmi_run
8ff3788c 108
ee161e8f
PH
109 If bmi_run is not set in any ACL during reception of the
110 message, it will NOT be passed to the BMI server.
111
112
1134) Setting up routers to use BMI verdicts
114
115 When a message has been run through the BMI server, one or
116 more "verdicts" are present. Different recipients can have
117 different verdicts. Each recipient is treated individually
118 during routing, so you can query the verdicts by recipient
3ec3e3bb 119 at that stage. From Exim's view, a verdict can have the
ee161e8f 120 following outcomes:
8ff3788c 121
ee161e8f
PH
122 o deliver the message normally
123 o deliver the message to an alternate location
124 o do not deliver the message
8ff3788c 125
ee161e8f
PH
126 To query the verdict for a recipient, the implementation
127 offers the following tools:
8ff3788c
TK
128
129
ee161e8f
PH
130 - Boolean router preconditions. These can be used in any
131 router. For a simple implementation of BMI, these may be
132 all that you need. The following preconditions are
133 available:
8ff3788c 134
ee161e8f 135 o bmi_deliver_default
8ff3788c 136
ee161e8f
PH
137 This precondition is TRUE if the verdict for the
138 recipient is to deliver the message normally. If the
139 message has not been processed by the BMI server, this
140 variable defaults to TRUE.
8ff3788c 141
ee161e8f 142 o bmi_deliver_alternate
8ff3788c 143
ee161e8f
PH
144 This precondition is TRUE if the verdict for the
145 recipient is to deliver the message to an alternate
146 location. You can get the location string from the
147 $bmi_alt_location expansion variable if you need it. See
148 further below. If the message has not been processed by
149 the BMI server, this variable defaults to FALSE.
8ff3788c 150
ee161e8f 151 o bmi_dont_deliver
8ff3788c 152
ee161e8f
PH
153 This precondition is TRUE if the verdict for the
154 recipient is NOT to deliver the message to the
155 recipient. You will typically use this precondition in a
156 top-level blackhole router, like this:
8ff3788c 157
ee161e8f
PH
158 # don't deliver messages handled by the BMI server
159 bmi_blackhole:
160 driver = redirect
161 bmi_dont_deliver
162 data = :blackhole:
8ff3788c 163
ee161e8f
PH
164 This router should be on top of all others, so messages
165 that should not be delivered do not reach other routers
166 at all. If the message has not been processed by
167 the BMI server, this variable defaults to FALSE.
8ff3788c
TK
168
169
ee161e8f
PH
170 - A list router precondition to query if rules "fired" on
171 the message for the recipient. Its name is "bmi_rule". You
172 use it by passing it a colon-separated list of rule
173 numbers. You can use this condition to route messages that
174 matched specific rules. Here is an example:
8ff3788c 175
ee161e8f
PH
176 # special router for BMI rule #5, #8 and #11
177 bmi_rule_redirect:
178 driver = redirect
179 bmi_rule = 5:8:11
180 data = postmaster@mydomain.com
8ff3788c
TK
181
182
ee161e8f
PH
183 - Expansion variables. Several expansion variables are set
184 during routing. You can use them in custom router
185 conditions, for example. The following variables are
186 available:
8ff3788c 187
ee161e8f 188 o $bmi_base64_verdict
8ff3788c 189
ee161e8f
PH
190 This variable will contain the BASE64 encoded verdict
191 for the recipient being routed. You can use it to add a
192 header to messages for tracking purposes, for example:
8ff3788c 193
ee161e8f
PH
194 localuser:
195 driver = accept
196 check_local_user
197 headers_add = X-Brightmail-Verdict: $bmi_base64_verdict
198 transport = local_delivery
8ff3788c 199
ee161e8f
PH
200 If there is no verdict available for the recipient being
201 routed, this variable contains the empty string.
8ff3788c 202
ee161e8f 203 o $bmi_base64_tracker_verdict
8ff3788c 204
ee161e8f
PH
205 This variable will contain a BASE64 encoded subset of
206 the verdict information concerning the "rules" that
207 fired on the message. You can add this string to a
208 header, commonly named "X-Brightmail-Tracker". Example:
8ff3788c 209
ee161e8f
PH
210 localuser:
211 driver = accept
212 check_local_user
213 headers_add = X-Brightmail-Tracker: $bmi_base64_tracker_verdict
214 transport = local_delivery
8ff3788c 215
ee161e8f
PH
216 If there is no verdict available for the recipient being
217 routed, this variable contains the empty string.
8ff3788c 218
ee161e8f 219 o $bmi_alt_location
8ff3788c 220
ee161e8f
PH
221 If the verdict is to redirect the message to an
222 alternate location, this variable will contain the
223 alternate location string returned by the BMI server. In
224 its default configuration, this is a header-like string
225 that can be added to the message with "headers_add". If
226 there is no verdict available for the recipient being
227 routed, or if the message is to be delivered normally,
228 this variable contains the empty string.
8ff3788c 229
ee161e8f 230 o $bmi_deliver
8ff3788c 231
ee161e8f
PH
232 This is an additional integer variable that can be used
233 to query if the message should be delivered at all. You
234 should use router preconditions instead if possible.
8ff3788c 235
ee161e8f
PH
236 $bmi_deliver is '0': the message should NOT be delivered.
237 $bmi_deliver is '1': the message should be delivered.
8ff3788c
TK
238
239
ee161e8f
PH
240 IMPORTANT NOTE: Verdict inheritance.
241 The message is passed to the BMI server during message
242 reception, using the target addresses from the RCPT TO:
243 commands in the SMTP transaction. If recipients get expanded
244 or re-written (for example by aliasing), the new address(es)
245 inherit the verdict from the original address. This means
246 that verdicts also apply to all "child" addresses generated
247 from top-level addresses that were sent to the BMI server.
8ff3788c
TK
248
249
ee161e8f
PH
2505) Using per-recipient opt-in information (Optional)
251
252 The BMI server features multiple scanning "profiles" for
253 individual recipients. These are usually stored in a LDAP
254 server and are queried by the BMI server itself. However,
255 you can also pass opt-in data for each recipient from the
256 MTA to the BMI server. This is particularly useful if you
3ec3e3bb 257 already look up recipient data in Exim anyway (which can
ee161e8f
PH
258 also be stored in a SQL database or other source). This
259 implementation enables you to pass opt-in data to the BMI
260 server in the RCPT ACL. This works by setting the
261 'bmi_optin' modifier in a block of that ACL. If should be
262 set to a list of comma-separated strings that identify the
263 features which the BMI server should use for that particular
264 recipient. Ideally, you would use the 'bmi_optin' modifier
265 in the same ACL block where you set the 'bmi_run' control
266 flag. Here is an example that will pull opt-in data for each
267 recipient from a flat file called
268 '/etc/exim/bmi_optin_data'.
8ff3788c 269
ee161e8f 270 The file format:
8ff3788c 271
ee161e8f
PH
272 user1@mydomain.com: <OPTIN STRING1>:<OPTIN STRING2>
273 user2@thatdomain.com: <OPTIN STRING3>
8ff3788c
TK
274
275
ee161e8f 276 The example:
8ff3788c 277
ee161e8f
PH
278 accept domains = +relay_to_domains
279 endpass
280 verify = recipient
281 bmi_optin = ${lookup{$local_part@$domain}lsearch{/etc/exim/bmi_optin_data}}
8ff3788c
TK
282 control = bmi_run
283
ee161e8f 284 Of course, you can also use any other lookup method that
3ec3e3bb 285 Exim supports, including LDAP, Postgres, MySQL, Oracle etc.,
ee161e8f
PH
286 as long as the result is a list of colon-separated opt-in
287 strings.
8ff3788c 288
ee161e8f
PH
289 For a list of available opt-in strings, please contact your
290 Brightmail representative.
ee161e8f 291
8ff3788c
TK
292
293
294
0b23848a 295SRS (Sender Rewriting Scheme) Support
ee161e8f
PH
296--------------------------------------------------------------
297
298Exiscan currently includes SRS support via Miles Wilton's
8ff3788c 299libsrs_alt library. The current version of the supported
f413521a 300library is 0.5, there are reports of 1.0 working.
ee161e8f
PH
301
302In order to use SRS, you must get a copy of libsrs_alt from
303
f413521a
PP
304https://opsec.eu/src/srs/
305
306(not the original source, which has disappeared.)
ee161e8f
PH
307
308Unpack the tarball, then refer to MTAs/README.EXIM
309to proceed. You need to set
310
311EXPERIMENTAL_SRS=yes
312
313in your Local/Makefile.
314
315
f413521a 316
0e1ccf44
PP
317DCC Support
318--------------------------------------------------------------
d36254f2 319Distributed Checksum Clearinghouse; http://www.rhyolite.com/dcc/
0e1ccf44
PP
320
321*) Building exim
322
323In order to build exim with DCC support add
324
325EXPERIMENTAL_DCC=yes
326
327to your Makefile. (Re-)build/install exim. exim -d should show
328EXPERIMENTAL_DCC under "Support for".
329
330
331*) Configuration
332
333In the main section of exim.cf add at least
334 dccifd_address = /usr/local/dcc/var/dccifd
335or
336 dccifd_address = <ip> <port>
337
338In the DATA ACL you can use the new condition
339 dcc = *
340
341After that "$dcc_header" contains the X-DCC-Header.
342
d36a0501 343Return values are:
0e1ccf44
PP
344 fail for overall "R", "G" from dccifd
345 defer for overall "T" from dccifd
346 accept for overall "A", "S" from dccifd
347
348dcc = */defer_ok works as for spamd.
349
350The "$dcc_result" variable contains the overall result from DCC
351answer. There will an X-DCC: header added to the mail.
352
353Usually you'll use
354 defer !dcc = *
355to greylist with DCC.
356
357If you set, in the main section,
358 dcc_direct_add_header = true
359then the dcc header will be added "in deep" and if the spool
360file was already written it gets removed. This forces Exim to
361write it again if needed. This helps to get the DCC Header
362through to eg. SpamAssassin.
363
364If you want to pass even more headers in the middle of the
365DATA stage you can set
366 $acl_m_dcc_add_header
05c39afa 367to tell the DCC routines to add more information; eg, you might set
0e1ccf44
PP
368this to some results from ClamAV. Be careful. Header syntax is
369not checked and is added "as is".
370
05c39afa
JH
371In case you've troubles with sites sending the same queue items from several
372hosts and fail to get through greylisting you can use
373$acl_m_dcc_override_client_ip
374
375Setting $acl_m_dcc_override_client_ip to an IP address overrides the default
376of $sender_host_address. eg. use the following ACL in DATA stage:
377
378 warn set acl_m_dcc_override_client_ip = \
379 ${lookup{$sender_helo_name}nwildlsearch{/etc/mail/multipleip_sites}{$value}{}}
380 condition = ${if def:acl_m_dcc_override_client_ip}
381 log_message = dbg: acl_m_dcc_override_client_ip set to \
382 $acl_m_dcc_override_client_ip
383
384Then set something like
385# cat /etc/mail/multipleip_sites
386mout-xforward.gmx.net 82.165.159.12
387mout.gmx.net 212.227.15.16
388
4c04137d 389Use a reasonable IP. eg. one the sending cluster actually uses.
0e1ccf44 390
48155ab3
JH
391
392
1899bab2
TL
393DMARC Support
394--------------------------------------------------------------
395
396DMARC combines feedback from SPF, DKIM, and header From: in order
397to attempt to provide better indicators of the authenticity of an
398email. This document does not explain the fundamentals, you
399should read and understand how it works by visiting the website at
400http://www.dmarc.org/.
401
402DMARC support is added via the libopendmarc library. Visit:
403
404 http://sourceforge.net/projects/opendmarc/
405
406to obtain a copy, or find it in your favorite rpm package
407repository. If building from source, this description assumes
408that headers will be in /usr/local/include, and that the libraries
409are in /usr/local/lib.
410
4111. To compile Exim with DMARC support, you must first enable SPF.
48155ab3 412Please read the Local/Makefile comments on enabling the SUPPORT_SPF
1899bab2
TL
413feature. You must also have DKIM support, so you cannot set the
414DISABLE_DKIM feature. Once both of those conditions have been met
415you can enable DMARC in Local/Makefile:
416
417EXPERIMENTAL_DMARC=yes
418LDFLAGS += -lopendmarc
419# CFLAGS += -I/usr/local/include
420# LDFLAGS += -L/usr/local/lib
421
422The first line sets the feature to include the correct code, and
423the second line says to link the libopendmarc libraries into the
424exim binary. The commented out lines should be uncommented if you
425built opendmarc from source and installed in the default location.
426Adjust the paths if you installed them elsewhere, but you do not
427need to uncomment them if an rpm (or you) installed them in the
428package controlled locations (/usr/include and /usr/lib).
429
430
4312. Use the following global settings to configure DMARC:
432
9f765fee 433Optional:
1899bab2
TL
434dmarc_tld_file Defines the location of a text file of valid
435 top level domains the opendmarc library uses
436 during domain parsing. Maintained by Mozilla,
437 the most current version can be downloaded
438 from a link at http://publicsuffix.org/list/.
9f765fee
HSHR
439 If unset, "/etc/exim/opendmarc.tlds" (hardcoded)
440 is used.
1899bab2
TL
441
442Optional:
443dmarc_history_file Defines the location of a file to log results
444 of dmarc verification on inbound emails. The
445 contents are importable by the opendmarc tools
446 which will manage the data, send out DMARC
447 reports, and expire the data. Make sure the
448 directory of this file is writable by the user
449 exim runs as.
450
451dmarc_forensic_sender The email address to use when sending a
452 forensic report detailing alignment failures
453 if a sender domain's dmarc record specifies it
454 and you have configured Exim to send them.
455 Default: do-not-reply@$default_hostname
456
457
4583. By default, the DMARC processing will run for any remote,
459non-authenticated user. It makes sense to only verify DMARC
460status of messages coming from remote, untrusted sources. You can
461use standard conditions such as hosts, senders, etc, to decide that
462DMARC verification should *not* be performed for them and disable
463DMARC with a control setting:
464
12d0043d 465 control = dmarc_disable_verify
1899bab2
TL
466
467A DMARC record can also specify a "forensic address", which gives
468exim an email address to submit reports about failed alignment.
469Exim does not do this by default because in certain conditions it
470results in unintended information leakage (what lists a user might
471be subscribed to, etc). You must configure exim to submit forensic
472reports to the owner of the domain. If the DMARC record contains a
473forensic address and you specify the control statement below, then
474exim will send these forensic emails. It's also advised that you
475configure a dmarc_forensic_sender because the default sender address
476construction might be inadequate.
477
7b2f71c1 478 control = dmarc_enable_forensic
1899bab2
TL
479
480(AGAIN: You can choose not to send these forensic reports by simply
7b2f71c1 481not putting the dmarc_enable_forensic control line at any point in
1899bab2
TL
482your exim config. If you don't tell it to send them, it will not
483send them.)
484
485There are no options to either control. Both must appear before
486the DATA acl.
487
488
4894. You can now run DMARC checks in incoming SMTP by using the
490"dmarc_status" ACL condition in the DATA ACL. You are required to
491call the spf condition first in the ACLs, then the "dmarc_status"
492condition. Putting this condition in the ACLs is required in order
493for a DMARC check to actually occur. All of the variables are set
494up before the DATA ACL, but there is no actual DMARC check that
495occurs until a "dmarc_status" condition is encountered in the ACLs.
496
497The dmarc_status condition takes a list of strings on its
498right-hand side. These strings describe recommended action based
499on the DMARC check. To understand what the policy recommendations
500mean, refer to the DMARC website above. Valid strings are:
501
502 o accept The DMARC check passed and the library recommends
503 accepting the email.
504 o reject The DMARC check failed and the library recommends
505 rejecting the email.
506 o quarantine The DMARC check failed and the library recommends
507 keeping it for further inspection.
7a8678e6 508 o none The DMARC check passed and the library recommends
509 no specific action, neutral.
1899bab2
TL
510 o norecord No policy section in the DMARC record for this
511 sender domain.
512 o nofrom Unable to determine the domain of the sender.
7a8678e6 513 o temperror Library error or dns error.
05070e30 514 o off The DMARC check was disabled for this email.
1899bab2
TL
515
516You can prefix each string with an exclamation mark to invert its
517meaning, for example "!accept" will match all results but
518"accept". The string list is evaluated left-to-right in a
519short-circuit fashion. When a string matches the outcome of the
520DMARC check, the condition succeeds. If none of the listed
521strings matches the outcome of the DMARC check, the condition
522fails.
523
524Of course, you can also use any other lookup method that Exim
525supports, including LDAP, Postgres, MySQL, etc, as long as the
8c8b8274 526result is a list of colon-separated strings.
1899bab2
TL
527
528Several expansion variables are set before the DATA ACL is
529processed, and you can use them in this ACL. The following
530expansion variables are available:
531
532 o $dmarc_status
533 This is a one word status indicating what the DMARC library
8c8b8274
TL
534 thinks of the email. It is a combination of the results of
535 DMARC record lookup and the SPF/DKIM/DMARC processing results
536 (if a DMARC record was found). The actual policy declared
537 in the DMARC record is in a separate expansion variable.
1899bab2
TL
538
539 o $dmarc_status_text
540 This is a slightly longer, human readable status.
541
542 o $dmarc_used_domain
543 This is the domain which DMARC used to look up the DMARC
544 policy record.
545
8c8b8274
TL
546 o $dmarc_domain_policy
547 This is the policy declared in the DMARC record. Valid values
548 are "none", "reject" and "quarantine". It is blank when there
549 is any error, including no DMARC record.
550
1899bab2
TL
551 o $dmarc_ar_header
552 This is the entire Authentication-Results header which you can
553 add using an add_header modifier.
554
555
5565. How to enable DMARC advanced operation:
557By default, Exim's DMARC configuration is intended to be
558non-intrusive and conservative. To facilitate this, Exim will not
559create any type of logging files without explicit configuration by
560you, the admin. Nor will Exim send out any emails/reports about
561DMARC issues without explicit configuration by you, the admin (other
562than typical bounce messages that may come about due to ACL
563processing or failure delivery issues).
564
565In order to log statistics suitable to be imported by the opendmarc
566tools, you need to:
567a. Configure the global setting dmarc_history_file.
568b. Configure cron jobs to call the appropriate opendmarc history
569 import scripts and truncating the dmarc_history_file.
570
571In order to send forensic reports, you need to:
572a. Configure the global setting dmarc_forensic_sender.
573b. Configure, somewhere before the DATA ACL, the control option to
574 enable sending DMARC forensic reports.
575
576
5776. Example usage:
578(RCPT ACL)
579 warn domains = +local_domains
580 hosts = +local_hosts
12d0043d 581 control = dmarc_disable_verify
1899bab2
TL
582
583 warn !domains = +screwed_up_dmarc_records
584 control = dmarc_enable_forensic
585
8c8b8274
TL
586 warn condition = (lookup if destined to mailing list)
587 set acl_m_mailing_list = 1
588
1899bab2
TL
589(DATA ACL)
590 warn dmarc_status = accept : none : off
591 !authenticated = *
592 log_message = DMARC DEBUG: $dmarc_status $dmarc_used_domain
593 add_header = $dmarc_ar_header
594
595 warn dmarc_status = !accept
596 !authenticated = *
597 log_message = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
598
599 warn dmarc_status = quarantine
600 !authenticated = *
601 set $acl_m_quarantine = 1
602 # Do something in a transport with this flag variable
603
8c8b8274
TL
604 deny condition = ${if eq{$dmarc_domain_policy}{reject}}
605 condition = ${if eq{$acl_m_mailing_list}{1}}
606 message = Messages from $dmarc_used_domain break mailing lists
607
1899bab2
TL
608 deny dmarc_status = reject
609 !authenticated = *
7b2f71c1 610 message = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
1899bab2
TL
611
612
613
895fbaf2
JH
614DSN extra information
615---------------------
616If compiled with EXPERIMENTAL_DSN_INFO extra information will be added
617to DSN fail messages ("bounces"), when available. The intent is to aid
618tracing of specific failing messages, when presented with a "bounce"
619complaint and needing to search logs.
620
621
622The remote MTA IP address, with port number if nonstandard.
623Example:
624 Remote-MTA: X-ip; [127.0.0.1]:587
625Rationale:
626 Several addresses may correspond to the (already available)
627 dns name for the remote MTA.
628
629The remote MTA connect-time greeting.
630Example:
631 X-Remote-MTA-smtp-greeting: X-str; 220 the.local.host.name ESMTP Exim x.yz Tue, 2 Mar 1999 09:44:33 +0000
632Rationale:
633 This string sometimes presents the remote MTA's idea of its
634 own name, and sometimes identifies the MTA software.
635
636The remote MTA response to HELO or EHLO.
637Example:
638 X-Remote-MTA-helo-response: X-str; 250-the.local.host.name Hello localhost [127.0.0.1]
639Limitations:
640 Only the first line of a multiline response is recorded.
641Rationale:
642 This string sometimes presents the remote MTA's view of
643 the peer IP connecting to it.
644
645The reporting MTA detailed diagnostic.
646Example:
647 X-Exim-Diagnostic: X-str; SMTP error from remote mail server after RCPT TO:<d3@myhost.test.ex>: 550 hard error
648Rationale:
4c04137d 649 This string sometimes give extra information over the
895fbaf2
JH
650 existing (already available) Diagnostic-Code field.
651
652
653Note that non-RFC-documented field names and data types are used.
654
655
5bde3efa
ACK
656LMDB Lookup support
657-------------------
658LMDB is an ultra-fast, ultra-compact, crash-proof key-value embedded data store.
4c04137d 659It is modeled loosely on the BerkeleyDB API. You should read about the feature
5bde3efa
ACK
660set as well as operation modes at https://symas.com/products/lightning-memory-mapped-database/
661
662LMDB single key lookup support is provided by linking to the LMDB C library.
663The current implementation does not support writing to the LMDB database.
664
665Visit https://github.com/LMDB/lmdb to download the library or find it in your
666operating systems package repository.
667
668If building from source, this description assumes that headers will be in
669/usr/local/include, and that the libraries are in /usr/local/lib.
670
6711. In order to build exim with LMDB lookup support add or uncomment
672
673EXPERIMENTAL_LMDB=yes
674
675to your Local/Makefile. (Re-)build/install exim. exim -d should show
676Experimental_LMDB in the line "Support for:".
677
678EXPERIMENTAL_LMDB=yes
679LDFLAGS += -llmdb
680# CFLAGS += -I/usr/local/include
681# LDFLAGS += -L/usr/local/lib
682
683The first line sets the feature to include the correct code, and
684the second line says to link the LMDB libraries into the
685exim binary. The commented out lines should be uncommented if you
686built LMDB from source and installed in the default location.
687Adjust the paths if you installed them elsewhere, but you do not
688need to uncomment them if an rpm (or you) installed them in the
689package controlled locations (/usr/include and /usr/lib).
690
6912. Create your LMDB files, you can use the mdb_load utility which is
692part of the LMDB distribution our your favourite language bindings.
693
6943. Add the single key lookups to your exim.conf file, example lookups
695are below.
696
697${lookup{$sender_address_domain}lmdb{/var/lib/baruwa/data/db/relaydomains.mdb}{$value}}
698${lookup{$sender_address_domain}lmdb{/var/lib/baruwa/data/db/relaydomains.mdb}{$value}fail}
699${lookup{$sender_address_domain}lmdb{/var/lib/baruwa/data/db/relaydomains.mdb}}
895fbaf2 700
ed0512a1 701
3369a853
ACK
702Queuefile transport
703-------------------
704Queuefile is a pseudo transport which does not perform final delivery.
705It simply copies the exim spool files out of the spool directory into
706an external directory retaining the exim spool format.
707
708The spool files can then be processed by external processes and then
709requeued into exim spool directories for final delivery.
710
711The motivation/inspiration for the transport is to allow external
712processes to access email queued by exim and have access to all the
713information which would not be available if the messages were delivered
714to the process in the standard email formats.
715
716The mailscanner package is one of the processes that can take advantage
717of this transport to filter email.
718
719The transport can be used in the same way as the other existing transports,
720i.e by configuring a router to route mail to a transport configured with
721the queuefile driver.
722
723The transport only takes one option:
724
725* directory - This is used to specify the directory messages should be
726copied to
727
728The generic transport options (body_only, current_directory, disable_logging,
729debug_print, delivery_date_add, envelope_to_add, event_action, group,
730headers_add, headers_only, headers_remove, headers_rewrite, home_directory,
731initgroups, max_parallel, message_size_limit, rcpt_include_affixes,
732retry_use_local_part, return_path, return_path_add, shadow_condition,
733shadow_transport, transport_filter, transport_filter_timeout, user) are
734ignored.
735
736Sample configuration:
737
738(Router)
739
740scan:
741 driver = accept
742 transport = scan
743
744(Transport)
745
746scan:
747 driver = queuefile
748 directory = /var/spool/baruwa-scanner/input
749
750
751In order to build exim with Queuefile transport support add or uncomment
752
753EXPERIMENTAL_QUEUEFILE=yes
754
755to your Local/Makefile. (Re-)build/install exim. exim -d should show
756Experimental_QUEUEFILE in the line "Support for:".
757
758
ee161e8f
PH
759--------------------------------------------------------------
760End of file
761--------------------------------------------------------------