Part of twisted.mail.maildir View Source View In Hierarchy
| Instance Variable | path | See __init__. |
| Instance Variable | list | Information about the messages in the mailbox. For undeleted messages, the
file containing the message and the full path name of the file are stored.
Deleted messages are indicated by 0. (type: list
of int
or 2-tuple
of (0) file-like object, (1) bytes) |
| Method | __init__ | |
| 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-like object with 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 | appendMessage | Add a message to the mailbox. |
Inherited from Mailbox:
| Method | sync | Discard the contents of any message marked for deletion. |
| Parameters | path | The directory name for a maildir mailbox. (type: bytes) |
| Parameters | i | The 0-based index of a message. (type: int
or NoneType) |
| Returns | The number of octets in the specified message, or, if an index is not
specified, a list of the number of octets for all messages in the mailbox.
Any value which corresponds to a deleted message is set to 0. (type: int
or list
of int) | |
| Raises | IndexError | When the index does not correspond to a message in the mailbox. |
| Parameters | i | The 0-based index of a message. (type: int) |
| Returns | A file containing the message. (type: file-like object) | |
| Raises | IndexError | When the index does not correspond to a message in the mailbox. |
Move the message to the .Trash/ subfolder so it can be undeleted by an administrator.
| Parameters | i | The 0-based index of a message. (type: int) |
| Raises | IndexError | When the index does not correspond to a message in the mailbox. |
Move each message marked for deletion from the .Trash/ subfolder back to its original position.