lp.registry.interfaces.mailinglist.IMailingListSet : API documentation

TextLine	title	The hard coded title.
Method	new	Register a new team mailing list.
Method	get	Return the `IMailingList` associated with the given team name.
Method	getSubscriptionsForTeams	Return a person's subscriptions to usable lists for a set of teams.
Method	getSubscribedAddresses	Return the set of subscribed email addresses for members.
Method	getSenderAddresses	Return the set of all email addresses for members.
Set	approved_lists	All mailing lists with status `MailingListStatus.APPROVED`.
Set	active_lists	All mailing lists with status `MailingListStatus.ACTIVE`.
Set	modified_lists	All mailing lists with status `MailingListStatus.MODIFIED`.
Set	deactivated_lists	All mailing lists with status `MailingListStatus.DEACTIVATING`.
Set	unsynchronized_lists	All mailing lists with unsynchronized state, e.g. `MailingListStatus.CONSTRUCTING` and `MailingListStatus.UPDATING`.

def new(team, registrant=None):

A mailing list for the team is registered and the resulting IMailingList is returned. The registration time will be set to the current time. The team must not yet have a mailing list.

Parameters	team	The team to register a new mailing list for.
	registrant	The person registering the mailing list. This must be the team owner or one of the team admins. If None, the team owner is used.
Raises	AssertionError	When `team` is not a team, already has a mailing list registered for it, or the registrant is not a team owner or admin.

def get(team_name):

Return the IMailingList associated with the given team name.

Parameters	team_name	The name of the team to get the mailing list for.
Returns	The `IMailingList` for the named team or None if no mailing list is registered for the named team, or the team doesn't exist.
Raises	AssertionError	When `team_name` is not a string.

def getSubscriptionsForTeams(person, teams):

Return a person's subscriptions to usable lists for a set of teams.

:param person: An `IPerson`.
:param teams: A list of `ITeam`s.
:return: A dictionary mapping team IDs to tuples of `IMailingList`
    IDs and `IMailingListSubscription` IDs; the second element will
    be None if a team has a list to which the person is not
    subscribed.

def getSubscribedAddresses(team_names):

Return the set of subscribed email addresses for members.

Parameters	team_names	The set of teams to query. (type: sequence of strings)
Returns	A dictionary of lists. The dictionary's keys are the team names given in the argument. The values are lists of 2-tuples for all the subscribed members of that mailing lists, in no particular order. This represents all the addresses which will receive messages posted to that mailing list. The 2-tuple is of the format (Full Name, email address) (type: dictionary mapping team names to lists of 2-tuples)

def getSenderAddresses(team_names):

Return the set of all email addresses for members.

Parameters	team_names	The set of teams to query. (type: sequence of strings)
Returns	A dictionary of lists. The dictionary's keys are the team names given in the argument. The values are lists of 2-tuples for all the members of that mailing list's team, in no particular order. This represents all the addresses which are allowed to post messages to that mailing list. The 2-tuple is of the format (Full Name, email address) (type: dictionary mapping team names to iterators)

unsynchronized_lists =

All mailing lists with unsynchronized state, e.g. MailingListStatus.CONSTRUCTING and MailingListStatus.UPDATING.

l.r.i.m.IMailingListSet(Interface) : interface documentation