FM / library

/usr/share/doc/python3-docs/html/_sources/library/

/usr/share/doc/python3-docs/html/_sources/library

Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	edit dl rm
abc.rst.txt	11805	0644	edit dl rm
aifc.rst.txt	7503	0644	edit dl rm
allos.rst.txt	678	0644	edit dl rm
archiving.rst.txt	440	0644	edit dl rm
argparse.rst.txt	77480	0644	edit dl rm
array.rst.txt	10812	0644	edit dl rm
ast.rst.txt	10159	0644	edit dl rm
asynchat.rst.txt	8528	0644	edit dl rm
asyncio-dev.rst.txt	13398	0644	edit dl rm
asyncio-eventloop.rst.txt	33701	0644	edit dl rm
asyncio-eventloops.rst.txt	7660	0644	edit dl rm
asyncio-protocol.rst.txt	25170	0644	edit dl rm
asyncio-queue.rst.txt	4328	0644	edit dl rm
asyncio-stream.rst.txt	14363	0644	edit dl rm
asyncio-subprocess.rst.txt	15544	0644	edit dl rm
asyncio-sync.rst.txt	9078	0644	edit dl rm
asyncio-task.rst.txt	25406	0644	edit dl rm
asyncio.rst.txt	2272	0644	edit dl rm
asyncore.rst.txt	13624	0644	edit dl rm
atexit.rst.txt	3669	0644	edit dl rm
audioop.rst.txt	10712	0644	edit dl rm
base64.rst.txt	10371	0644	edit dl rm
bdb.rst.txt	12985	0644	edit dl rm
binary.rst.txt	654	0644	edit dl rm
binascii.rst.txt	6539	0644	edit dl rm
binhex.rst.txt	1709	0644	edit dl rm
bisect.rst.txt	5398	0644	edit dl rm
builtins.rst.txt	1465	0644	edit dl rm
bz2.rst.txt	8825	0644	edit dl rm
calendar.rst.txt	10988	0644	edit dl rm
cgi.rst.txt	22650	0644	edit dl rm
cgitb.rst.txt	2918	0644	edit dl rm
chunk.rst.txt	5094	0644	edit dl rm
cmath.rst.txt	9326	0644	edit dl rm
cmd.rst.txt	13795	0644	edit dl rm
code.rst.txt	7817	0644	edit dl rm
codecs.rst.txt	75564	0644	edit dl rm
codeop.rst.txt	3021	0644	edit dl rm
collections.abc.rst.txt	12861	0644	edit dl rm
collections.rst.txt	46063	0644	edit dl rm
colorsys.rst.txt	1820	0644	edit dl rm
compileall.rst.txt	8975	0644	edit dl rm
concurrency.rst.txt	673	0644	edit dl rm
concurrent.futures.rst.txt	16910	0644	edit dl rm
concurrent.rst.txt	171	0644	edit dl rm
configparser.rst.txt	48756	0644	edit dl rm
constants.rst.txt	3331	0644	edit dl rm
contextlib.rst.txt	28175	0644	edit dl rm
copy.rst.txt	3378	0644	edit dl rm
copyreg.rst.txt	2182	0644	edit dl rm
crypt.rst.txt	5122	0644	edit dl rm
crypto.rst.txt	411	0644	edit dl rm
csv.rst.txt	19902	0644	edit dl rm
ctypes.rst.txt	88613	0644	edit dl rm
curses.ascii.rst.txt	8920	0644	edit dl rm
curses.panel.rst.txt	2764	0644	edit dl rm
curses.rst.txt	76397	0644	edit dl rm
custominterp.rst.txt	569	0644	edit dl rm
datatypes.rst.txt	751	0644	edit dl rm
datetime.rst.txt	90524	0644	edit dl rm
dbm.rst.txt	14293	0644	edit dl rm
debug.rst.txt	471	0644	edit dl rm
decimal.rst.txt	74869	0644	edit dl rm
development.rst.txt	704	0644	edit dl rm
difflib.rst.txt	29861	0644	edit dl rm
dis.rst.txt	32567	0644	edit dl rm
distribution.rst.txt	452	0644	edit dl rm
distutils.rst.txt	1974	0644	edit dl rm
doctest.rst.txt	71743	0644	edit dl rm
dummy_threading.rst.txt	784	0644	edit dl rm
email.charset.rst.txt	9293	0644	edit dl rm
email.compat32-message.rst.txt	33493	0644	edit dl rm
email.contentmanager.rst.txt	9112	0644	edit dl rm
email.encoders.rst.txt	2715	0644	edit dl rm
email.errors.rst.txt	4792	0644	edit dl rm
email.examples.rst.txt	1915	0644	edit dl rm
email.generator.rst.txt	13637	0644	edit dl rm
email.header.rst.txt	9188	0644	edit dl rm
email.headerregistry.rst.txt	17957	0644	edit dl rm
email.iterators.rst.txt	2795	0644	edit dl rm
email.message.rst.txt	33008	0644	edit dl rm
email.mime.rst.txt	11721	0644	edit dl rm
email.parser.rst.txt	14092	0644	edit dl rm
email.policy.rst.txt	27022	0644	edit dl rm
email.rst.txt	6785	0644	edit dl rm
email.util.rst.txt	9214	0644	edit dl rm
ensurepip.rst.txt	4987	0644	edit dl rm
enum.rst.txt	32751	0644	edit dl rm
errno.rst.txt	6811	0644	edit dl rm
exceptions.rst.txt	25570	0644	edit dl rm
faulthandler.rst.txt	6136	0644	edit dl rm
fcntl.rst.txt	7152	0644	edit dl rm
filecmp.rst.txt	5623	0644	edit dl rm
fileformats.rst.txt	287	0644	edit dl rm
fileinput.rst.txt	8051	0644	edit dl rm
filesys.rst.txt	961	0644	edit dl rm
fnmatch.rst.txt	3103	0644	edit dl rm
formatter.rst.txt	13242	0644	edit dl rm
fpectl.rst.txt	4180	0644	edit dl rm
fractions.rst.txt	6364	0644	edit dl rm
frameworks.rst.txt	391	0644	edit dl rm
ftplib.rst.txt	17552	0644	edit dl rm
functional.rst.txt	365	0644	edit dl rm
functions.rst.txt	71621	0644	edit dl rm
functools.rst.txt	18503	0644	edit dl rm
gc.rst.txt	9694	0644	edit dl rm
getopt.rst.txt	6557	0644	edit dl rm
getpass.rst.txt	1882	0644	edit dl rm
gettext.rst.txt	25588	0644	edit dl rm
glob.rst.txt	3508	0644	edit dl rm
grp.rst.txt	2417	0644	edit dl rm
gzip.rst.txt	8301	0644	edit dl rm
hashlib.rst.txt	26523	0644	edit dl rm
heapq.rst.txt	13402	0644	edit dl rm
hmac.rst.txt	4020	0644	edit dl rm
html.entities.rst.txt	1319	0644	edit dl rm
html.parser.rst.txt	11275	0644	edit dl rm
html.rst.txt	1304	0644	edit dl rm
http.client.rst.txt	18870	0644	edit dl rm
http.cookiejar.rst.txt	27832	0644	edit dl rm
http.cookies.rst.txt	8645	0644	edit dl rm
http.rst.txt	7096	0644	edit dl rm
http.server.rst.txt	17639	0644	edit dl rm
i18n.rst.txt	408	0644	edit dl rm
idle.rst.txt	25834	0644	edit dl rm
imaplib.rst.txt	20367	0644	edit dl rm
imghdr.rst.txt	2938	0644	edit dl rm
imp.rst.txt	15548	0644	edit dl rm
importlib.rst.txt	53563	0644	edit dl rm
index.rst.txt	2258	0644	edit dl rm
inspect.rst.txt	53928	0644	edit dl rm
internet.rst.txt	992	0644	edit dl rm
intro.rst.txt	2645	0644	edit dl rm
io.rst.txt	40328	0644	edit dl rm
ipaddress.rst.txt	32340	0644	edit dl rm
ipc.rst.txt	649	0644	edit dl rm
itertools.rst.txt	38459	0644	edit dl rm
json.rst.txt	27876	0644	edit dl rm
keyword.rst.txt	617	0644	edit dl rm
language.rst.txt	522	0644	edit dl rm
linecache.rst.txt	2408	0644	edit dl rm
locale.rst.txt	25470	0644	edit dl rm
logging.config.rst.txt	33886	0644	edit dl rm
logging.handlers.rst.txt	42497	0644	edit dl rm
logging.rst.txt	60479	0644	edit dl rm
lzma.rst.txt	17361	0644	edit dl rm
macpath.rst.txt	707	0644	edit dl rm
mailbox.rst.txt	63055	0644	edit dl rm
mailcap.rst.txt	3691	0644	edit dl rm
markup.rst.txt	679	0644	edit dl rm
marshal.rst.txt	4855	0644	edit dl rm
math.rst.txt	14375	0644	edit dl rm
mimetypes.rst.txt	9839	0644	edit dl rm
misc.rst.txt	247	0644	edit dl rm
mm.rst.txt	431	0644	edit dl rm
mmap.rst.txt	11232	0644	edit dl rm
modulefinder.rst.txt	3240	0644	edit dl rm
modules.rst.txt	355	0644	edit dl rm
msilib.rst.txt	18612	0644	edit dl rm
msvcrt.rst.txt	4392	0644	edit dl rm
multiprocessing.rst.txt	104494	0644	edit dl rm
netdata.rst.txt	339	0644	edit dl rm
netrc.rst.txt	3007	0644	edit dl rm
nis.rst.txt	1993	0644	edit dl rm
nntplib.rst.txt	21821	0644	edit dl rm
numbers.rst.txt	8089	0644	edit dl rm
numeric.rst.txt	696	0644	edit dl rm
operator.rst.txt	18989	0644	edit dl rm
optparse.rst.txt	76996	0644	edit dl rm
os.path.rst.txt	16419	0644	edit dl rm
os.rst.txt	137534	0644	edit dl rm
ossaudiodev.rst.txt	17845	0644	edit dl rm
othergui.rst.txt	2822	0644	edit dl rm
parser.rst.txt	15148	0644	edit dl rm
pathlib.rst.txt	30045	0644	edit dl rm
pdb.rst.txt	19454	0644	edit dl rm
persistence.rst.txt	591	0644	edit dl rm
pickle.rst.txt	37440	0644	edit dl rm
pickletools.rst.txt	3729	0644	edit dl rm
pipes.rst.txt	2557	0644	edit dl rm
pkgutil.rst.txt	8730	0644	edit dl rm
platform.rst.txt	9624	0644	edit dl rm
plistlib.rst.txt	7398	0644	edit dl rm
poplib.rst.txt	8197	0644	edit dl rm
posix.rst.txt	3694	0644	edit dl rm
pprint.rst.txt	14274	0644	edit dl rm
profile.rst.txt	27969	0644	edit dl rm
pty.rst.txt	3123	0644	edit dl rm
pwd.rst.txt	2739	0644	edit dl rm
pyclbr.rst.txt	3297	0644	edit dl rm
pydoc.rst.txt	4688	0644	edit dl rm
pyexpat.rst.txt	28620	0644	edit dl rm
python.rst.txt	475	0644	edit dl rm
py_compile.rst.txt	3851	0644	edit dl rm
queue.rst.txt	7268	0644	edit dl rm
quopri.rst.txt	2571	0644	edit dl rm
random.rst.txt	18503	0644	edit dl rm
re.rst.txt	64936	0644	edit dl rm
readline.rst.txt	11943	0644	edit dl rm
reprlib.rst.txt	5162	0644	edit dl rm
resource.rst.txt	12291	0644	edit dl rm
rlcompleter.rst.txt	2294	0644	edit dl rm
runpy.rst.txt	8285	0644	edit dl rm
sched.rst.txt	4842	0644	edit dl rm
secrets.rst.txt	5930	0644	edit dl rm
select.rst.txt	28175	0644	edit dl rm
selectors.rst.txt	8925	0644	edit dl rm
shelve.rst.txt	8390	0644	edit dl rm
shlex.rst.txt	16441	0644	edit dl rm
shutil.rst.txt	26014	0644	edit dl rm
signal.rst.txt	17218	0644	edit dl rm
site.rst.txt	9628	0644	edit dl rm
smtpd.rst.txt	10806	0644	edit dl rm
smtplib.rst.txt	23439	0644	edit dl rm
sndhdr.rst.txt	1994	0644	edit dl rm
socket.rst.txt	68202	0644	edit dl rm
socketserver.rst.txt	23712	0644	edit dl rm
spwd.rst.txt	2958	0644	edit dl rm
sqlite3.rst.txt	39215	0644	edit dl rm
ssl.rst.txt	96021	0644	edit dl rm
stat.rst.txt	9805	0644	edit dl rm
statistics.rst.txt	15301	0644	edit dl rm
stdtypes.rst.txt	179240	0644	edit dl rm
string.rst.txt	35374	0644	edit dl rm
stringprep.rst.txt	4279	0644	edit dl rm
struct.rst.txt	19581	0644	edit dl rm
subprocess.rst.txt	45793	0644	edit dl rm
sunau.rst.txt	7390	0644	edit dl rm
superseded.rst.txt	258	0644	edit dl rm
symbol.rst.txt	975	0644	edit dl rm
symtable.rst.txt	4964	0644	edit dl rm
sys.rst.txt	58273	0644	edit dl rm
sysconfig.rst.txt	8749	0644	edit dl rm
syslog.rst.txt	4302	0644	edit dl rm
tabnanny.rst.txt	2007	0644	edit dl rm
tarfile.rst.txt	31749	0644	edit dl rm
telnetlib.rst.txt	7899	0644	edit dl rm
tempfile.rst.txt	13857	0644	edit dl rm
termios.rst.txt	3751	0644	edit dl rm
test.rst.txt	25764	0644	edit dl rm
text.rst.txt	584	0644	edit dl rm
textwrap.rst.txt	10519	0644	edit dl rm
threading.rst.txt	39257	0644	edit dl rm
time.rst.txt	32967	0644	edit dl rm
timeit.rst.txt	13000	0644	edit dl rm
tk.rst.txt	1639	0644	edit dl rm
tkinter.rst.txt	33027	0644	edit dl rm
tkinter.scrolledtext.rst.txt	1255	0644	edit dl rm
tkinter.tix.rst.txt	22653	0644	edit dl rm
tkinter.ttk.rst.txt	58489	0644	edit dl rm
token.rst.txt	2607	0644	edit dl rm
tokenize.rst.txt	10002	0644	edit dl rm
trace.rst.txt	6914	0644	edit dl rm
traceback.rst.txt	17854	0644	edit dl rm
tracemalloc.rst.txt	22089	0644	edit dl rm
tty.rst.txt	1097	0644	edit dl rm
turtle.rst.txt	71221	0644	edit dl rm
types.rst.txt	9999	0644	edit dl rm
typing.rst.txt	34332	0644	edit dl rm
undoc.rst.txt	780	0644	edit dl rm
unicodedata.rst.txt	5762	0644	edit dl rm
unittest.mock-examples.rst.txt	46206	0644	edit dl rm
unittest.mock.rst.txt	85991	0644	edit dl rm
unittest.rst.txt	93304	0644	edit dl rm
unix.rst.txt	446	0644	edit dl rm
urllib.error.rst.txt	2199	0644	edit dl rm
urllib.parse.rst.txt	27332	0644	edit dl rm
urllib.request.rst.txt	59360	0644	edit dl rm
urllib.robotparser.rst.txt	2969	0644	edit dl rm
urllib.rst.txt	466	0644	edit dl rm
uu.rst.txt	2387	0644	edit dl rm
uuid.rst.txt	8760	0644	edit dl rm
venv.rst.txt	20621	0644	edit dl rm
warnings.rst.txt	20152	0644	edit dl rm
wave.rst.txt	6870	0644	edit dl rm
weakref.rst.txt	21328	0644	edit dl rm
webbrowser.rst.txt	9783	0644	edit dl rm
windows.rst.txt	272	0644	edit dl rm
winreg.rst.txt	24073	0644	edit dl rm
winsound.rst.txt	5134	0644	edit dl rm
wsgiref.rst.txt	33047	0644	edit dl rm
xdrlib.rst.txt	8078	0644	edit dl rm
xml.dom.minidom.rst.txt	10198	0644	edit dl rm
xml.dom.pulldom.rst.txt	5186	0644	edit dl rm
xml.dom.rst.txt	39507	0644	edit dl rm
xml.etree.elementtree.rst.txt	43871	0644	edit dl rm
xml.rst.txt	6071	0644	edit dl rm
xml.sax.handler.rst.txt	15399	0644	edit dl rm
xml.sax.reader.rst.txt	12133	0644	edit dl rm
xml.sax.rst.txt	7159	0644	edit dl rm
xml.sax.utils.rst.txt	3901	0644	edit dl rm
xmlrpc.client.rst.txt	23071	0644	edit dl rm
xmlrpc.rst.txt	475	0644	edit dl rm
xmlrpc.server.rst.txt	14990	0644	edit dl rm
zipapp.rst.txt	17392	0644	edit dl rm
zipfile.rst.txt	24005	0644	edit dl rm
zipimport.rst.txt	5805	0644	edit dl rm
zlib.rst.txt	13912	0644	edit dl rm
_dummy_thread.rst.txt	762	0644	edit dl rm
_thread.rst.txt	6886	0644	edit dl rm
__future__.rst.txt	5245	0644	edit dl rm
__main__.rst.txt	904	0644	edit dl rm

