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
|
# 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 for list storage, deleting, and finding."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'IListManager',
'ListAlreadyExistsError',
'NoSuchListError',
]
from zope.interface import Interface, Attribute
from mailman.interfaces.errors import MailmanError
class ListAlreadyExistsError(MailmanError):
"""Attempted to create a mailing list that already exists.
Mailing list objects must be uniquely named by their fully qualified list
name.
"""
class NoSuchListError(MailmanError):
"""Attempt to access a mailing list that does not exist."""
def __init__(self, fqdn_listname):
self.fqdn_listname = fqdn_listname
def __str__(self):
return 'No such mailing list: {0.fqdn_listname}'.format(self)
class IListManager(Interface):
"""The interface of the global list manager.
The list manager manages `IMailingList` objects. You can add and remove
`IMailingList` objects from the list manager, and you can retrieve them
from the manager via their fully qualified list name, e.g.:
`mylist@example.com`.
"""
def create(fqdn_listname):
"""Create a mailing list with the given name.
:type fqdn_listname: Unicode
:param fqdn_listname: The fully qualified name of the mailing list,
e.g. `mylist@example.com`.
:return: The newly created `IMailingList`.
:raise `ListAlreadyExistsError` if the named list already exists.
"""
def get(fqdn_listname):
"""Return the mailing list with the given name, if it exists.
:type fqdn_listname: Unicode.
:param fqdn_listname: The fully qualified name of the mailing list.
:return: the matching `IMailingList` or None if the named list does
not exist.
"""
def delete(mlist):
"""Remove the mailing list from the database.
:type mlist: `IMailingList`
:param mlist: The mailing list to delete.
"""
mailing_lists = Attribute(
"""An iterator over all the mailing list objects managed by this list
manager.""")
def __iter__():
"""An iterator over all the mailing lists.
:return: iterator over `IMailingList`.
"""
names = Attribute(
"""An iterator over the fully qualified list names of all mailing
lists managed by this list manager.""")
def get_mailing_lists():
"""The list of all mailing lists.
:return: The list of all known mailing lists.
:rtype: list of `IMailingList`
"""
|
