You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-34Lines changed: 38 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
4
4
[![NPM][npm-img]][npm-url]
5
5
6
-
# haraka-plugin-dns-lists
6
+
# haraka-plugin-dns-list
7
7
8
8
## dns lists
9
9
10
-
Looks up the IP address of the remote host in a IP list(s). There are several types of DNS based lists:
10
+
Looks up the IP address of the remote host in DNS lists. There are several types of DNS based lists:
11
11
12
12
### block
13
13
14
-
Block lists (aka: DNSBL) are designed to be used for blocking mail from any host listed in them. Block lists are the most common DNS list type and lists without a type specifier are considered block lists. The default action for block lists is the reject the connection. This can be changed by setting `reject=false` in the zone's settings block.
14
+
Block lists (aka: DNSBL) are designed to be used for blocking mail from any host listed in them. Block lists are the most common DNS list type and lists without a type specified are considered block lists. The default action for block lists is to reject the connection. This can be changed by setting `reject=false` in the zone's settings block.
15
15
16
16
17
17
### allow
@@ -20,6 +20,10 @@ When the remote IP is found in an allow list, this plugin returns OK for the ehl
20
20
21
21
IMPORTANT! The order of plugins in config/plugins is important when this feature is used. It should be listed *before* any plugins that you wish to skip, but after any plugins that accept recipients.
22
22
23
+
### karma
24
+
25
+
Karma lists can have different results for IPs beyond a simple block or allow. See [hostkarma.junkemailfilter.com](https://hostkarma.junkemailfilter.com) for details.
26
+
23
27
24
28
## INSTALL
25
29
@@ -55,38 +59,41 @@ An array or comma separated list of zones to query.
55
59
56
60
#### [main] search: (default: all)
57
61
58
-
- first: consider first DNSBL response conclusive. End processing.
59
-
- all: process all DNSBL results
62
+
- first: consider first DNS list response conclusive. End processing.
63
+
- all: process all DNS list results
60
64
61
65
62
66
#### [stats] enable=true
63
67
64
-
To use this feature you must have installed and configured the 'redis' plugin.
65
-
66
-
When enabled, this will record several list statistics to redis.
67
-
68
-
It will track the total number of queries (TOTAL) and the average response time (AVG\_RT) and the return type (e.g. LISTED or ERROR) to a redis hash where the key is 'dns-list-stat:zone' and the hash field is the response type.
69
-
70
-
It will also track the positive response overlap between the lists in another redis hash where the key is 'dns-list-overlap:zone' and the hash field is the other list names.
68
+
This feature requires the 'redis' plugin. When enabled, this will record several list statistics to redis:
to a redis hash where the key is 'dns-list-stat:zone' and the hash field is the response type.
75
+
76
+
It will also track the positive response overlap between the lists in another redis hash where the key is 'dns-list-overlap:zone' and the hash field is the other list names. Example:
@@ -98,16 +105,13 @@ In the form of `host:port` this option allows you to specify a different host on
98
105
The exact name of the DNS zone (as specified above in main.zones) may contain settings about that DNS list.
99
106
100
107
* type=[ block, allow, karma ]
101
-
* reject (default: true)
102
-
Reject connections from IPs on block lists. Setting this to false makes dnsbl informational. reject=false is best used in conjunction with plugins like [karma](/manual/plugins/karma.html) that employ a scoring engine to make choices about message delivery.
108
+
* reject=true (default: true) Reject connections from IPs on block lists. Setting this to false makes dnsbl informational. reject=false is best used in conjunction with plugins like [karma](/manual/plugins/karma.html) that employ a scoring engine to make choices about message delivery.
103
109
* ipv6=true | false
104
110
105
111
106
-
<!-- leave these buried at the bottom of the document -->
0 commit comments