📄 module-imaplib.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>11.8 imaplib -- IMAP4 protocol client</title>
<META NAME="description" CONTENT="11.8 imaplib -- IMAP4 protocol client">
<META NAME="keywords" CONTENT="lib">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="STYLESHEET" href="lib.css" tppabs="http://www.python.org/doc/current/lib/lib.css">
<LINK REL="next" href="module-nntplib.html" tppabs="http://www.python.org/doc/current/lib/module-nntplib.html">
<LINK REL="previous" href="module-poplib.html" tppabs="http://www.python.org/doc/current/lib/module-poplib.html">
<LINK REL="up" href="internet.html" tppabs="http://www.python.org/doc/current/lib/internet.html">
<LINK REL="next" href="imap4-objects.html" tppabs="http://www.python.org/doc/current/lib/imap4-objects.html">
</head>
<body>
<DIV CLASS="navigation"><table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A href="pop3-example.html" tppabs="http://www.python.org/doc/current/lib/pop3-example.html"><img src="previous.gif" tppabs="http://www.python.org/doc/current/icons/previous.gif" border="0" height="32"
alt="Previous Page" width="32"></A></td>
<td><A href="internet.html" tppabs="http://www.python.org/doc/current/lib/internet.html"><img src="up.gif" tppabs="http://www.python.org/doc/current/icons/up.gif" border="0" height="32"
alt="Up One Level" width="32"></A></td>
<td><A href="imap4-objects.html" tppabs="http://www.python.org/doc/current/lib/imap4-objects.html"><img src="next.gif" tppabs="http://www.python.org/doc/current/icons/next.gif" border="0" height="32"
alt="Next Page" width="32"></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td><A href="contents.html" tppabs="http://www.python.org/doc/current/lib/contents.html"><img src="contents.gif" tppabs="http://www.python.org/doc/current/icons/contents.gif" border="0" height="32"
alt="Contents" width="32"></A></td>
<td><a href="modindex.html" tppabs="http://www.python.org/doc/current/lib/modindex.html" title="Module Index"><img src="modules.gif" tppabs="http://www.python.org/doc/current/icons/modules.gif" border="0" height="32"
alt="Module Index" width="32"></a></td>
<td><A href="genindex.html" tppabs="http://www.python.org/doc/current/lib/genindex.html"><img src="index.gif" tppabs="http://www.python.org/doc/current/icons/index.gif" border="0" height="32"
alt="Index" width="32"></A></td>
</tr></table>
<b class="navlabel">Previous:</b> <a class="sectref" href="pop3-example.html" tppabs="http://www.python.org/doc/current/lib/pop3-example.html">11.7.2 POP3 Example</A>
<b class="navlabel">Up:</b> <a class="sectref" href="internet.html" tppabs="http://www.python.org/doc/current/lib/internet.html">11. Internet Protocols and</A>
<b class="navlabel">Next:</b> <a class="sectref" href="imap4-objects.html" tppabs="http://www.python.org/doc/current/lib/imap4-objects.html">11.8.1 IMAP4 Objects</A>
<br><hr></DIV>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION0013800000000000000000">
11.8 <tt class="module">imaplib</tt> --
IMAP4 protocol client</A>
</H1>
<P>
<P>
<P>
This module defines a class, <tt class="class">IMAP4</tt>, which encapsulates a
connection to an IMAP4 server and implements the IMAP4rev1 client
protocol as defined in <a class="rfc" name="rfcref-47068"
href="javascript:if(confirm('http://www.ietf.org/rfc/rfc2060.txt \n\nThis file was not retrieved by Teleport Pro, because it is addressed on a domain or path outside the boundaries set for its Starting Address. \n\nDo you want to open it from the server?'))window.location='http://www.ietf.org/rfc/rfc2060.txt'" tppabs="http://www.ietf.org/rfc/rfc2060.txt">RFC 2060 <img src="offsite.gif" tppabs="http://www.python.org/doc/current/icons/offsite.gif"
border='0' class='offsitelink' height='15' width='17' alt='[off-site link]'
></a>. It is backward compatible with
IMAP4 (<a class="rfc" name="rfcref-47070"
href="javascript:if(confirm('http://www.ietf.org/rfc/rfc1730.txt \n\nThis file was not retrieved by Teleport Pro, because it is addressed on a domain or path outside the boundaries set for its Starting Address. \n\nDo you want to open it from the server?'))window.location='http://www.ietf.org/rfc/rfc1730.txt'" tppabs="http://www.ietf.org/rfc/rfc1730.txt">RFC 1730 <img src="offsite.gif" tppabs="http://www.python.org/doc/current/icons/offsite.gif"
border='0' class='offsitelink' height='15' width='17' alt='[off-site link]'
></a>) servers, but note that the "<tt class="samp">STATUS</tt>" command is
not supported in IMAP4.
<P>
A single class is provided by the <tt class="module">imaplib</tt> module:
<P>
<dl><dt><b><a name='l2h-2091'><tt class='class'>IMAP4</tt></a></b> (<big>[</big><var>host</var><big>[</big><var>, port</var><big>]</big><big>]</big>)
<dd>
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 <var>host</var> is not specified, <code>''</code> (the local host) is used.
If <var>port</var> is omitted, the standard IMAP4 port (143) is used.
</dl>
<P>
Two exceptions are defined as attributes of the <tt class="class">IMAP4</tt> class:
<P>
<dl><dt><b><a name='l2h-2092'><tt class='exception'>IMAP4.error</tt></a></b>
<dd>
Exception raised on any errors. The reason for the exception is
passed to the constructor as a string.
</dl>
<P>
<dl><dt><b><a name='l2h-2093'><tt class='exception'>IMAP4.abort</tt></a></b>
<dd>
IMAP4 server errors cause this exception to be raised. This is a
sub-class of <tt class="exception">IMAP4.error</tt>. Note that closing the instance
and instantiating a new one will usually allow recovery from this
exception.
</dl>
<P>
<dl><dt><b><a name='l2h-2094'><tt class='exception'>IMAP4.readonly</tt></a></b>
<dd>
This exception is raised when a writable mailbox has its status changed by the server. This is a
sub-class of <tt class="exception">IMAP4.error</tt>. Some other client now has write permission,
and the mailbox will need to be re-opened to re-obtain write permission.
</dl>
<P>
The following utility functions are defined:
<P>
<dl><dt><b><a name='l2h-2095'><tt class='function'>Internaldate2tuple</tt></a></b> (<var>datestr</var>)
<dd>
Converts an IMAP4 INTERNALDATE string to Coordinated Universal
Time. Returns a <tt class='module'><a href="module-time.html" tppabs="http://www.python.org/doc/current/lib/module-time.html">time</a></tt> module tuple.
</dl>
<P>
<dl><dt><b><a name='l2h-2096'><tt class='function'>Int2AP</tt></a></b> (<var>num</var>)
<dd>
Converts an integer into a string representation using characters
from the set [<code>A</code> .. <code>P</code>].
</dl>
<P>
<dl><dt><b><a name='l2h-2097'><tt class='function'>ParseFlags</tt></a></b> (<var>flagstr</var>)
<dd>
Converts an IMAP4 "<tt class="samp">FLAGS</tt>" response to a tuple of individual
flags.
</dl>
<P>
<dl><dt><b><a name='l2h-2098'><tt class='function'>Time2Internaldate</tt></a></b> (<var>date_time</var>)
<dd>
Converts a <tt class='module'><a href="module-time.html" tppabs="http://www.python.org/doc/current/lib/module-time.html">time</a></tt> module tuple to an IMAP4
"<tt class="samp">INTERNALDATE</tt>" representation. Returns a string in the form:
<code>"DD-Mmm-YYYY HH:MM:SS +HHMM"</code> (including double-quotes).
</dl>
<P>
Note that IMAP4 message numbers change as the mailbox changes, so it
is highly advisable to use UIDs instead, with the UID command.
<P>
At the end of the module, there is a test section that contains a more
extensive example of usage.
<P>
<div class='seealso'>
<p class='heading'><b>See Also:</b></p>
<div class="seetext"><p>Documents describing the protocol, and sources and binaries
for servers implementing it, can all be found at the
University of Washington's <i>IMAP Information Center</i>
(<a class="url" href="javascript:if(confirm('http://www.cac.washington.edu/imap/ \n\nThis file was not retrieved by Teleport Pro, because it is addressed on a domain or path outside the boundaries set for its Starting Address. \n\nDo you want to open it from the server?'))window.location='http://www.cac.washington.edu/imap/'" tppabs="http://www.cac.washington.edu/imap/">http://www.cac.washington.edu/imap/ <img src="offsite.gif" tppabs="http://www.python.org/doc/current/icons/offsite.gif"
border='0' class='offsitelink' height='15' width='17' alt='[off-site link]'
></a>).</div>
</div>
<P>
<p><hr>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html4051"
href="imap4-objects.html" tppabs="http://www.python.org/doc/current/lib/imap4-objects.html">11.8.1 IMAP4 Objects </A>
<LI><A NAME="tex2html4052"
href="imap4-example.html" tppabs="http://www.python.org/doc/current/lib/imap4-example.html">11.8.2 IMAP4 Example </A>
</UL>
<!--End of Table of Child-Links-->
<DIV CLASS="navigation"><p><hr><table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A href="pop3-example.html" tppabs="http://www.python.org/doc/current/lib/pop3-example.html"><img src="previous.gif" tppabs="http://www.python.org/doc/current/icons/previous.gif" border="0" height="32"
alt="Previous Page" width="32"></A></td>
<td><A href="internet.html" tppabs="http://www.python.org/doc/current/lib/internet.html"><img src="up.gif" tppabs="http://www.python.org/doc/current/icons/up.gif" border="0" height="32"
alt="Up One Level" width="32"></A></td>
<td><A href="imap4-objects.html" tppabs="http://www.python.org/doc/current/lib/imap4-objects.html"><img src="next.gif" tppabs="http://www.python.org/doc/current/icons/next.gif" border="0" height="32"
alt="Next Page" width="32"></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td><A href="contents.html" tppabs="http://www.python.org/doc/current/lib/contents.html"><img src="contents.gif" tppabs="http://www.python.org/doc/current/icons/contents.gif" border="0" height="32"
alt="Contents" width="32"></A></td>
<td><a href="modindex.html" tppabs="http://www.python.org/doc/current/lib/modindex.html" title="Module Index"><img src="modules.gif" tppabs="http://www.python.org/doc/current/icons/modules.gif" border="0" height="32"
alt="Module Index" width="32"></a></td>
<td><A href="genindex.html" tppabs="http://www.python.org/doc/current/lib/genindex.html"><img src="index.gif" tppabs="http://www.python.org/doc/current/icons/index.gif" border="0" height="32"
alt="Index" width="32"></A></td>
</tr></table>
<b class="navlabel">Previous:</b> <a class="sectref" href="pop3-example.html" tppabs="http://www.python.org/doc/current/lib/pop3-example.html">11.7.2 POP3 Example</A>
<b class="navlabel">Up:</b> <a class="sectref" href="internet.html" tppabs="http://www.python.org/doc/current/lib/internet.html">11. Internet Protocols and</A>
<b class="navlabel">Next:</b> <a class="sectref" href="imap4-objects.html" tppabs="http://www.python.org/doc/current/lib/imap4-objects.html">11.8.1 IMAP4 Objects</A>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
<hr>See <i><a href="about.html" tppabs="http://www.python.org/doc/current/lib/about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -