11.7.1 IMAP4 Objects

All IMAP4rev1 commands are represented by methods of the same name, either upper-case or lower-case.

Each command returns a tuple: (type, [data, ...]) where type is usually 'OK' or 'NO', and data is either the text from the command response, or mandated results from the command.

An IMAP4 instance has the following methods:

append (mailbox, flags, date_time, message)

Append message to named mailbox.

authenticate (func)

Authenticate command -- requires response processing. This is currently unimplemented, and raises an exception.

check ()

Checkpoint mailbox on server.

close ()

Close currently selected mailbox. Deleted messages are removed from writable mailbox. This is the recommended command before "LOGOUT".

copy (message_set, new_mailbox)

Copy message_set messages onto end of new_mailbox.

create (mailbox)

Create new mailbox named mailbox.

delete (mailbox)

Delete old mailbox named mailbox.

expunge ()

Permanently remove deleted items from selected mailbox. Generates an "EXPUNGE" response for each deleted message. Returned data contains a list of "EXPUNGE" message numbers in order received.

fetch (message_set, message_parts)

Fetch (parts of) messages. Returned data are tuples of message part envelope and data.

list ([directory[, pattern]])

List mailbox names in directory matching pattern. directory defaults to the top-level mail folder, and pattern defaults to match anything. Returned data contains a list of "LIST" responses.

login (user, password)

Identify the client using a plaintext password.

logout ()

Shutdown connection to server. Returns server "BYE" response.

lsub ([directory[, pattern]])

List subscribed mailbox names in directory matching pattern. directory defaults to the top level directory and pattern defaults to match any mailbox. Returned data are tuples of message part envelope and data.

recent ()

Prompt server for an update. Returned data is None if no new messages, else value of "RECENT" response.

rename (oldmailbox, newmailbox)

Rename mailbox named oldmailbox to newmailbox.

response (code)

Return data for response code if received, or None. Returns the given code, instead of the usual type.

search (charset, criteria)

Search mailbox for matching messages. Returned data contains a space separated list of matching message numbers.

select ([mailbox[, readonly]])

Select a mailbox. Returned data is the count of messages in mailbox ("EXISTS" response). The default mailbox is 'INBOX'. If the readonly flag is set, modifications to the mailbox are not allowed.

status (mailbox, names)

Request named status conditions for mailbox.

store (message_set, command, flag_list)

Alters flag dispositions for messages in mailbox.

subscribe (mailbox)

Subscribe to new mailbox.

uid (command, args)

Execute command args with messages identified by UID, rather than message number. Returns response appropriate to command.

unsubscribe (mailbox)

Unsubscribe from old mailbox.

xatom (name[, arg1[, arg2]])

Allow simple extension commands notified by server in "CAPABILITY" response.

The following attributes are defined on instances of IMAP4:

PROTOCOL_VERSION

The most recent supported protocol in the "CAPABILITY" response from the server.

debug

Integer value to control debugging output. The initialize value is taken from the module variable Debug. Values greater than three trace each command.