summaryrefslogtreecommitdiff
path: root/mailman/interfaces/domain.py
diff options
context:
space:
mode:
Diffstat (limited to 'mailman/interfaces/domain.py')
-rw-r--r--mailman/interfaces/domain.py44
1 files changed, 34 insertions, 10 deletions
diff --git a/mailman/interfaces/domain.py b/mailman/interfaces/domain.py
index 4cfec42cb..99a2b9c91 100644
--- a/mailman/interfaces/domain.py
+++ b/mailman/interfaces/domain.py
@@ -24,30 +24,54 @@ from zope.interface import Interface, Attribute
class IDomain(Interface):
"""Interface representing domains."""
- domain_name = Attribute(
- """The domain's name, e.g. python.org.""")
+ email_host = Attribute(
+ """The host name for email for this domain.
+
+ :type: string
+ """)
+
+ url_host = Attribute(
+ """The host name for the web interface for this domain.
+
+ :type: string
+ """)
+
+ base_url = Attribute(
+ """The base url for the Mailman server at this domain.
+
+ The base url includes the scheme and host name.
+
+ :type: string
+ """)
description = Attribute(
"""The human readable description of the domain name.
- E.g. Python Dot Org or mail.python.org.
+ :type: string
""")
contact_address = Attribute(
"""The contact address for the human at this domain.
E.g. postmaster@python.org.
- """)
- base_url = Attribute(
- """The base url for the Mailman server at this domain.
-
- E.g. https://mail.python.org
+ :type: string
""")
def confirm_address(token=''):
- """The address used for various forms of email confirmation."""
+ """The address used for various forms of email confirmation.
+
+ :param token: The confirmation token to use in the email address.
+ :type token: string
+ :return: The email confirmation address.
+ :rtype: string
+ """
def confirm_url(token=''):
- """The url used for various forms of confirmation."""
+ """The url used for various forms of confirmation.
+ :param token: The confirmation token to use in the url.
+ :type token: string
+ :return: The confirmation url.
+ :rtype: string
+ """