blob: f8efa4259b337879426eeb191c13612ae4011043 (
plain)
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
|
# Copyright (C) 2007-2016 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 for a roster of members."""
__all__ = [
'IRoster',
]
from zope.interface import Interface, Attribute
class IRoster(Interface):
"""A roster is a collection of `IMembers`."""
name = Attribute(
"""The name for this roster.
Rosters are considered equal if they have the same name.""")
members = Attribute(
"""An iterator over all the IMembers managed by this roster.""")
member_count = Attribute(
"""The number of members managed by this roster.""")
users = Attribute(
"""An iterator over all the IUsers reachable by this roster.
This returns all the users for all the members managed by this roster.
""")
addresses = Attribute(
"""An iterator over all the IAddresses reachable by this roster.
This returns all the addresses for all the users for all the members
managed by this roster.
""")
def get_member(email):
"""Get the member for the given address.
*Note* that it is possible for an email to be subscribed to a
mailing list twice, once through its explicit address and once
indirectly through a user's preferred address. In this case,
this API always returns the explicit address. Use
``get_memberships()`` to return them all.
:param email: The email address to search for.
:type email: string
:return: The member if found, otherwise None
:rtype: `IMember` or None
"""
def get_memberships(email):
"""Get the memberships for the given address.
:param email: The email address to search for.
:type email: string
:return: All the memberships associated with this email address.
:rtype: sequence of length 0, 1, or 2 of ``IMember``
"""
|
