:mod:`!imaplib` --- IMAP4 protocol client

فهرست فصل‌ها دانلود آرشیوناشر

Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License

:mod:!imaplib --- IMAP4 protocol client

:synopsis: IMAP4 protocol client (requires sockets).

November 2002

Source code: Lib/imaplib.py

pair: IMAP4; protocol pair: IMAP4_SSL; protocol pair: IMAP4_stream; protocol

--------------

This module defines three classes, IMAP4, IMAP4_SSL and IMAP4_stream, which encapsulate a connection to an IMAP4 server and implement a large subset of the IMAP4rev1 client protocol as defined in 3501. It is backward compatible with IMAP4 (1730) servers, but note that the `STATUS` command is not supported in IMAP4.

Three classes are provided by the !imaplib module, IMAP4 is the base class:

This class implements the actual IMAP4 protocol. The connection is created and protocol version (IMAP4 or IMAP4rev1) is determined when the instance is initialized. If *host* is not specified, `'' (the local host) is used. If *port* is omitted, the standard IMAP4 port (143) is used. The optional *timeout* parameter specifies a timeout in seconds for the connection attempt. If timeout is not given or is None`, the global default socket timeout is used.

The IMAP4 class supports the with statement. When used like this, the IMAP4 `LOGOUT command is issued automatically when the !with` statement exits. E.g.::

توجه: >> from imaplib import IMAP4 >> with IMAP4("domain.org") as M:

... M.noop() ... ('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])

Support for the with statement was added.

The optional *timeout* parameter was added.

Three exceptions are defined as attributes of the IMAP4 class:

Exception raised on any errors. The reason for the exception is passed to the constructor as a string.

IMAP4 server errors cause this exception to be raised. This is a sub-class of IMAP4.error. Note that closing the instance and instantiating a new one will usually allow recovery from this exception.

This exception is raised when a writable mailbox has its status changed by the server. This is a sub-class of IMAP4.error. Some other client now has write permission, and the mailbox will need to be re-opened to re-obtain write permission.

There's also a subclass for secure connections:

timeout=None)

This is a subclass derived from IMAP4 that connects over an SSL encrypted socket (to use this class you need a socket module that was compiled with SSL support). If *host* is not specified, `'' (the local host) is used. If *port* is omitted, the standard IMAP4-over-SSL port (993) is used. *ssl_context* is a ssl.SSLContext object which allows bundling SSL configuration options, certificates and private keys into a single (potentially long-lived) structure. Please read ssl-security` for best practices.

With the default *ssl_context*, the connection is encrypted but the server certificate and hostname are not verified. To verify them, pass a context created by ssl.create_default_context.

The optional *timeout* parameter specifies a timeout in seconds for the connection attempt. If timeout is not given or is `None`, the global default socket timeout is used.

*ssl_context* parameter was added.

The class now supports hostname check with ssl.SSLContext.check_hostname and *Server Name Indication* (see ssl.HAS_SNI).

The optional *timeout* parameter was added.

The deprecated *keyfile* and *certfile* parameters have been removed.

The second subclass allows for connections created by a child process:

This is a subclass derived from IMAP4 that connects to the `stdin/stdout file descriptors created by passing *command* to subprocess.Popen()`.

The following utility functions are defined:

Parse a bytes-like object containing an IMAP4 `INTERNALDATE response and return the corresponding local time. The return value is a time.struct_time tuple or None` if the input has wrong format.

Converts an integer into a bytes representation using characters from the set [`A .. P`].

Converts a bytes-like object containing an IMAP4 `FLAGS response to a tuple of individual flags as bytes`. The return value is an empty tuple if the input has wrong format.

Convert *date_time* to an IMAP4 `INTERNALDATE representation. The return value is a string in the form: "DD-Mmm-YYYY HH:MM:SS +HHMM" (including double-quotes). The *date_time* argument can be a number (int or float) representing seconds since epoch (as returned by time.time), a 9-tuple representing local time an instance of time.struct_time (as returned by time.localtime), an aware instance of datetime.datetime`, or a double-quoted string. In the last case, it is assumed to already be in the correct format.

