1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
=====================
Subscription services
=====================
The ``ISubscriptionService`` utility provides higher level convenience methods
useful for searching, retrieving, iterating, and removing memberships across
all mailing lists on th esystem. Adding new users is handled by the
``IRegistrar`` interface.
>>> from mailman.interfaces.subscriptions import ISubscriptionService
>>> from zope.component import getUtility
>>> service = getUtility(ISubscriptionService)
You can use the service to get all members of all mailing lists, for any
membership role. At first, there are no memberships.
>>> service.get_members()
[]
>>> sum(1 for member in service)
0
>>> from uuid import UUID
>>> print(service.get_member(UUID(int=801)))
None
Listing members
===============
When there are some members, of any role on any mailing list, they can be
retrieved through the subscription service.
>>> from mailman.app.lifecycle import create_list
>>> ant = create_list('ant@example.com')
>>> bee = create_list('bee@example.com')
>>> cat = create_list('cat@example.com')
Some people become members.
>>> from mailman.interfaces.member import MemberRole
>>> from mailman.testing.helpers import subscribe
>>> anne_1 = subscribe(ant, 'Anne')
>>> anne_2 = subscribe(ant, 'Anne', MemberRole.owner)
>>> bart_1 = subscribe(ant, 'Bart', MemberRole.moderator)
>>> bart_2 = subscribe(bee, 'Bart', MemberRole.owner)
>>> anne_3 = subscribe(cat, 'Anne', email='anne@example.com')
>>> cris_1 = subscribe(cat, 'Cris')
The service can be used to iterate over them.
>>> for member in service.get_members():
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Bart Person <bperson@example.com>
on bee@example.com as MemberRole.owner>
<Member: Anne Person <anne@example.com>
on cat@example.com as MemberRole.member>
<Member: Cris Person <cperson@example.com>
on cat@example.com as MemberRole.member>
The service can also be used to get the information about a single member.
>>> print(service.get_member(bart_2.member_id))
<Member: Bart Person <bperson@example.com>
on bee@example.com as MemberRole.owner>
There is an iteration shorthand for getting all the members.
>>> for member in service:
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Bart Person <bperson@example.com>
on bee@example.com as MemberRole.owner>
<Member: Anne Person <anne@example.com>
on cat@example.com as MemberRole.member>
<Member: Cris Person <cperson@example.com>
on cat@example.com as MemberRole.member>
Searching for members
=====================
The subscription service can be used to find memberships based on specific
search criteria. For example, we can find all the mailing lists that Anne is
a member of with her ``aperson@example.com`` address.
>>> for member in service.find_members('aperson@example.com'):
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
There may be no matching memberships.
>>> list(service.find_members('dave@example.com'))
[]
The address may contain asterisks, which will be interpreted as a wildcard in
the search pattern.
>>> for member in service.find_members('*person*'):
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
<Member: Bart Person <bperson@example.com>
on bee@example.com as MemberRole.owner>
<Member: Cris Person <cperson@example.com>
on cat@example.com as MemberRole.member>
Memberships can also be searched for by user id.
>>> for member in service.find_members(anne_1.user.user_id):
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
You can find all the memberships for a specific mailing list.
>>> for member in service.find_members(list_id='ant.example.com'):
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
You can find all the memberships for an address on a specific mailing list,
but you have to give it the list id, not the fqdn listname since the former is
stable but the latter could change if the list is moved.
>>> for member in service.find_members(
... 'bperson@example.com', 'ant.example.com'):
... print(member)
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
You can find all the memberships for an address with a specific role.
>>> for member in service.find_members(
... list_id='ant.example.com', role=MemberRole.owner):
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
You can also find a specific membership by all three criteria.
>>> for member in service.find_members(
... 'bperson@example.com', 'bee.example.com', MemberRole.owner):
... print(member)
<Member: Bart Person <bperson@example.com>
on bee@example.com as MemberRole.owner>
Finding a single member
=======================
If you expect only zero or one member to match your criteria, you can use a
the more efficient ``find_member()`` method. This takes exactly the same
criteria as ``find_members()``.
There may be no matching members.
>>> print(service.find_member('dave@example.com'))
None
But if there is exactly one membership, it is returned.
>>> service.find_member('bperson@example.com', 'ant.example.com')
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
Removing members
================
Members can be removed via this service.
>>> len(service.get_members())
6
>>> service.leave('cat.example.com', 'cperson@example.com')
>>> len(service.get_members())
5
>>> for member in service:
... print(member)
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.owner>
<Member: Bart Person <bperson@example.com>
on ant@example.com as MemberRole.moderator>
<Member: Anne Person <aperson@example.com>
on ant@example.com as MemberRole.member>
<Member: Bart Person <bperson@example.com>
on bee@example.com as MemberRole.owner>
<Member: Anne Person <anne@example.com>
on cat@example.com as MemberRole.member>
|
