mailarchive2.MailingList

class documentation

class MailingList:

Constructor: MailingList(mail_archive, list_name)

Undocumented

Method	`__init__`	Undocumented
Method	`message`	Return the Envelope containing the Message identified by the specified uid within this mailing list.
Method	`message_uids`	Undocumented
Method	`messages`	Return the envelopes containing the specified messages from this mailing list.
Method	`messages_as_dataframe`	Return a dataframe containing metadata about the specified messages from this mailing list.
Method	`name`	Undocumented
Method	`num_messages`	Undocumented
Method	`threads`	Yields the envelopes containing the first message in each thread in this mailing list.
Method	`uidvalidity`	Undocumented
Method	`update`	Update the local copy of this mailing list from the IMAP server.
Instance Variable	`_list_name`	Undocumented
Instance Variable	`_log`	Undocumented
Instance Variable	`_mail_archive`	Undocumented
Instance Variable	`_uidvalidity`	Undocumented

def __init__(self, mail_archive: MailArchive, list_name: str): ¶

Undocumented

def message(self, uid: int) -> Optional[Envelope]: ¶

Return the Envelope containing the Message identified by the specified uid within this mailing list.

def message_uids(self) -> Iterator[int]: ¶

Undocumented

def messages(self, received_after: str = '1970-01-01T00:00:00', received_before: str = '2038-01-19T03:14:07') -> Iterator[Envelope]: ¶

Return the envelopes containing the specified messages from this mailing list.

def messages_as_dataframe(self, received_after: str = '1970-01-01T00:00:00', received_before: str = '2038-01-19T03:14:07') -> pd.DataFrame: ¶

Return a dataframe containing metadata about the specified messages from this mailing list.

def name(self) -> str: ¶

Undocumented

def num_messages(self) -> int: ¶

Undocumented

def threads(self) -> Iterator[Envelope]: ¶

Yields the envelopes containing the first message in each thread in this mailing list.

def uidvalidity(self) -> int: ¶

Undocumented

def update(self, verbose=True) -> List[int]: ¶

Update the local copy of this mailing list from the IMAP server.

This MUST be called at least once for each mailing list, else no messages will be retrieved from the server. That initial update may well be slow, since it downloads the entire set of messages from the list. Subsequent calls to `update()` only fetch the new messages and so are much faster.

_list_name: str = ¶

Undocumented

_log: logging.Logger = ¶

Undocumented

_mail_archive: MailArchive = ¶

Undocumented

_uidvalidity: int = ¶

Undocumented