Note that IMAP4 message numbers change as the mailbox changes; in particular, after an `EXPUNGE` command performs deletions the remaining messages are renumbered. So it is highly advisable to use UIDs instead, with the UID command.

At the end of the module, there is a test section that contains a more extensive example of usage.

Documents describing the protocol, sources for servers implementing it, by the University of Washington's IMAP Information Center can all be found at (Source Code) https://github.com/uw-imap/imap (Not Maintained).

IMAP4 Objects

All IMAP4rev1 commands are represented by methods of the same name, either uppercase or lowercase.

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)'`). In general, pass arguments unquoted and let the module quote them as needed. An argument that is already enclosed in double quotes is left unchanged, so that code which quotes arguments itself keeps working.

Most commands return 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. Each *data* is either a bytes`, or a tuple. If a tuple, then the first part is the header of the response, and the second part contains the data (ie: 'literal' value).

The *message_set* options to commands below is a string specifying one or more messages to be acted upon. It may be a simple message number (`'1'), a range of message numbers ('2:4'), or a group of non-contiguous ranges separated by commas ('1:3,6:9'). A range can contain an asterisk to indicate an infinite upper bound ('3:*'`).

An IMAP4 instance has the following methods:

Append *message* to named mailbox.

*flags* may be `None or a string of IMAP flag tokens. Multiple flags are separated by spaces, for example r'\Seen \Answered'`. If *flags* is not already enclosed in parentheses, parentheses are added automatically.

Authenticate command --- requires response processing.

*mechanism* specifies which authentication mechanism is to be used - it should appear in the instance variable `capabilities in the form AUTH=mechanism`.

*authobject* must be a callable object::

data = authobject(response)

It will be called to process server continuation responses; the *response* argument it is passed will be `bytes. It should return bytes *data* that will be base64 encoded and sent to the server. It should return None if the client abort response *` should be sent instead.

string usernames and passwords are now encoded to `utf-8` instead of being limited to ASCII.

Checkpoint mailbox on server.

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

Copy *message_set* messages onto end of *new_mailbox*.

Create new mailbox named *mailbox*.

Delete old mailbox named *mailbox*.

Delete the ACLs (remove any rights) set for who on mailbox.

Enable *capability* (see 5161). Most capabilities do not need to be enabled. Currently only the `UTF8=ACCEPT capability is supported (see 6855`).

The enable method itself, and 6855 support.

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

Get the `ACL\ s for *mailbox*. The method is non-standard, but is supported by the Cyrus` server.

Retrieve the specified `ANNOTATION\ s for *mailbox*. The method is non-standard, but is supported by the Cyrus` server.

Get the `quota` *root*'s resource usage and limits. This method is part of the IMAP4 QUOTA extension defined in rfc2087.

Get the list of `quota roots` for the named *mailbox*. This method is part of the IMAP4 QUOTA extension defined in rfc2087.

Return an !Idler: an iterable context manager implementing the IMAP4 `IDLE command as defined in 2177`.

The returned object sends the `IDLE command when activated by the with statement, produces IMAP untagged responses via the iterator protocol, and sends DONE` upon context exit.

All untagged responses that arrive after sending the `IDLE command (including any that arrive before the server acknowledges the command) will be available via iteration. Any leftover responses (those not iterated in the with context) can be retrieved in the usual way after IDLE ends, using IMAP4.response`.

Responses are represented as `(type, [data, ...]) tuples, as described in IMAP4 Objects <imap4-objects>`.

The *duration* argument sets a maximum duration (in seconds) to keep idling, after which any ongoing iteration will stop. It can be an int or float, or `None for no time limit. Callers wishing to avoid inactivity timeouts on servers that impose them should keep this at most 29 minutes (1740 seconds). Requires a socket connection; *duration* must be None on IMAP4_stream` connections.

pycon
   >>> with M.idle(duration=29 * 60) as idler:
   ...     for typ, data in idler:
   ...         print(typ, data)
   ...
   EXISTS [b'1']
   RECENT [b'1']


.. method:: Idler.burst(interval=0.1)

   Yield a burst of responses no more than *interval* seconds apart
   (expressed as an :class:`int` or :class:`float`).

   This :term:`generator` is an alternative to iterating one response at a
   time, intended to aid in efficient batch processing. It retrieves the
   next response along with any immediately available subsequent responses.
   (For example, a rapid series of ``EXPUNGE`` responses after a bulk
   delete.)

   Requires a socket connection; does not work on :class:`IMAP4_stream`
   connections.

   .. code-block:: pycon

      >>> with M.idle() as idler:
      ...     # get a response and any others following by < 0.1 seconds
      ...     batch = list(idler.burst())
      ...     print(f'processing {len(batch)} responses...')
      ...     print(batch)
      ...
      processing 3 responses...
      [('EXPUNGE', [b'2']), ('EXPUNGE', [b'1']), ('RECENT', [b'0'])]

   .. tip::

      The ``IDLE`` context's maximum duration, as passed to
      in a burst. Therefore, an expired :class:`!Idler` will cause this
      generator to return immediately without producing anything. Callers
      should consider this if using it in a loop.


.. note::

   The iterator returned by :meth:`IMAP4.idle` is usable only within a
   responses are collected internally whenever a command finishes, and can
   be retrieved with :meth:`IMAP4.response`.

.. note::

   The :class:`!Idler` class name and structure are internal interfaces,
   subject to change. Calling code can rely on its context management,
   iteration, and public method to remain stable, but should not subclass,
   instantiate, compare, or otherwise directly reference the class.

.. versionadded:: 3.14

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.

Identify the client using a plaintext password. The *password* will be quoted.

Force use of `CRAM-MD5 authentication when identifying the client to protect the password. Will only work if the server CAPABILITY response includes the phrase AUTH=CRAM-MD5`.

An IMAP4.error is raised if MD5 support is not available.

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

The method no longer ignores silently arbitrary exceptions.

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.

Show my ACLs for a mailbox (i.e. the rights that I have on mailbox).

Returns IMAP namespaces as defined in 2342.

Send `NOOP` to server.

Opens socket to *port* at *host*. The optional *timeout* parameter specifies a timeout in seconds for the connection attempt. If timeout is not given or is `None, the global default socket timeout is used. Also note that if the *timeout* parameter is set to be zero, it will raise a ValueError to reject creating a non-blocking socket. This method is implicitly called by the IMAP4 constructor. The connection objects established by this method will be used in the IMAP4.read, IMAP4.readline, IMAP4.send, and IMAP4.shutdown` methods. You may override this method.

The *timeout* parameter was added.

Fetch truncated part of a message. Returned data is a tuple of message part envelope and data.

Assume authentication as *user*. Allows an authorised administrator to proxy into any user's mailbox.

Reads *size* bytes from the remote server. You may override this method.

Reads one line from the remote server. You may override this method.

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

Rename mailbox named *oldmailbox* to *newmailbox*.

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

Search mailbox for matching messages. *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 criterion be specified; an exception will be raised when the server returns an error. *charset* must be None if the UTF8=ACCEPT capability was enabled using the enable` command.

Example::

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

# or: typ, msgnums = M.search(None, '(FROM "LDJ")')

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.

Sends `data` to the remote server. You may override this method.

Set an `ACL for *mailbox*. The method is non-standard, but is supported by the Cyrus` server.

Set `ANNOTATION\ s for *mailbox*. The method is non-standard, but is supported by the Cyrus` server.

Set the `quota` *root*'s resource *limits*. This method is part of the IMAP4 QUOTA extension defined in rfc2087.

Close connection established in `open. This method is implicitly called by IMAP4.logout`. You may override this method.

Returns socket instance used to connect to server.

The `sort command is a variant of search` with sorting semantics for the results. Returned data contains a space separated list of matching message numbers.

Sort has two arguments before the *search_criterion* argument(s); a parenthesized list of *sort_criteria*, and the searching *charset*. Note that unlike `search, the searching *charset* argument is mandatory. There is also a uid sort command which corresponds to sort the way that uid search corresponds to search. The sort` command first searches the mailbox for messages that match the given searching criteria using the charset argument for the interpretation of strings in the searching criteria. It then returns the numbers of matching messages.

This is an `IMAP4rev1` extension command.

Send a `STARTTLS command. The *ssl_context* argument is optional and should be a ssl.SSLContext object. This will enable encryption on the IMAP connection. Please read ssl-security` for best practices.

With the default *ssl_context*, the connection is encrypted but the server certificate and hostname are not verified. To verify them, pass a context created by ssl.create_default_context.

The method now supports hostname check with ssl.SSLContext.check_hostname and *Server Name Indication* (see ssl.HAS_SNI).

Request named status conditions for *mailbox*.

Alters flag dispositions for messages in mailbox. *command* is specified by section 6.4.6 of 3501 as being one of "FLAGS", "+FLAGS", or "-FLAGS", optionally with a suffix of ".SILENT".

For example, to set the delete flag on all messages::

typ, data = M.search(None, 'ALL') for num in data[0].split(): M.store(num, '+FLAGS', '\\Deleted') M.expunge()

Creating flags containing ']' (for example: "[test]") violates 3501 (the IMAP protocol). However, imaplib has historically allowed creation of such flags, and popular IMAP servers, such as Gmail, accept and produce such flags. There are non-Python programs which also create such flags. Although it is an RFC violation and IMAP clients and servers are supposed to be strict, imaplib still continues to allow such flags to be created for backward compatibility reasons, and as of Python 3.6, handles them if they are sent from the server, since this improves real-world compatibility.

Subscribe to new mailbox.

The `thread command is a variant of search` with threading semantics for the results. Returned data contains a space separated list of thread members.

Thread members consist of zero or more messages numbers, delimited by spaces, indicating successive parent and child.

Thread has two arguments before the *search_criterion* argument(s); a *threading_algorithm*, and the searching *charset*. Note that unlike `search, the searching *charset* argument is mandatory. There is also a uid thread command which corresponds to thread the way that uid search corresponds to search. The thread` command first searches the mailbox for messages that match the given searching criteria using the *charset* argument for the interpretation of strings in the searching criteria. It then returns the matching messages threaded according to the specified threading algorithm.

This is an `IMAP4rev1` extension command.

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 from old mailbox.

imaplib.IMAP4.unselect frees server's resources associated with the selected mailbox and returns the server to the authenticated state. This command performs the same actions as imaplib.IMAP4.close, except that no messages are permanently removed from the currently selected mailbox.

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

The following attributes are defined on instances of IMAP4:

A tuple of the capabilities advertised by the server, in upper case.

It is set when the connection is established, and refreshed after a successful ~IMAP4.login, ~IMAP4.authenticate or ~IMAP4.starttls, because the server can advertise different capabilities in different connection states.

Refreshed after ~IMAP4.login and ~IMAP4.authenticate.

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

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

Boolean value that is normally `False, but is set to True if an enable command is successfully issued for the UTF8=ACCEPT` capability.

IMAP4 Example

Here is a minimal example (without error checking) that opens a mailbox and retrieves and prints all messages::

import getpass, imaplib

M = imaplib.IMAP4(host='example.org') M.login(getpass.getuser(), getpass.getpass()) M.select() typ, data = M.search(None, 'ALL') for num in data[0].split(): typ, data = M.fetch(num, '(RFC822)') print('Message %s\n%s\n' % (num, data[0][1])) M.close() M.logout()

A `FETCH response may contain additional or unsolicited data (see 3501, section 7.4.2), so production code should inspect the whole response rather than rely on data[0][1]`.