diff options
Diffstat (limited to 'src/mailman/interfaces/subscriptions.py')
| -rw-r--r-- | src/mailman/interfaces/subscriptions.py | 11 |
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. """ |