class documentation

class MailingList(RESTObject): (source)

View In Hierarchy

Undocumented

Method __repr__ Provide a default repr for all object types.
Async Method config Get MailingList settings.
Async Method get_roster Get MailingList roster.
Async Method members Get Mailinglist members (subscribers.)
Async Method moderators Get Mailinglist moderators.
Async Method nonmember Get Mailinglist nonmembers.
Async Method owners Get Mailinglist owners.
Class Variable _properties Undocumented

Inherited from RESTObject:

Method __getattr__ Undocumented
Method __setattr__ Undocumented
Async Method delete Undocumented

Inherited from RESTBase (via RESTObject):

Method __init__ No summary
Async Method save Undocumented
Method _get Get the value of 'key' from object's REST data.
Method _reset_cache Undocumented
Method _set Undocumented
Class Variable _read_only_properties Undocumented
Class Variable _writable_properties Undocumented
Instance Variable _changed_rest_data Undocumented
Instance Variable _connection Undocumented
Instance Variable _data Undocumented
def __repr__(self): (source)

Provide a default repr for all object types.

Returns
strUndocumented
async def config(self): (source)

Get MailingList settings.

/<api>/lists/<listid>/config

Returns
ConfigUndocumented
async def get_roster(self, role): (source)

Get MailingList roster.

/<api>/lists/<listid>/roster/<role>

Returns
List[Member]Undocumented
async def members(self): (source)

Get Mailinglist members (subscribers.)

/<api>/lists/<listid>/roster/member

Returns
List[Member]Undocumented
async def moderators(self): (source)

Get Mailinglist moderators.

/<api>/lists/<listid>/roster/moderator

Returns
List[Member]Undocumented
async def nonmember(self): (source)

Get Mailinglist nonmembers.

/<api>/lists/<listid>/roster/nonmember

Returns
List[Member]Undocumented
async def owners(self): (source)

Get Mailinglist owners.

/<api>/lists/<listid>/roster/owner

Returns
List[Member]Undocumented
_properties: tuple[str, ...] = (source)