Maildir

mailbox

class (source)

Maildir(dirname, factory=None, create=True)

A qmail-style Maildir mailbox.

© Python Software Foundation. PSF License Version 2 · Official docs ↗

Changed in 3.13

3.13: Maildir now ignores files with a leading dot.

Members of Maildir

_

__setitem__: Replace the keyed message; raise KeyError if it doesn't exist.

a

add: Add message and return assigned key.
add_flag: Set the given flag(s) without changing others on the keyed message.
add_folder: Create a folder and return a Maildir instance representing it.

c

clean: Delete old files in "tmp".
close: Flush and close the mailbox.
colon: The Maildir specification requires the use of a colon (':') in certain message file names.

f

flush: Write any pending changes to disk.

g

get_file: Return a file-like representation or raise a KeyError.
get_flags: Return as a string the standard flags that are set on the keyed message.
get_folder: Return a Maildir instance for the named folder.
get_info: Get the keyed message's "info" as a string.

l

list_folders: Return a list of folder names.
lock: Lock the mailbox.

r

remove_flag: Unset the given string flag(s) without changing others on the keyed message.
remove_folder: Delete the named folder, which must be empty.

s

set_flags: Set the given flags and unset all others on the keyed message.
set_info: Set the keyed message's "info" string.

u

unlock: Unlock the mailbox if it is locked.
update: Change the messages that correspond to certain keys.