summaryrefslogtreecommitdiff
path: root/Mailman/interfaces/roster.py
diff options
context:
space:
mode:
authorbwarsaw2007-05-28 20:21:41 +0000
committerbwarsaw2007-05-28 20:21:41 +0000
commitb18f632faa6de17badabb3c6c7ba61752ac84c37 (patch)
tree8b444330b288c5dfc9b25be639d429abfaeb3d3d /Mailman/interfaces/roster.py
parent5ff792b13599920527b48f92f8bad880668f8f26 (diff)
downloadmailman-b18f632faa6de17badabb3c6c7ba61752ac84c37.tar.gz
mailman-b18f632faa6de17badabb3c6c7ba61752ac84c37.tar.zst
mailman-b18f632faa6de17badabb3c6c7ba61752ac84c37.zip
Diffstat (limited to 'Mailman/interfaces/roster.py')
-rw-r--r--Mailman/interfaces/roster.py42
1 files changed, 42 insertions, 0 deletions
diff --git a/Mailman/interfaces/roster.py b/Mailman/interfaces/roster.py
new file mode 100644
index 000000000..7ddbd5101
--- /dev/null
+++ b/Mailman/interfaces/roster.py
@@ -0,0 +1,42 @@
+# Copyright (C) 2007 by the Free Software Foundation, Inc.
+#
+# This program 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 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Interface for a roster of members."""
+
+from zope.interface import Interface, Attribute
+
+
+
+class IRoster(Interface):
+ """A roster is a collection of IUsers."""
+
+ name = Attribute(
+ """The name for this roster.
+
+ Rosters are considered equal if they have the same name.""")
+
+ addresses = Attribute(
+ """An iterator over all the addresses managed by this roster.""")
+
+ def create(email_address, real_name=None):
+ """Create an IAddress and return it.
+
+ email_address is textual email address to add. real_name is the
+ optional real name that gets associated with the email address.
+
+ Raises ExistingAddressError if address already exists.
+ """