Edit: /usr/share/doc/python3-docs/html/_sources/library/imaplib.rst.txt (20367B)

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

.. module:: imaplib
   :synopsis: IMAP4 protocol client (requires sockets).

.. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. revised by ESR, January 2000
.. changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002
.. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
   November 2002

**Source code:** :source:`Lib/imaplib.py`

.. index::
   pair: IMAP4; protocol
   pair: IMAP4_SSL; protocol
   pair: IMAP4_stream; protocol

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

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

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

.. class:: IMAP4(host='', port=IMAP4_PORT)

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 :class:`IMAP4` class supports the :keyword:`with` statement.  When used
   like this, the IMAP4 ``LOGOUT`` command is issued automatically when the
   :keyword:`with` statement exits.  E.g.::

>>> from imaplib import IMAP4
    >>> with IMAP4("domain.org") as M:
    ...     M.noop()
    ...
    ('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])

.. versionchanged:: 3.5
      Support for the :keyword:`with` statement was added.

Three exceptions are defined as attributes of the :class:`IMAP4` class:

.. exception:: IMAP4.error

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

.. exception:: IMAP4.abort

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

.. exception:: IMAP4.readonly

This exception is raised when a writable mailbox has its status changed by the
   server.  This is a sub-class of :exc:`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:

.. class:: IMAP4_SSL(host='', port=IMAP4_SSL_PORT, keyfile=None, \
                     certfile=None, ssl_context=None)

This is a subclass derived from :class:`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 :class:`ssl.SSLContext` object which allows bundling
   SSL configuration options, certificates and private keys into a single
   (potentially long-lived) structure.  Please read :ref:`ssl-security` for
   best practices.

*keyfile* and *certfile* are a legacy alternative to *ssl_context* - they
   can point to PEM-formatted private key and certificate chain files for
   the SSL connection.  Note that the *keyfile*/*certfile* parameters are
   mutually exclusive with *ssl_context*, a :class:`ValueError` is raised
   if *keyfile*/*certfile* is provided along with *ssl_context*.

.. versionchanged:: 3.3
      *ssl_context* parameter added.

.. versionchanged:: 3.4
      The class now supports hostname check with
      :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
      :data:`ssl.HAS_SNI`).

