maddy

 1# rspamd
 2
 3The 'rspamd' module implements message filtering by contacting the rspamd
 4server via HTTP API.
 5
 6```
 7check.rspamd {
 8	tls_client { ... }
 9	api_path http://127.0.0.1:11333
10	settings_id whatever
11	tag maddy
12	hostname mx.example.org
13	io_error_action ignore
14	error_resp_action ignore
15	add_header_action quarantine
16	rewrite_subj_action quarantine
17	flags pass_all
18}
19
20rspamd http://127.0.0.1:11333
21```
22
23## Configuration directives
24
25### tls_client { ... }
26Default: not set
27
28Configure TLS client if HTTPS is used. See [TLS configuration / Client](/reference/tls/#client) for details.
29
30---
31
32### api_path _url_
33Default: `http://127.0.0.1:11333`
34
35URL of HTTP API endpoint. Supports both HTTP and HTTPS and can include
36path element.
37
38---
39
40### settings_id _string_
41Default: not set
42
43Settings ID to pass to the server.
44
45---
46
47### tag _string_
48Default: `maddy`
49
50Value to send in MTA-Tag header field.
51
52---
53
54### hostname _string_ <br>
55Default: value of global directive
56
57Value to send in MTA-Name header field.
58
59---
60
61### io_error_action _action_
62Default: `ignore`
63
64Action to take in case of inability to contact the rspamd server.
65
66---
67
68### error_resp_action _action_
69Default: `ignore`
70
71Action to take in case of 5xx or 4xx response received from the rspamd server.
72
73---
74
75### add_header_action _action_
76Default: `quarantine`
77
78Action to take when rspamd requests to "add header".
79
80X-Spam-Flag and X-Spam-Score are added to the header irregardless of value.
81
82---
83
84### rewrite_subj_action _action_
85Default: `quarantine`
86
87Action to take when rspamd requests to "rewrite subject".
88
89X-Spam-Flag and X-Spam-Score are added to the header irregardless of value.
90
91---
92
93### flags _string-list..._
94Default: `pass_all`
95
96Flags to pass to the rspamd server.
97See [https://rspamd.com/doc/architecture/protocol.html](https://rspamd.com/doc/architecture/protocol.html) for details.