summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/registrar.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman/interfaces/registrar.py')
-rw-r--r--src/mailman/interfaces/registrar.py26
1 files changed, 25 insertions, 1 deletions
diff --git a/src/mailman/interfaces/registrar.py b/src/mailman/interfaces/registrar.py
index 51150dbf2..8a77ca8f6 100644
--- a/src/mailman/interfaces/registrar.py
+++ b/src/mailman/interfaces/registrar.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2007-2013 by the Free Software Foundation, Inc.
+# Copyright (C) 2007-2014 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
@@ -26,6 +26,7 @@ from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
+ 'ConfirmationNeededEvent',
'IRegistrar',
]
@@ -34,6 +35,29 @@ from zope.interface import Interface
+class ConfirmationNeededEvent:
+ """Triggered when an address needs confirmation.
+
+ Addresses must be verified before they can receive messages or post to
+ mailing list. When an address is registered with Mailman, via the
+ `IRegistrar` interface, an `IPendable` is created which represents the
+ pending registration. This pending registration is stored in the
+ database, keyed by a token. Then this event is triggered.
+
+ There may be several ways to confirm an email address. On some sites,
+ registration may immediately produce a verification, e.g. because it is on
+ a known intranet. Or verification may occur via external database lookup
+ (e.g. LDAP). On most public mailing lists, a mail-back confirmation is
+ sent to the address, and only if they reply to the mail-back, or click on
+ an embedded link, is the registered address confirmed.
+ """
+ def __init__(self, mlist, pendable, token):
+ self.mlist = mlist
+ self.pendable = pendable
+ self.token = token
+
+
+
class IRegistrar(Interface):
"""Interface for registering and verifying email addresses and users.