summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/user.py
diff options
context:
space:
mode:
authorBarry Warsaw2011-01-01 11:28:29 -0500
committerBarry Warsaw2011-01-01 11:28:29 -0500
commit3f1f5a2826feb9c5fb202ae266ba7f0ff76ebe21 (patch)
tree1bab06750e306942180b18383c06ad2804f98677 /src/mailman/interfaces/user.py
parentd0f8e9e03d3c55641165b73a4d8971ec514a9cdc (diff)
downloadmailman-3f1f5a2826feb9c5fb202ae266ba7f0ff76ebe21.tar.gz
mailman-3f1f5a2826feb9c5fb202ae266ba7f0ff76ebe21.tar.zst
mailman-3f1f5a2826feb9c5fb202ae266ba7f0ff76ebe21.zip
Diffstat (limited to 'src/mailman/interfaces/user.py')
-rw-r--r--src/mailman/interfaces/user.py34
1 files changed, 19 insertions, 15 deletions
diff --git a/src/mailman/interfaces/user.py b/src/mailman/interfaces/user.py
index 824f6e99c..21ccc460b 100644
--- a/src/mailman/interfaces/user.py
+++ b/src/mailman/interfaces/user.py
@@ -33,29 +33,31 @@ class IUser(Interface):
"""A basic user."""
real_name = Attribute(
- """This user's Real Name.""")
+ """This user's real name.""")
password = Attribute(
"""This user's password information.""")
addresses = Attribute(
- """An iterator over all the IAddresses controlled by this user.""")
+ """An iterator over all the `IAddresses` controlled by this user.""")
memberships = Attribute(
"""A roster of this user's memberships.""")
- def register(address, real_name=None):
+ def register(email, real_name=None):
"""Register the given email address and link it to this user.
- In this case, 'address' is a text email address, not an IAddress
- object. If real_name is not given, the empty string is used.
-
- Raises AddressAlreadyLinkedError if this IAddress is already linked to
- another user. If the corresponding IAddress already exists but is not
- linked, then it is simply linked to the user, in which case
- real_name is ignored.
-
- Return the new IAddress object.
+ :param email: The text email address to register.
+ :type email: str
+ :param real_name: The user's real name. If not given the empty string
+ is used.
+ :type real_name: str
+ :return: The address object linked to the user. If the associated
+ address object already existed (unlinked to a user) then the
+ `real_name` parameter is ignored.
+ :rtype: `IAddress`
+ :raises AddressAlreadyLinkedError: if this `IAddress` is already
+ linked to another user.
"""
def link(address):
@@ -73,11 +75,13 @@ class IUser(Interface):
some other user.
"""
- def controls(address):
+ def controls(email):
"""Determine whether this user controls the given email address.
- 'address' is a text email address. This method returns true if the
- user controls the given email address, otherwise false.
+ :param email: The text email address to register.
+ :type email: str
+ :return: True if the user controls the given email address.
+ :rtype: bool
"""
preferences = Attribute(