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
|
# Copyright (C) 2007-2010 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Interface describing the basics of a member."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'AlreadySubscribedError',
'DeliveryMode',
'DeliveryStatus',
'IMember',
'MemberRole',
'MembershipError',
'MembershipIsBannedError',
'NotAMemberError',
]
from lazr.restful.declarations import (
error_status, export_as_webservice_entry, exported)
from munepy import Enum
from zope.interface import Interface, Attribute
from mailman.core.errors import MailmanError
class DeliveryMode(Enum):
# Regular (i.e. non-digest) delivery
regular = 1
# Plain text digest delivery
plaintext_digests = 2
# MIME digest delivery
mime_digests = 3
# Summary digests
summary_digests = 4
class DeliveryStatus(Enum):
# Delivery is enabled
enabled = 1
# Delivery was disabled by the user
by_user = 2
# Delivery was disabled due to bouncing addresses
by_bounces = 3
# Delivery was disabled by an administrator or moderator
by_moderator = 4
# Disabled for unknown reasons.
unknown = 5
class MemberRole(Enum):
member = 1
owner = 2
moderator = 3
class MembershipError(MailmanError):
"""Base exception for all membership errors."""
@error_status(400)
class AlreadySubscribedError(MembershipError):
"""The member is already subscribed to the mailing list with this role."""
def __init__(self, fqdn_listname, address, role):
super(AlreadySubscribedError, self).__init__()
self._fqdn_listname = fqdn_listname
self._address = address
self._role = role
def __str__(self):
return '{0} is already a {1} of mailing list {2}'.format(
self._address, self._role, self._fqdn_listname)
@error_status(400)
class MembershipIsBannedError(MembershipError):
"""The address is not allowed to subscribe to the mailing list."""
def __init__(self, mlist, address):
super(MembershipIsBanned, self).__init__()
self._mlist = mlist
self._address = address
def __str__(self):
return '{0} is not allowed to subscribe to {1.fqdn_listname}'.format(
self._address, self._mlist)
@error_status(400)
class NotAMemberError(MembershipError):
"""The address is not a member of the mailing list."""
def __init__(self, mlist, address):
super(NotAMemberError, self).__init__()
self._mlist = mlist
self._address = address
def __str__(self):
return '{0} is not a member of {1.fqdn_listname}'.format(
self._address, self._mlist)
class IMember(Interface):
"""A member of a mailing list."""
export_as_webservice_entry()
mailing_list = Attribute(
"""The mailing list subscribed to.""")
address = Attribute(
"""The email address that's subscribed to the list.""")
preferences = Attribute(
"""This member's preferences.""")
role = Attribute(
"""The role of this membership.""")
is_moderated = Attribute(
"""True if the membership is moderated, otherwise False.""")
def unsubscribe():
"""Unsubscribe (and delete) this member from the mailing list."""
acknowledge_posts = Attribute(
"""Send an acknowledgment for every posting?
Unlike going through the preferences, this attribute return the
preference value based on the following lookup order:
1. The member
2. The address
3. The user
4. System default
""")
preferred_language = Attribute(
"""The preferred language for interacting with a mailing list.
Unlike going through the preferences, this attribute return the
preference value based on the following lookup order:
1. The member
2. The address
3. The user
4. System default
""")
receive_list_copy = Attribute(
"""Should an explicit recipient receive a list copy?
Unlike going through the preferences, this attribute return the
preference value based on the following lookup order:
1. The member
2. The address
3. The user
4. System default
""")
receive_own_postings = Attribute(
"""Should the poster get a list copy of their own messages?
Unlike going through the preferences, this attribute return the
preference value based on the following lookup order:
1. The member
2. The address
3. The user
4. System default
""")
delivery_mode = Attribute(
"""The preferred delivery mode.
Unlike going through the preferences, this attribute return the
preference value based on the following lookup order:
1. The member
2. The address
3. The user
4. System default
""")
delivery_status = Attribute(
"""The delivery status.
Unlike going through the preferences, this attribute return the
preference value based on the following lookup order:
1. The member
2. The address
3. The user
4. System default
XXX I'm not sure this is the right place to put this.""")
options_url = Attribute(
"""Return the url for the given member's option page.
XXX This needs a serious re-think in the face of the unified user
database, since a member's options aren't tied to any specific mailing
list. So in what part of the web-space does the user's options live?
""")
|
