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
|
=============
Mailing lists
=============
The REST API can be queried for the set of known mailing lists. There is a
top level collection that can return all the mailing lists. There aren't any
yet though.
>>> dump_json('http://localhost:8001/3.0/lists')
http_etag: "..."
start: 0
total_size: 0
Create a mailing list in a domain and it's accessible via the API.
>>> create_list('test-one@example.com')
<mailing list "test-one@example.com" at ...>
>>> transaction.commit()
>>> dump_json('http://localhost:8001/3.0/lists')
entry 0:
fqdn_listname: test-one@example.com
host_name: example.com
http_etag: "..."
list_name: test-one
real_name: Test-one
self_link: http://localhost:8001/3.0/lists/test-one@example.com
http_etag: "..."
start: 0
total_size: 1
Creating lists via the API
==========================
New mailing lists can also be created through the API, by posting to the
'lists' URL.
>>> dump_json('http://localhost:8001/3.0/lists', {
... 'fqdn_listname': 'test-two@example.com',
... })
content-length: 0
date: ...
location: http://localhost:8001/3.0/lists/test-two@example.com
...
The mailing list exists in the database.
>>> from mailman.interfaces.listmanager import IListManager
>>> from zope.component import getUtility
>>> list_manager = getUtility(IListManager)
>>> list_manager.get('test-two@example.com')
<mailing list "test-two@example.com" at ...>
# The above starts a Storm transaction, which will lock the database
# unless we abort it.
>>> transaction.abort()
It is also available via the location given in the response.
>>> dump_json('http://localhost:8001/3.0/lists/test-two@example.com')
fqdn_listname: test-two@example.com
host_name: example.com
http_etag: "..."
list_name: test-two
real_name: Test-two
self_link: http://localhost:8001/3.0/lists/test-two@example.com
However, you are not allowed to create a mailing list in a domain that does
not exist.
>>> dump_json('http://localhost:8001/3.0/lists', {
... 'fqdn_listname': 'test-three@example.org',
... })
Traceback (most recent call last):
...
HTTPError: HTTP Error 400: Bad Request
Nor can you create a mailing list that already exists.
>>> dump_json('http://localhost:8001/3.0/lists', {
... 'fqdn_listname': 'test-one@example.com',
... })
Traceback (most recent call last):
...
HTTPError: HTTP Error 400: Bad Request
Deleting lists via the API
==========================
Existing mailing lists can be deleted through the API, by doing an HTTP DELETE
on the mailing list URL.
>>> dump_json('http://localhost:8001/3.0/lists/test-two@example.com',
... method='DELETE')
content-length: 0
date: ...
server: ...
status: 204
# The above starts a Storm transaction, which will lock the database
# unless we abort it.
>>> transaction.abort()
The mailing list does not exist.
>>> print list_manager.get('test-two@example.com')
None
You cannot delete a mailing list that does not exist or has already been
deleted.
>>> dump_json('http://localhost:8001/3.0/lists/test-two@example.com',
... method='DELETE')
Traceback (most recent call last):
...
HTTPError: HTTP Error 404: Not Found
>>> dump_json('http://localhost:8001/3.0/lists/test-ten@example.com',
... method='DELETE')
Traceback (most recent call last):
...
HTTPError: HTTP Error 404: Not Found
|
