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
|
# Copyright (C) 2007-2009 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 representing domains."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'IDomain',
'IDomainSet',
]
from lazr.restful.declarations import (
collection_default_content, export_as_webservice_collection,
export_as_webservice_entry, exported)
from zope.interface import Interface, Attribute
from zope.schema import TextLine
from mailman.i18n import _
class IDomain(Interface):
"""Interface representing domains."""
export_as_webservice_entry()
email_host = exported(TextLine(
title=_('Email host name'),
description=_('The host name for email for this domain.'),
))
url_host = exported(TextLine(
title=_('Web host name'),
description=_('The host name for the web interface for this domain.')
))
base_url = exported(TextLine(
title=_('Base URL'),
description=_("""\
The base url for the Mailman server at this domain, which includes the
scheme and host name."""),
))
description = exported(TextLine(
title=_('Description'),
description=_('The human readable description of the domain name.'),
))
contact_address = exported(TextLine(
title=_('Contact address'),
description=_("""\
The contact address for the human at this domain.
E.g. postmaster@example.com"""),
))
def confirm_address(token=''):
"""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.
:param token: The confirmation token to use in the url.
:type token: string
:return: The confirmation url.
:rtype: string
"""
class IDomainSet(Interface):
"""The set of all known domains."""
export_as_webservice_collection(IDomain)
@collection_default_content()
def __iter__():
"""Iterate over all domains."""
|