GNU Info

(python2.1-lib.info)IMAP4 Objects

---

Next: IMAP4 Example Prev: imaplib Up: imaplib

---

Enter node , (file) or (file)node

IMAP4 Objects
-------------

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

All arguments to commands are converted to strings, except for
`AUTHENTICATE', and the last argument to `APPEND' which is passed as an
IMAP4 literal.  If necessary (the string contains IMAP4
protocol-sensitive characters and isn't enclosed with either
parentheses or double quotes) each string is quoted. However, the
PASSWORD argument to the `LOGIN' command is always quoted.  If you want
to avoid having an argument string quoted (eg: the FLAGS argument to
`STORE') then enclose the string in parentheses (eg: `r'(\Deleted)'').

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.  MESSAGE_PARTS should be a string of
     message part names enclosed within parentheses, eg: `"(UID
     BODY[TEXT])"'.  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.  The PASSWORD will
     be quoted.

`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.

`noop()'
     Send `NOOP' to server.

`open(host, port)'
     Opens socket to PORT at HOST.  You may override this method.

`partial(message_num, message_part, start, length)'
     Fetch truncated part of a message.  Returned data is a tuple 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, criterium[, ...])'
     Search mailbox for matching messages.  Returned data contains a
     space separated list of matching message numbers.  CHARSET may be
     `None', in which case no `CHARSET' will be specified in the
     request to the server.  The IMAP protocol requires that at least
     one criterium be specified; an exception will be raised when the
     server returns an error.

     Example:

          # M is a connected IMAP4 instance...
          msgnums = M.search(None, 'FROM', '"LDJ"')
          
          # or:
          msgnums = M.search(None, '(FROM "LDJ")')

`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.

`socket()'
     Returns socket instance used to connect to server.

`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, arg[, ...])'
     Execute command args with messages identified by UID, rather than
     message number.  Returns response appropriate to command.  At least
     one argument must be supplied; if none are provided, the server
     will return an error and an exception will be raised.

`unsubscribe(mailbox)'
     Unsubscribe from old mailbox.

`xatom(name[, arg[, ...]])'
     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.