.. deprecated:: 3.6

*keyfile* and *certfile* are deprecated in favor of *ssl_context*.
       Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
       :func:`ssl.create_default_context` select the system's trusted CA
       certificates for you.

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

.. class:: IMAP4_stream(command)

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

The following utility functions are defined:

.. function:: Internaldate2tuple(datestr)

Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local
   time.  The return value is a :class:`time.struct_time` tuple or
   ``None`` if the string has wrong format.

.. function:: Int2AP(num)

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

.. function:: ParseFlags(flagstr)

Converts an IMAP4 ``FLAGS`` response to a tuple of individual flags.

.. function:: Time2Internaldate(date_time)

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 :func:`time.time`), a 9-tuple representing local time
   an instance of :class:`time.struct_time` (as returned by
   :func:`time.localtime`), an aware instance of
   :class:`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.

.. seealso::

Documents describing the protocol, and sources and binaries  for servers
   implementing it, can all be found at the University of Washington's *IMAP
   Information Center* (https://www.washington.edu/imap/).

.. _imap4-objects:

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. Each *data* is either a string, 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 :class:`IMAP4` instance has the following methods:

.. method:: IMAP4.append(mailbox, flags, date_time, message)

Append *message* to named mailbox.

.. method:: IMAP4.authenticate(mechanism, authobject)

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.

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

.. method:: IMAP4.check()

Checkpoint mailbox on server.

.. method:: IMAP4.close()

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

.. method:: IMAP4.copy(message_set, new_mailbox)

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

.. method:: IMAP4.create(mailbox)

Create new mailbox named *mailbox*.

.. method:: IMAP4.delete(mailbox)

Delete old mailbox named *mailbox*.

.. method:: IMAP4.deleteacl(mailbox, who)

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

.. method:: IMAP4.enable(capability)

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

.. versionadded:: 3.5
      The :meth:`enable` method itself, and :RFC:`6855` support.

.. method:: IMAP4.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.

.. method:: IMAP4.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.

.. method:: IMAP4.getacl(mailbox)

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

.. method:: IMAP4.getannotation(mailbox, entry, attribute)

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

.. method:: IMAP4.getquota(root)

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

.. method:: IMAP4.getquotaroot(mailbox)

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

.. method:: IMAP4.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.

.. method:: IMAP4.login(user, password)

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

.. method:: IMAP4.login_cram_md5(user, password)

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

.. method:: IMAP4.logout()

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

.. method:: IMAP4.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.

.. method:: IMAP4.myrights(mailbox)

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

.. method:: IMAP4.namespace()

Returns IMAP namespaces as defined in :rfc:`2342`.

.. method:: IMAP4.noop()

Send ``NOOP`` to server.

.. method:: IMAP4.open(host, port)

Opens socket to *port* at *host*.  This method is implicitly called by
   the :class:`IMAP4` constructor.  The connection objects established by this
   method will be used in the :meth:`IMAP4.read`, :meth:`IMAP4.readline`,
   :meth:`IMAP4.send`, and :meth:`IMAP4.shutdown` methods.  You may override
   this method.

.. method:: IMAP4.partial(message_num, message_part, start, length)

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

.. method:: IMAP4.proxyauth(user)

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

.. method:: IMAP4.read(size)

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

.. method:: IMAP4.readline()

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

.. method:: IMAP4.recent()

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

.. method:: IMAP4.rename(oldmailbox, newmailbox)

Rename mailbox named *oldmailbox* to *newmailbox*.

.. method:: IMAP4.response(code)

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

.. method:: IMAP4.search(charset, criterion[, ...])

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 :meth:`enable`
   command.

Example::

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

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

.. method:: IMAP4.select(mailbox='INBOX', readonly=False)

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.

.. method:: IMAP4.send(data)

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

.. method:: IMAP4.setacl(mailbox, who, what)

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

.. method:: IMAP4.setannotation(mailbox, entry, attribute[, ...])

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

.. method:: IMAP4.setquota(root, limits)

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

.. method:: IMAP4.shutdown()

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

.. method:: IMAP4.socket()

Returns socket instance used to connect to server.

.. method:: IMAP4.sort(sort_criteria, charset, search_criterion[, ...])

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.

.. method:: IMAP4.starttls(ssl_context=None)

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

.. versionadded:: 3.2

.. versionchanged:: 3.4
      The method now supports hostname check with
      :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
      :data:`ssl.HAS_SNI`).

.. method:: IMAP4.status(mailbox, names)

Request named status conditions for *mailbox*.

.. method:: IMAP4.store(message_set, command, flag_list)

Alters flag dispositions for messages in mailbox.  *command* is specified by
   section 6.4.6 of :rfc:`2060` 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()

.. note::

Creating flags containing ']' (for example: "[test]") violates
      :rfc:`3501` (the IMAP protocol).  However, imaplib has historically
      allowed creation of such tags, and popular IMAP servers, such as Gmail,
      accept and produce such flags.  There are non-Python programs which also
      create such tags.  Although it is an RFC violation and IMAP clients and
      servers are supposed to be strict, imaplib nonetheless continues to allow
      such tags 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.

.. method:: IMAP4.subscribe(mailbox)

Subscribe to new mailbox.

.. method:: IMAP4.thread(threading_algorithm, charset, search_criterion[, ...])

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.

.. method:: IMAP4.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.

.. method:: IMAP4.unsubscribe(mailbox)

Unsubscribe from old mailbox.

.. method:: IMAP4.xatom(name[, ...])

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

The following attributes are defined on instances of :class:`IMAP4`:

.. attribute:: IMAP4.PROTOCOL_VERSION

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

.. attribute:: IMAP4.debug

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

.. attribute:: IMAP4.utf8_enabled

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

.. versionadded:: 3.5

.. _imap4-example:

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

:mod:`imaplib` --- IMAP4 protocol client ======================================== .. module:: imaplib :synopsis: IMAP4 protocol client (requires sockets). .. moduleauthor:: Piers Lauder .. sectionauthor:: Piers Lauder .. revised by ESR, January 2000 .. changes for IMAP4_SSL by Tino Lange , March 2002 .. changes for IMAP4_stream by Piers Lauder , November 2002 **Source code:** :source:`Lib/imaplib.py` .. index:: pair: IMAP4; protocol pair: IMAP4_SSL; protocol pair: IMAP4_stream; protocol -------------- This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and :class:`IMAP4_stream`, which encapsulate a connection to an IMAP4 server and implement a large subset of the IMAP4rev1 client protocol as defined in :rfc:`2060`. It is backward compatible with IMAP4 (:rfc:`1730`) servers, but note that the ``STATUS`` command is not supported in IMAP4. Three classes are provided by the :mod:`imaplib` module, :class:`IMAP4` is the base class: .. class:: IMAP4(host='', port=IMAP4_PORT) 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 :class:`IMAP4` class supports the :keyword:`with` statement. When used like this, the IMAP4 ``LOGOUT`` command is issued automatically when the :keyword:`with` statement exits. E.g.:: >>> from imaplib import IMAP4 >>> with IMAP4("domain.org") as M: ... M.noop() ... ('OK', [b'Nothing Accomplished. d25if65hy903weo.87']) .. versionchanged:: 3.5 Support for the :keyword:`with` statement was added. Three exceptions are defined as attributes of the :class:`IMAP4` class: .. exception:: IMAP4.error Exception raised on any errors. The reason for the exception is passed to the constructor as a string. .. exception:: IMAP4.abort IMAP4 server errors cause this exception to be raised. This is a sub-class of :exc:`IMAP4.error`. Note that closing the instance and instantiating a new one will usually allow recovery from this exception. .. exception:: IMAP4.readonly This exception is raised when a writable mailbox has its status changed by the server. This is a sub-class of :exc:`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: .. class:: IMAP4_SSL(host='', port=IMAP4_SSL_PORT, keyfile=None, \ certfile=None, ssl_context=None) This is a subclass derived from :class:`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 :class:`ssl.SSLContext` object which allows bundling SSL configuration options, certificates and private keys into a single (potentially long-lived) structure. Please read :ref:`ssl-security` for best practices. *keyfile* and *certfile* are a legacy alternative to *ssl_context* - they can point to PEM-formatted private key and certificate chain files for the SSL connection. Note that the *keyfile*/*certfile* parameters are mutually exclusive with *ssl_context*, a :class:`ValueError` is raised if *keyfile*/*certfile* is provided along with *ssl_context*. .. versionchanged:: 3.3 *ssl_context* parameter added. .. versionchanged:: 3.4 The class now supports hostname check with :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see :data:`ssl.HAS_SNI`). .. deprecated:: 3.6 *keyfile* and *certfile* are deprecated in favor of *ssl_context*. Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let :func:`ssl.create_default_context` select the system's trusted CA certificates for you. The second subclass allows for connections created by a child process: .. class:: IMAP4_stream(command) This is a subclass derived from :class:`IMAP4` that connects to the ``stdin/stdout`` file descriptors created by passing *command* to ``subprocess.Popen()``. The following utility functions are defined: .. function:: Internaldate2tuple(datestr) Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local time. The return value is a :class:`time.struct_time` tuple or ``None`` if the string has wrong format. .. function:: Int2AP(num) Converts an integer into a string representation using characters from the set [``A`` .. ``P``]. .. function:: ParseFlags(flagstr) Converts an IMAP4 ``FLAGS`` response to a tuple of individual flags. .. function:: Time2Internaldate(date_time) 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 :func:`time.time`), a 9-tuple representing local time an instance of :class:`time.struct_time` (as returned by :func:`time.localtime`), an aware instance of :class:`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. .. seealso:: Documents describing the protocol, and sources and binaries for servers implementing it, can all be found at the University of Washington's *IMAP Information Center* (https://www.washington.edu/imap/). .. _imap4-objects: 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. Each *data* is either a string, 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 :class:`IMAP4` instance has the following methods: .. method:: IMAP4.append(mailbox, flags, date_time, message) Append *message* to named mailbox. .. method:: IMAP4.authenticate(mechanism, authobject) 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. .. versionchanged:: 3.5 string usernames and passwords are now encoded to ``utf-8`` instead of being limited to ASCII. .. method:: IMAP4.check() Checkpoint mailbox on server. .. method:: IMAP4.close() Close currently selected mailbox. Deleted messages are removed from writable mailbox. This is the recommended command before ``LOGOUT``. .. method:: IMAP4.copy(message_set, new_mailbox) Copy *message_set* messages onto end of *new_mailbox*. .. method:: IMAP4.create(mailbox) Create new mailbox named *mailbox*. .. method:: IMAP4.delete(mailbox) Delete old mailbox named *mailbox*. .. method:: IMAP4.deleteacl(mailbox, who) Delete the ACLs (remove any rights) set for who on mailbox. .. method:: IMAP4.enable(capability) Enable *capability* (see :rfc:`5161`). Most capabilities do not need to be enabled. Currently only the ``UTF8=ACCEPT`` capability is supported (see :RFC:`6855`). .. versionadded:: 3.5 The :meth:`enable` method itself, and :RFC:`6855` support. .. method:: IMAP4.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. .. method:: IMAP4.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. .. method:: IMAP4.getacl(mailbox) Get the ``ACL``\ s for *mailbox*. The method is non-standard, but is supported by the ``Cyrus`` server. .. method:: IMAP4.getannotation(mailbox, entry, attribute) Retrieve the specified ``ANNOTATION``\ s for *mailbox*. The method is non-standard, but is supported by the ``Cyrus`` server. .. method:: IMAP4.getquota(root) Get the ``quota`` *root*'s resource usage and limits. This method is part of the IMAP4 QUOTA extension defined in rfc2087. .. method:: IMAP4.getquotaroot(mailbox) Get the list of ``quota`` ``roots`` for the named *mailbox*. This method is part of the IMAP4 QUOTA extension defined in rfc2087. .. method:: IMAP4.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. .. method:: IMAP4.login(user, password) Identify the client using a plaintext password. The *password* will be quoted. .. method:: IMAP4.login_cram_md5(user, password) 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``. .. method:: IMAP4.logout() Shutdown connection to server. Returns server ``BYE`` response. .. method:: IMAP4.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. .. method:: IMAP4.myrights(mailbox) Show my ACLs for a mailbox (i.e. the rights that I have on mailbox). .. method:: IMAP4.namespace() Returns IMAP namespaces as defined in :rfc:`2342`. .. method:: IMAP4.noop() Send ``NOOP`` to server. .. method:: IMAP4.open(host, port) Opens socket to *port* at *host*. This method is implicitly called by the :class:`IMAP4` constructor. The connection objects established by this method will be used in the :meth:`IMAP4.read`, :meth:`IMAP4.readline`, :meth:`IMAP4.send`, and :meth:`IMAP4.shutdown` methods. You may override this method. .. method:: IMAP4.partial(message_num, message_part, start, length) Fetch truncated part of a message. Returned data is a tuple of message part envelope and data. .. method:: IMAP4.proxyauth(user) Assume authentication as *user*. Allows an authorised administrator to proxy into any user's mailbox. .. method:: IMAP4.read(size) Reads *size* bytes from the remote server. You may override this method. .. method:: IMAP4.readline() Reads one line from the remote server. You may override this method. .. method:: IMAP4.recent() Prompt server for an update. Returned data is ``None`` if no new messages, else value of ``RECENT`` response. .. method:: IMAP4.rename(oldmailbox, newmailbox) Rename mailbox named *oldmailbox* to *newmailbox*. .. method:: IMAP4.response(code) Return data for response *code* if received, or ``None``. Returns the given code, instead of the usual type. .. method:: IMAP4.search(charset, criterion[, ...]) 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 :meth:`enable` command. Example:: # M is a connected IMAP4 instance... typ, msgnums = M.search(None, 'FROM', '"LDJ"') # or: typ, msgnums = M.search(None, '(FROM "LDJ")') .. method:: IMAP4.select(mailbox='INBOX', readonly=False) 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. .. method:: IMAP4.send(data) Sends ``data`` to the remote server. You may override this method. .. method:: IMAP4.setacl(mailbox, who, what) Set an ``ACL`` for *mailbox*. The method is non-standard, but is supported by the ``Cyrus`` server. .. method:: IMAP4.setannotation(mailbox, entry, attribute[, ...]) Set ``ANNOTATION``\ s for *mailbox*. The method is non-standard, but is supported by the ``Cyrus`` server. .. method:: IMAP4.setquota(root, limits) Set the ``quota`` *root*'s resource *limits*. This method is part of the IMAP4 QUOTA extension defined in rfc2087. .. method:: IMAP4.shutdown() Close connection established in ``open``. This method is implicitly called by :meth:`IMAP4.logout`. You may override this method. .. method:: IMAP4.socket() Returns socket instance used to connect to server. .. method:: IMAP4.sort(sort_criteria, charset, search_criterion[, ...]) 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. .. method:: IMAP4.starttls(ssl_context=None) Send a ``STARTTLS`` command. The *ssl_context* argument is optional and should be a :class:`ssl.SSLContext` object. This will enable encryption on the IMAP connection. Please read :ref:`ssl-security` for best practices. .. versionadded:: 3.2 .. versionchanged:: 3.4 The method now supports hostname check with :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see :data:`ssl.HAS_SNI`). .. method:: IMAP4.status(mailbox, names) Request named status conditions for *mailbox*. .. method:: IMAP4.store(message_set, command, flag_list) Alters flag dispositions for messages in mailbox. *command* is specified by section 6.4.6 of :rfc:`2060` 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() .. note:: Creating flags containing ']' (for example: "[test]") violates :rfc:`3501` (the IMAP protocol). However, imaplib has historically allowed creation of such tags, and popular IMAP servers, such as Gmail, accept and produce such flags. There are non-Python programs which also create such tags. Although it is an RFC violation and IMAP clients and servers are supposed to be strict, imaplib nonetheless continues to allow such tags 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. .. method:: IMAP4.subscribe(mailbox) Subscribe to new mailbox. .. method:: IMAP4.thread(threading_algorithm, charset, search_criterion[, ...]) 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. .. method:: IMAP4.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. .. method:: IMAP4.unsubscribe(mailbox) Unsubscribe from old mailbox. .. method:: IMAP4.xatom(name[, ...]) Allow simple extension commands notified by server in ``CAPABILITY`` response. The following attributes are defined on instances of :class:`IMAP4`: .. attribute:: IMAP4.PROTOCOL_VERSION The most recent supported protocol in the ``CAPABILITY`` response from the server. .. attribute:: IMAP4.debug Integer value to control debugging output. The initialize value is taken from the module variable ``Debug``. Values greater than three trace each command. .. attribute:: IMAP4.utf8_enabled Boolean value that is normally ``False``, but is set to ``True`` if an :meth:`enable` command is successfully issued for the ``UTF8=ACCEPT`` capability. .. versionadded:: 3.5 .. _imap4-example: 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() 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()