summaryrefslogtreecommitdiff
path: root/Mailman/interfaces/mlistweb.py
diff options
context:
space:
mode:
Diffstat (limited to 'Mailman/interfaces/mlistweb.py')
-rw-r--r--Mailman/interfaces/mlistweb.py39
1 files changed, 39 insertions, 0 deletions
diff --git a/Mailman/interfaces/mlistweb.py b/Mailman/interfaces/mlistweb.py
new file mode 100644
index 000000000..16eb94281
--- /dev/null
+++ b/Mailman/interfaces/mlistweb.py
@@ -0,0 +1,39 @@
+# 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 the web addresses associated with a mailing list."""
+
+from zope.interface import Interface, Attribute
+
+
+
+class IMailingListURLs(Interface):
+ """The web addresses associated with a mailing list."""
+
+ protocol = Attribute(
+ """The web protocol to use to contact the server providing the web
+ interface for this mailing list, e.g. 'http' or 'https'.""")
+
+ web_host = Attribute(
+ """The read-only domain name of the host to contact for interacting
+ with the web interface of the mailing list.""")
+
+ def script_url(target, context=None):
+ """Return the url to the given script target. If 'context' is not
+ given, or is None, then an absolute url is returned. If context is
+ given, it must be an IMailingListRequest object, and the returned url
+ will be relative to that object's 'location' attribute."""