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 list [--white] [--grey] [--black]
67 Print available (original/unhashed) data items from the corre‐
68 sponding list(s).
69 NOTE: Internally, greylistd(8) hashes the provided data into a
71 single 32-bit value for efficiency. Prior to version 0.6, the
72 original data was not retained; as of version 0.6, data is saved
73 if the "savetriplets" setting in the [data] section of the con‐
74 figuration file is "true". Only data items (i.e. triplets) that
75 have been seen while this setting were enabled can be listed.
76 save Force greylist data to be immediately saved (synchronized) to
78 the filesystem.
79 Data is also saved after any operation if a certain update
81 interval (default is 300 seconds/5 minutes) has elapsed since
82 the last save, and there are no pending requests to
83 greylistd(8).
84 reload Save greylist data to files, then reload configuration and data.
87 clear [--white] [--grey] [--black]
90 Clear all items in the specified list(s), or all lists if none
91 is specified.
92 If the whitelist is cleared, all new data trilplets will ini‐
94 tially be in a "grey" state.
95 Use with caution!
97
99 greylist add --white 1.2.3.4 mailinglist@somewhere subscriber@yourhost
100 Whitelists messages received from the IP address 1.2.3.4 on
101 behalf of <mailinglist@somewhere> to <subscriber@yourhost>.
102 greylist check --grey 1.2.3.4 mailinglist@somewhere subscriber@yourhost
104 Prints "true" or "false" on standard output, depending on
105 whether mail received from the IP address 1.2.3.4 on behalf of
106 <mailinglist@somewhere> to <subscriber@yourhost> should be
107 deferred or not, respectively. The data is neither recorded nor
108 changed to a "white" state.
109
111 /var/run/greylistd/socket
112 The UNIX domain socket providing the main interface to "greylistd".
113
115 This python script and manual page is written by Tor Slettnes, origi‐
116 nally for Debian GNU/Linux.
117
119 Copyright © 2004-2005 Tor Slettnes.
120 This program is free software; you can redistribute it and/or
122 modify it under the terms of the GNU General Public License as
123 published by the Free Software Foundation; either version 2 of
124 the License, or (at your option) any later version.
125 This program is distributed in the hope that it will be useful,
127 but WITHOUT ANY WARRANTY; without even the implied warranty of
128 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
129 GNU General Public License for more details.
130 On a Debian GNU/Linux system, the full text of the GPL is available in
132 /usr/share/common-licenses/GPL. It is also available at:
133 http://www.gnu.org/licenses/gpl.html
134
136 greylistd(8)
137 Greylisting daemon.
138 greylistd-setup-exim4(8)
140 Utility to add/remove support for greylistd in Exim 4 configura‐
141 tion files.
142Tor Slettnes 0.8 greylist(1)