1greylist(1) Mail Administration greylist(1)
2
6 greylist - command line interface to greylistd(8)
7
9 greylist { -h | --help | help }
10 greylist operation ...
11
13 This program provides a command line interface to greylistd(8); please
14 refer to that manual page for more information on the purpose and func‐
15 tionality of this program.
16
20 In the following discussion, data... typically refers to the following
21 triplet of information:
22 <sending host's IP address> <sender@address> <recipient@address>
24 The following operations are available:
26 add [--white|--grey|--black] data...
28 Add data to the corresponding list (white if unspecified). If
29 the triplet of a future mail deliveriy (subject to timeouts)
30 matches this data, the idea is that the message would be
31 accepted, temporarily rejected, or permanently rejected, respec‐
32 tively.
33 delete data...
35 Remove data from all lists. If the data exists in any list, the
36 command returns an exit status of 0, otherwise -1. A message is
37 printed on standard output indicating the action taken.
38 check [--white|--grey|--black] data...
40 Check the current status of data, i.e. if a message delivery
41 would succeed if its triplet matched this data. If a list is
42 specified, the word "true" or "false" is printed, indicating
43 whether the data was in the corresponding list; the exit status
44 is also set accordingly. Otherwise, one of the words "white",
45 "grey", and "black" is written on standard output, and the exit
46 status is 0, 1, or 2, respectively.
47 NOTE: This operation is non-intrusive, and thus does not update
49 any of the greylist data. So, for instance, if the data is cur‐
50 rently in the "grey" list, but its minimum retry time (retryMin)
51 has elapsed, the text "white" would be printed. However, unless
52 an update takes place prior to the retryMax timeout, the data
53 would still expire from the "grey" list.
54 update [--white|--grey|--black] data...
56 Same, but also update the greylist data accordingly. So if data
57 is currently greylisted, but the minimum retry time retryMin has
58 elapsed since it was first seen, data is moved to the "white"
59 list.
60 This operation would normally be used by mail transport agents
62 (MTAs).
63 stats Print some statistics on greylist utilization and hits.
65 mrtg Print statistics on greylist and whitelist hits in a format that
67 MRTG can use as an External Monitoring Script.
68 list [--white] [--grey] [--black]
70 Print available (original/unhashed) data items from the corre‐
71 sponding list(s).
72 NOTE: Internally, greylistd(8) hashes the provided data into a
74 single 32-bit value for efficiency. Prior to version 0.6, the
75 original data was not retained; as of version 0.6, data is saved
76 if the "savetriplets" setting in the [data] section of the con‐
77 figuration file is "true". Only data items (i.e. triplets) that
78 have been seen while this setting were enabled can be listed.
79 save Force greylist data to be immediately saved (synchronized) to
81 the filesystem.
82 Data is also saved after any operation if a certain update
84 interval (default is 300 seconds/5 minutes) has elapsed since
85 the last save, and there are no pending requests to
86 greylistd(8).
87 reload Save greylist data to files, then reload configuration and data.
90 clear [--white] [--grey] [--black]
93 Clear all items in the specified list(s), or all lists if none
94 is specified.
95 If the whitelist is cleared, all new data trilplets will ini‐
97 tially be in a "grey" state.
98 Use with caution!
100
102 greylist add --white 1.2.3.4 mailinglist@somewhere subscriber@yourhost
103 Whitelists messages received from the IP address 1.2.3.4 on
104 behalf of <mailinglist@somewhere> to <subscriber@yourhost>.
105 greylist check --grey 1.2.3.4 mailinglist@somewhere subscriber@yourhost
107 Prints "true" or "false" on standard output, depending on
108 whether mail received from the IP address 1.2.3.4 on behalf of
109 <mailinglist@somewhere> to <subscriber@yourhost> should be
110 deferred or not, respectively. The data is neither recorded nor
111 changed to a "white" state.
112
114 /var/run/greylistd/socket
115 The UNIX domain socket providing the main interface to "greylistd".
116
118 This python script and manual page is written by Tor Slettnes, origi‐
119 nally for Debian GNU/Linux.
120
122 Copyright © 2004-2005 Tor Slettnes.
123 This program is free software; you can redistribute it and/or
125 modify it under the terms of the GNU General Public License as
126 published by the Free Software Foundation; either version 2 of
127 the License, or (at your option) any later version.
128 This program is distributed in the hope that it will be useful,
130 but WITHOUT ANY WARRANTY; without even the implied warranty of
131 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
132 GNU General Public License for more details.
133 On a Debian GNU/Linux system, the full text of the GPL is available in
135 /usr/share/common-licenses/GPL. It is also available at:
136 http://www.gnu.org/licenses/gpl.html
137
139 greylistd(8)
140 Greylisting daemon.
141 greylistd-setup-exim4(8)
143 Utility to add/remove support for greylistd in Exim 4 configura‐
144 tion files.
145Tor Slettnes 0.8 greylist(1)