summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/roster.py
diff options
context:
space:
mode:
authorAbhilash Raj2015-04-15 22:49:58 -0400
committerAbhilash Raj2015-04-15 22:49:58 -0400
commit342b878edae5f19c8db195abce684d8a20ef2c37 (patch)
tree91361d6f68317cc8b4e2a47ae07cbca904764a9a /src/mailman/interfaces/roster.py
parentbc515c8ce1dd7e0f2221f5ae5f572d2e42d9fe18 (diff)
parent2f2e4aa6684a0930395d56a77078aa39ee7786a5 (diff)
downloadmailman-342b878edae5f19c8db195abce684d8a20ef2c37.tar.gz
mailman-342b878edae5f19c8db195abce684d8a20ef2c37.tar.zst
mailman-342b878edae5f19c8db195abce684d8a20ef2c37.zip
Diffstat (limited to 'src/mailman/interfaces/roster.py')
-rw-r--r--src/mailman/interfaces/roster.py21
1 files changed, 18 insertions, 3 deletions
diff --git a/src/mailman/interfaces/roster.py b/src/mailman/interfaces/roster.py
index 5d0b9d6c2..af473a553 100644
--- a/src/mailman/interfaces/roster.py
+++ b/src/mailman/interfaces/roster.py
@@ -53,11 +53,26 @@ class IRoster(Interface):
managed by this roster.
""")
- def get_member(address):
+ def get_member(email):
"""Get the member for the given address.
- :param address: The email address to search for.
- :type address: text
+ *Note* that it is possible for an email to be subscribed to a
+ mailing list twice, once through its explicit address and once
+ indirectly through a user's preferred address. In this case,
+ this API always returns the explicit address. Use
+ ``get_memberships()`` to return them all.
+
+ :param email: The email address to search for.
+ :type email: string
:return: The member if found, otherwise None
:rtype: `IMember` or None
"""
+
+ def get_memberships(email):
+ """Get the memberships for the given address.
+
+ :param email: The email address to search for.
+ :type email: string
+ :return: All the memberships associated with this email address.
+ :rtype: sequence of length 0, 1, or 2 of ``IMember``
+ """