summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces
diff options
context:
space:
mode:
authorAbhilash Raj2016-07-30 21:06:57 -0700
committerBarry Warsaw2016-09-01 06:55:09 -0400
commit88f349900ea9afea30186c3c9f0f399ff69f6c4a (patch)
tree984a31ab8be58871bacf4a5821ddc611ac4586fe /src/mailman/interfaces
parentc23519b5262fd264ed0f9e5bc23b901ed7eee632 (diff)
downloadmailman-88f349900ea9afea30186c3c9f0f399ff69f6c4a.tar.gz
mailman-88f349900ea9afea30186c3c9f0f399ff69f6c4a.tar.zst
mailman-88f349900ea9afea30186c3c9f0f399ff69f6c4a.zip
Diffstat (limited to 'src/mailman/interfaces')
-rw-r--r--src/mailman/interfaces/mailinglist.py2
-rw-r--r--src/mailman/interfaces/workflowmanager.py (renamed from src/mailman/interfaces/registrar.py)11
2 files changed, 8 insertions, 5 deletions
diff --git a/src/mailman/interfaces/mailinglist.py b/src/mailman/interfaces/mailinglist.py
index 19db025d1..40ee95187 100644
--- a/src/mailman/interfaces/mailinglist.py
+++ b/src/mailman/interfaces/mailinglist.py
@@ -46,6 +46,7 @@ class ReplyToMunging(Enum):
@public
class SubscriptionPolicy(Enum):
+ """All subscription/unsubscription policies for a mailing list."""
# Neither confirmation, nor moderator approval is required.
open = 0
# The user must confirm the subscription.
@@ -57,6 +58,7 @@ class SubscriptionPolicy(Enum):
confirm_then_moderate = 3
+
@public
class IMailingList(Interface):
"""A mailing list."""
diff --git a/src/mailman/interfaces/registrar.py b/src/mailman/interfaces/workflowmanager.py
index e2cec5fbb..906246e6d 100644
--- a/src/mailman/interfaces/registrar.py
+++ b/src/mailman/interfaces/workflowmanager.py
@@ -41,12 +41,13 @@ class ConfirmationNeededEvent:
@public
-class IRegistrar(Interface):
- """Interface for subscribing addresses and users.
+class IWorkflowManager(Interface):
+ """Interface for handling subscription and un-subscription of addresses and
+ users.
- This is a higher level interface to user registration, email address
- confirmation, etc. than the IUserManager. The latter does no validation,
- syntax checking, or confirmation, while this interface does.
+ This is a higher level interface to user registration and un-registration,
+ email address confirmation, etc. than the IUserManager. The latter does no
+ validation, syntax checking, or confirmation, while this interface does.
To use this, adapt an ``IMailingList`` to this interface.
"""