Part of twisted.mail.pop3 View Source View In Hierarchy
Known subclasses: twisted.mail.maildir.MaildirMailbox
Implements interfaces: twisted.mail.pop3.IMailboxMethod | listMessages | Retrieve the size of one or more messages. |
Method | getMessage | Retrieve a file-like object for a particular message. |
Method | getUidl | Get a unique identifier for a particular message. |
Method | deleteMessage | Delete a particular message. |
Method | undeleteMessages | Undelete any messages which have been marked for deletion since the |
Method | sync | Perform checkpointing. |
Retrieve the size of one or more messages. @type index: C{int} or C{None} @param index: The number of the message for which to retrieve the size (starting at 0), or None to retrieve the size of all messages. @rtype: C{int} or any iterable of C{int} or a L{Deferred} which fires with one of these. @return: The number of octets in the specified message, or an iterable of integers representing the number of octets in all the messages. Any value which would have referred to a deleted message should be set to 0. @raise ValueError: if C{index} is greater than the index of any message in the mailbox.
Retrieve a file-like object for a particular message. @type index: C{int} @param index: The number of the message to retrieve @rtype: A file-like object @return: A file containing the message data with lines delimited by C{ }.
Parameters | index | The number of the message for which to retrieve a UIDL
(type: int
) |
Returns | A string of printable characters uniquely identifying for all time the
specified message.
(type: str
) | |
Raises | ValueError | if index is greater than the index of any message in the
mailbox.
|
Delete a particular message.
This must not change the number of messages in this mailbox. Further requests for the size of deleted messages should return 0. Further requests for the message itself may raise an exception.Parameters | index | The number of the message to delete.
(type: int
) |
Undelete any messages which have been marked for deletion since the
most recent sync
call.
Perform checkpointing.
This method will be called to indicate the mailbox should attempt to clean up any remaining deleted messages.