diff options
Diffstat (limited to 'src/mailman/interfaces/registrar.py')
| -rw-r--r-- | src/mailman/interfaces/registrar.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/mailman/interfaces/registrar.py b/src/mailman/interfaces/registrar.py index ff3f26898..e19a3137c 100644 --- a/src/mailman/interfaces/registrar.py +++ b/src/mailman/interfaces/registrar.py @@ -75,9 +75,11 @@ class IRegistrar(Interface): :type mlist: `IMailingList` :param subscriber: The user or address to subscribe. :type email: ``IUser`` or ``IAddress`` - :return: The confirmation token string, or None if the workflow - completes (i.e. the member has been subscribed). - :rtype: str or None + :return: None if the workflow completes with the member being + subscribed. If the workflow is paused for user confirmation or + moderator approval, a 2-tuple is returned where the first element + is a ``TokenOwner`` and the second element is the token hash. + :rtype: None or 2-tuple of (TokenOwner, str) :raises MembershipIsBannedError: when the address being subscribed appears in the global or list-centric bans. """ |