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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
=========
Addresses
=========
The REST API can be used to manage addresses.
There are no addresses yet.
>>> dump_json('http://localhost:9001/3.0/addresses')
http_etag: "..."
start: 0
total_size: 0
When an address is created via the internal API, it is available in the REST
API.
::
>>> from zope.component import getUtility
>>> from mailman.interfaces.usermanager import IUserManager
>>> user_manager = getUtility(IUserManager)
>>> anne = user_manager.create_address('anne@example.com')
>>> transaction.commit()
>>> dump_json('http://localhost:9001/3.0/addresses')
entry 0:
email: anne@example.com
http_etag: "..."
original_email: anne@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/anne@example.com
http_etag: "..."
start: 0
total_size: 1
Anne's address can also be accessed directly.
>>> dump_json('http://localhost:9001/3.0/addresses/anne@example.com')
email: anne@example.com
http_etag: "..."
original_email: anne@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/anne@example.com
Bart registers with a mixed-case address. The canonical URL always includes
the lower-case version.
>>> bart = user_manager.create_address('Bart.Person@example.com')
>>> transaction.commit()
>>> dump_json(
... 'http://localhost:9001/3.0/addresses/bart.person@example.com')
email: bart.person@example.com
http_etag: "..."
original_email: Bart.Person@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/bart.person@example.com
But his address record can be accessed with the case-preserved version too.
>>> dump_json(
... 'http://localhost:9001/3.0/addresses/Bart.Person@example.com')
email: bart.person@example.com
http_etag: "..."
original_email: Bart.Person@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/bart.person@example.com
A non-existent email address can't be retrieved.
>>> dump_json('http://localhost:9001/3.0/addresses/nobody@example.com')
Traceback (most recent call last):
...
HTTPError: HTTP Error 404: 404 Not Found
When an address has a real name associated with it, this is also available in
the REST API.
>>> cris = user_manager.create_address('cris@example.com', 'Cris Person')
>>> transaction.commit()
>>> dump_json('http://localhost:9001/3.0/addresses/cris@example.com')
display_name: Cris Person
email: cris@example.com
http_etag: "..."
original_email: cris@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/cris@example.com
Verifying
=========
When the address gets verified, this attribute is available in the REST
representation.
>>> from mailman.utilities.datetime import now
>>> anne.verified_on = now()
>>> transaction.commit()
>>> dump_json('http://localhost:9001/3.0/addresses/anne@example.com')
email: anne@example.com
http_etag: "..."
original_email: anne@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/anne@example.com
verified_on: 2005-08-01T07:49:23
Addresses can also be verified through the REST API, by POSTing to the
'verify' sub-resource. The POST data is ignored.
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'cris@example.com/verify', {})
content-length: 0
date: ...
server: ...
status: 204
Now Cris's address is verified.
>>> dump_json('http://localhost:9001/3.0/addresses/cris@example.com')
display_name: Cris Person
email: cris@example.com
http_etag: "..."
original_email: cris@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/cris@example.com
verified_on: 2005-08-01T07:49:23
If you should ever need to 'unverify' an address, POST to the 'unverify'
sub-resource. Again, the POST data is ignored.
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'cris@example.com/unverify', {})
content-length: 0
date: ...
server: ...
status: 204
Now Cris's address is unverified.
>>> dump_json('http://localhost:9001/3.0/addresses/cris@example.com')
display_name: Cris Person
email: cris@example.com
http_etag: "..."
original_email: cris@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/cris@example.com
User addresses
==============
Users control addresses. The canonical URLs for these user-controlled
addresses live in the /addresses namespace.
::
>>> dave = user_manager.create_user('dave@example.com', 'Dave Person')
>>> transaction.commit()
>>> dump_json('http://localhost:9001/3.0/users/dave@example.com/addresses')
entry 0:
display_name: Dave Person
email: dave@example.com
http_etag: "..."
original_email: dave@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/dave@example.com
http_etag: "..."
start: 0
total_size: 1
>>> dump_json('http://localhost:9001/3.0/addresses/dave@example.com')
display_name: Dave Person
email: dave@example.com
http_etag: "..."
original_email: dave@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/dave@example.com
A user can be associated with multiple email addresses. You can add new
addresses to an existing user.
>>> dump_json(
... 'http://localhost:9001/3.0/users/dave@example.com/addresses', {
... 'email': 'dave.person@example.org'
... })
content-length: 0
date: ...
location: http://localhost:9001/3.0/addresses/dave.person@example.org
server: ...
status: 201
When you add the new address, you can give it an optional display name.
>>> dump_json(
... 'http://localhost:9001/3.0/users/dave@example.com/addresses', {
... 'email': 'dp@example.org',
... 'display_name': 'Davie P',
... })
content-length: 0
date: ...
location: http://localhost:9001/3.0/addresses/dp@example.org
server: ...
status: 201
The user controls these new addresses.
>>> dump_json('http://localhost:9001/3.0/users/dave@example.com/addresses')
entry 0:
email: dave.person@example.org
http_etag: "..."
original_email: dave.person@example.org
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/dave.person@example.org
entry 1:
display_name: Dave Person
email: dave@example.com
http_etag: "..."
original_email: dave@example.com
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/dave@example.com
entry 2:
display_name: Davie P
email: dp@example.org
http_etag: "..."
original_email: dp@example.org
registered_on: 2005-08-01T07:49:23
self_link: http://localhost:9001/3.0/addresses/dp@example.org
http_etag: "..."
start: 0
total_size: 3
Memberships
===========
Addresses can be subscribed to mailing lists. When they are, all the
membership records for that address are easily accessible via the REST API.
Elle registers several email addresses.
>>> elle = user_manager.create_user('elle@example.com', 'Elle Person')
>>> subscriber = list(elle.addresses)[0]
>>> elle.register('eperson@example.com')
<Address: eperson@example.com [not verified] at ...>
>>> elle.register('elle.person@example.com')
<Address: elle.person@example.com [not verified] at ...>
Elle subscribes to two mailing lists with one of her addresses.
::
>>> ant = create_list('ant@example.com')
>>> bee = create_list('bee@example.com')
>>> ant.subscribe(subscriber)
<Member: Elle Person <elle@example.com> on ant@example.com
as MemberRole.member>
>>> bee.subscribe(subscriber)
<Member: Elle Person <elle@example.com> on bee@example.com
as MemberRole.member>
>>> transaction.commit()
Elle can get her memberships for each of her email addresses.
::
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'elle@example.com/memberships')
entry 0:
address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
email: elle@example.com
http_etag: "..."
list_id: ant.example.com
role: member
self_link: http://localhost:9001/3.0/members/1
user: http://localhost:9001/3.0/users/2
entry 1:
address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
email: elle@example.com
http_etag: "..."
list_id: bee.example.com
role: member
self_link: http://localhost:9001/3.0/members/2
user: http://localhost:9001/3.0/users/2
http_etag: "..."
start: 0
total_size: 2
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'eperson@example.com/memberships')
http_etag: "..."
start: 0
total_size: 0
When Elle subscribes to the `bee` list again with a different address, this
does not show up in the list of memberships for his other address.
::
>>> subscriber = user_manager.get_address('eperson@example.com')
>>> bee.subscribe(subscriber)
<Member: eperson@example.com on bee@example.com as MemberRole.member>
>>> transaction.commit()
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'elle@example.com/memberships')
entry 0:
address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
email: elle@example.com
http_etag: "..."
list_id: ant.example.com
role: member
self_link: http://localhost:9001/3.0/members/1
user: http://localhost:9001/3.0/users/2
entry 1:
address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
email: elle@example.com
http_etag: "..."
list_id: bee.example.com
role: member
self_link: http://localhost:9001/3.0/members/2
user: http://localhost:9001/3.0/users/2
http_etag: "..."
start: 0
total_size: 2
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'eperson@example.com/memberships')
entry 0:
address: http://localhost:9001/3.0/addresses/eperson@example.com
delivery_mode: regular
email: eperson@example.com
http_etag: "..."
list_id: bee.example.com
role: member
self_link: http://localhost:9001/3.0/members/3
user: http://localhost:9001/3.0/users/2
http_etag: "..."
start: 0
total_size: 1
|
