maddy

 1# Milter client
 2
 3The 'milter' implements subset of Sendmail's milter protocol that can be used
 4to integrate external software with maddy.
 5maddy implements version 6 of the protocol, older versions are
 6not supported.
 7
 8Notable limitations of protocol implementation in maddy include:
 91. Changes of envelope sender address are not supported
102. Removal and addition of envelope recipients is not supported
113. Removal and replacement of header fields is not supported
124. Headers fields can be inserted only on top
135. Milter does not receive some "macros" provided by sendmail.
14
15Restrictions 1 and 2 are inherent to the maddy checks interface and cannot be
16removed without major changes to it. Restrictions 3, 4 and 5 are temporary due to
17incomplete implementation.
18
19```
20check.milter {
21	endpoint <endpoint>
22	fail_open false
23}
24
25milter <endpoint>
26```
27
28## Arguments
29
30When defined inline, the first argument specifies endpoint to access milter
31via. See below.
32
33## Configuration directives
34
35### endpoint _scheme://path_
36Default: not set
37
38Specifies milter protocol endpoint to use.
39The endpoit is specified in standard URL-like format:
40`tcp://127.0.0.1:6669` or `unix:///var/lib/milter/filter.sock`
41
42---
43
44### fail_open _boolean_
45Default: `false`
46
47Toggles behavior on milter I/O errors. If false ("fail closed") - message is
48rejected with temporary error code. If true ("fail open") - check is skipped.
49