twisted.mail.pop3.Mailbox class documentationtwisted.mail.pop3
(View In Hierarchy)
Known subclasses: twisted.mail.maildir.MaildirMailbox, twisted.mail.test.test_pop3.DummyMailbox
Implements interfaces: twisted.mail.interfaces.IMailboxPOP3
A base class for mailboxes.
| Method | listMessages | Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox. |
| Method | getMessage | Retrieve a file containing the contents of a message. |
| Method | getUidl | Get a unique identifier for a message. |
| Method | deleteMessage | Mark a message for deletion. |
| Method | undeleteMessages | Undelete all messages marked for deletion. |
| Method | sync | Discard the contents of any message marked for deletion. |
Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.
| Parameters | i | The 0-based index of the message. (type: int
or None) |
| Returns | The number of octets in the specified message, or, if an index is not
specified, a sequence of the number of octets for all messages in the
mailbox or a deferred which fires with one of those. Any value which
corresponds to a deleted message is set to 0. (type: int,
sequence of int,
or Deferred) | |
| Raises | ValueError or IndexError | When the index does not correspond to a message in the mailbox. The use of ValueError is preferred. |
Retrieve a file containing the contents of a message.
| Parameters | i | The 0-based index of a message. (type: int) |
| Returns | A file containing the message. (type: file-like object) | |
| Raises | ValueError or IndexError | When the index does not correspond to a message in the mailbox. The use of ValueError is preferred. |
Get a unique identifier for a message.
| Parameters | i | The 0-based index of a message. (type: int) |
| Returns | A string of printable characters uniquely identifying the message for all
time. (type: bytes) | |
| Raises | ValueError or IndexError | When the index does not correspond to a message in the mailbox. The use of ValueError is preferred. |
Mark a message for deletion.
This must not change the number of messages in this mailbox. Further requests for the size of the deleted message should return 0. Further requests for the message itself may raise an exception.
| Parameters | i | The 0-based index of a message. (type: int) |
| Raises | ValueError or IndexError | When the index does not correspond to a message in the mailbox. The use of ValueError is preferred. |
Undelete all messages marked for deletion.
Any message which can be undeleted should be returned to its original position in the message sequence and retain its original UID.