diff options
Diffstat (limited to 'src/mailman/interfaces')
| -rw-r--r-- | src/mailman/interfaces/address.py | 4 | ||||
| -rw-r--r-- | src/mailman/interfaces/mailinglist.py | 8 | ||||
| -rw-r--r-- | src/mailman/interfaces/registrar.py | 6 | ||||
| -rw-r--r-- | src/mailman/interfaces/subscriptions.py | 6 | ||||
| -rw-r--r-- | src/mailman/interfaces/user.py | 14 | ||||
| -rw-r--r-- | src/mailman/interfaces/usermanager.py | 14 |
6 files changed, 25 insertions, 27 deletions
diff --git a/src/mailman/interfaces/address.py b/src/mailman/interfaces/address.py index c26fb92c9..6c371e1c0 100644 --- a/src/mailman/interfaces/address.py +++ b/src/mailman/interfaces/address.py @@ -84,8 +84,8 @@ class IAddress(Interface): case preserved email address; `email` will always be lower case. """) - real_name = Attribute( - """Optional real name associated with the email address.""") + display_name = Attribute( + """Optional display name associated with the email address.""") registered_on = Attribute( """The date and time at which this email address was registered. diff --git a/src/mailman/interfaces/mailinglist.py b/src/mailman/interfaces/mailinglist.py index a3e6e443a..3c7ea9ee8 100644 --- a/src/mailman/interfaces/mailinglist.py +++ b/src/mailman/interfaces/mailinglist.py @@ -91,11 +91,9 @@ class IMailingList(Interface): domain = Attribute( """The `IDomain` that this mailing list is defined in.""") - real_name = Attribute("""\ - The short human-readable descriptive name for the mailing list. By - default, this is the capitalized `list_name`, but it can be changed to - anything. This is used in locations such as the message footers and - Subject prefix. + display_name = Attribute("""\ + The short human-readable descriptive name for the mailing list. This + is used in locations such as the message footers and Subject prefix. """) description = Attribute("""\ diff --git a/src/mailman/interfaces/registrar.py b/src/mailman/interfaces/registrar.py index 0f4fe2edf..f00e167ff 100644 --- a/src/mailman/interfaces/registrar.py +++ b/src/mailman/interfaces/registrar.py @@ -42,7 +42,7 @@ class IRegistrar(Interface): syntax checking, or confirmation, while this interface does. """ - def register(mlist, email, real_name=None, delivery_mode=None): + def register(mlist, email, display_name=None, delivery_mode=None): """Register the email address, requesting verification. No `IAddress` or `IUser` is created during this step, but after @@ -58,8 +58,8 @@ class IRegistrar(Interface): :type mlist: `IMailingList` :param email: The email address to register. :type email: str - :param real_name: The optional real name of the user. - :type real_name: str + :param display_name: The optional display name of the user. + :type display_name: str :param delivery_mode: The optional delivery mode for this registration. If not given, regular delivery is used. :type delivery_mode: `DeliveryMode` diff --git a/src/mailman/interfaces/subscriptions.py b/src/mailman/interfaces/subscriptions.py index 584ca4132..85f333cf8 100644 --- a/src/mailman/interfaces/subscriptions.py +++ b/src/mailman/interfaces/subscriptions.py @@ -92,7 +92,7 @@ class ISubscriptionService(Interface): def __iter__(): """See `get_members()`.""" - def join(fqdn_listname, subscriber, real_name=None, + def join(fqdn_listname, subscriber, display_name=None, delivery_mode=DeliveryMode.regular, role=MemberRole.member): """Subscribe to a mailing list. @@ -109,10 +109,10 @@ class ISubscriptionService(Interface): :param subscriber: The email address or user id of the user getting subscribed. :type subscriber: string or int - :param real_name: The name of the user. This is only used if a new + :param display_name: The name of the user. This is only used if a new user is created, and it defaults to the local part of the email address if not given. - :type real_name: string + :type display_name: string :param delivery_mode: The delivery mode for this subscription. This can be one of the enum values of `DeliveryMode`. If not given, regular delivery is assumed. diff --git a/src/mailman/interfaces/user.py b/src/mailman/interfaces/user.py index ad1ac9282..aba9bcbba 100644 --- a/src/mailman/interfaces/user.py +++ b/src/mailman/interfaces/user.py @@ -47,8 +47,8 @@ class UnverifiedAddressError(MailmanError): class IUser(Interface): """A basic user.""" - real_name = Attribute( - """This user's real name.""") + display_name = Attribute( + """This user's display name.""") password = Attribute( """This user's password information.""") @@ -68,17 +68,17 @@ class IUser(Interface): memberships = Attribute( """A roster of this user's memberships.""") - def register(email, real_name=None): + def register(email, display_name=None): """Register the given email address and link it to this user. :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 + :param display_name: The user's display name. If not given the empty + string is used. + :type display_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. + `display_name` parameter is ignored. :rtype: `IAddress` :raises AddressAlreadyLinkedError: if this `IAddress` is already linked to another user. diff --git a/src/mailman/interfaces/usermanager.py b/src/mailman/interfaces/usermanager.py index 364fdc6e7..773bd1046 100644 --- a/src/mailman/interfaces/usermanager.py +++ b/src/mailman/interfaces/usermanager.py @@ -32,13 +32,13 @@ from zope.interface import Interface, Attribute class IUserManager(Interface): """The global user management service.""" - def create_user(email=None, real_name=None): + def create_user(email=None, display_name=None): """Create and return an `IUser`. :param email: The text email address for the user being created. :type email: str - :param real_name: The real name of the user. - :type real_name: str + :param display_name: The display name of the user. + :type display_name: str :return: The newly created user, with the given email address and real name, if given. :rtype: `IUser` @@ -74,15 +74,15 @@ class IUserManager(Interface): users = Attribute( """An iterator over all the `IUsers` managed by this user manager.""") - def create_address(email, real_name=None): + def create_address(email, display_name=None): """Create and return an address unlinked to any user. :param email: The text email address for the address being created. :type email: str - :param real_name: The real name associated with the address. - :type real_name: str + :param display_name: The display name associated with the address. + :type display_name: str :return: The newly created address object, with the given email - address and real name, if given. + address and display name, if given. :rtype: `IAddress` :raises ExistingAddressError: when the email address is already registered. |