summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/subscriptions.py
diff options
context:
space:
mode:
authorBarry Warsaw2016-04-18 20:15:41 -0400
committerBarry Warsaw2016-04-18 20:15:41 -0400
commit10c13959b44db7046abf73c7eee54c2a4ecfa5a0 (patch)
treeed3917e54537015e2bfe02f6d600930a298259a9 /src/mailman/interfaces/subscriptions.py
parent7559ce6dfdf2d569c91fea173968e46d6857d730 (diff)
downloadmailman-10c13959b44db7046abf73c7eee54c2a4ecfa5a0.tar.gz
mailman-10c13959b44db7046abf73c7eee54c2a4ecfa5a0.tar.zst
mailman-10c13959b44db7046abf73c7eee54c2a4ecfa5a0.zip
Diffstat (limited to 'src/mailman/interfaces/subscriptions.py')
-rw-r--r--src/mailman/interfaces/subscriptions.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/mailman/interfaces/subscriptions.py b/src/mailman/interfaces/subscriptions.py
index f712d33f7..382a23ac0 100644
--- a/src/mailman/interfaces/subscriptions.py
+++ b/src/mailman/interfaces/subscriptions.py
@@ -168,12 +168,13 @@ class ISubscriptionService(Interface):
:param list_id: The list id to operate on.
:type list_id: string
- :param emails: A list of email addresses of the users getting
- unsubscribed.
+ :param emails: A list of email addresses of the members getting
+ unsubscribed. Only list members with a role of `member` can be
+ unsubscribed via this interface.
:type emails: list of strings
- :return: A two item tuple whose first item is a list of all the
+ :return: A two item tuple whose first item is a set of all the
successfully unsubscribed email addresses and second item is
- a list of all unsuccessfull email addresses.
- :rtype: Tuple
+ a set of all unsuccessful email addresses.
+ :rtype: 2-tuple of (set-of-strings, set-of-strings)
:raises NoSuchListError: if the named mailing list does not exist.
"""