| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.tlslite.integration.IMAP4_TLS</title> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.tlslite.html"><font color="#ffffff">tlslite</font></a>.<a href="gdata.tlslite.integration.html"><font color="#ffffff">integration</font></a>.IMAP4_TLS</strong></big></big></font></td |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/tlslite/integration/IMAP4_TLS.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/tlslite/integration/IMAP4_TLS.py</a></font></td></tr></table> |
| <p><tt>TLS Lite + imaplib.</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="socket.html">socket</a><br> |
| </td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ee77aa"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| <td width="100%"><dl> |
| <dt><font face="helvetica, arial"><a href="gdata.tlslite.integration.ClientHelper.html#ClientHelper">gdata.tlslite.integration.ClientHelper.ClientHelper</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.tlslite.integration.IMAP4_TLS.html#IMAP4_TLS">IMAP4_TLS</a>(<a href="imaplib.html#IMAP4">imaplib.IMAP4</a>, <a href="gdata.tlslite.integration.ClientHelper.html#ClientHelper">gdata.tlslite.integration.ClientHelper.ClientHelper</a>) |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="imaplib.html#IMAP4">imaplib.IMAP4</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.tlslite.integration.IMAP4_TLS.html#IMAP4_TLS">IMAP4_TLS</a>(<a href="imaplib.html#IMAP4">imaplib.IMAP4</a>, <a href="gdata.tlslite.integration.ClientHelper.html#ClientHelper">gdata.tlslite.integration.ClientHelper.ClientHelper</a>) |
| </font></dt></dl> |
| </dd> |
| </dl> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="IMAP4_TLS">class <strong>IMAP4_TLS</strong></a>(<a href="imaplib.html#IMAP4">imaplib.IMAP4</a>, <a href="gdata.tlslite.integration.ClientHelper.html#ClientHelper">gdata.tlslite.integration.ClientHelper.ClientHelper</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>This class extends L{imaplib.<a href="imaplib.html#IMAP4">IMAP4</a>} with TLS support.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.tlslite.integration.IMAP4_TLS.html#IMAP4_TLS">IMAP4_TLS</a></dd> |
| <dd><a href="imaplib.html#IMAP4">imaplib.IMAP4</a></dd> |
| <dd><a href="gdata.tlslite.integration.ClientHelper.html#ClientHelper">gdata.tlslite.integration.ClientHelper.ClientHelper</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="IMAP4_TLS-__init__"><strong>__init__</strong></a>(self, host<font color="#909090">=''</font>, port<font color="#909090">=993</font>, username<font color="#909090">=None</font>, password<font color="#909090">=None</font>, sharedKey<font color="#909090">=None</font>, certChain<font color="#909090">=None</font>, privateKey<font color="#909090">=None</font>, cryptoID<font color="#909090">=None</font>, protocol<font color="#909090">=None</font>, x509Fingerprint<font color="#909090">=None</font>, x509TrustList<font color="#909090">=None</font>, x509CommonName<font color="#909090">=None</font>, settings<font color="#909090">=None</font>)</dt><dd><tt>Create a new <a href="#IMAP4_TLS">IMAP4_TLS</a>.<br> |
| <br> |
| For client authentication, use one of these argument<br> |
| combinations:<br> |
| - username, password (SRP)<br> |
| - username, sharedKey (shared-key)<br> |
| - certChain, privateKey (certificate)<br> |
| <br> |
| For server authentication, you can either rely on the<br> |
| implicit mutual authentication performed by SRP or<br> |
| shared-keys, or you can do certificate-based server<br> |
| authentication with one of these argument combinations:<br> |
| - cryptoID[, protocol] (requires cryptoIDlib)<br> |
| - x509Fingerprint<br> |
| - x509TrustList[, x509CommonName] (requires cryptlib_py)<br> |
| <br> |
| Certificate-based server authentication is compatible with<br> |
| SRP or certificate-based client authentication. It is<br> |
| not compatible with shared-keys.<br> |
| <br> |
| The caller should be prepared to handle TLS-specific<br> |
| exceptions. See the client handshake functions in<br> |
| L{tlslite.TLSConnection.TLSConnection} for details on which<br> |
| exceptions might be raised.<br> |
| <br> |
| @type host: str<br> |
| @param host: Server to connect to.<br> |
| <br> |
| @type port: int<br> |
| @param port: Port to connect to.<br> |
| <br> |
| @type username: str<br> |
| @param username: SRP or shared-key username. Requires the<br> |
| 'password' or 'sharedKey' argument.<br> |
| <br> |
| @type password: str<br> |
| @param password: SRP password for mutual authentication.<br> |
| Requires the 'username' argument.<br> |
| <br> |
| @type sharedKey: str<br> |
| @param sharedKey: Shared key for mutual authentication.<br> |
| Requires the 'username' argument.<br> |
| <br> |
| @type certChain: L{tlslite.X509CertChain.X509CertChain} or<br> |
| L{cryptoIDlib.CertChain.CertChain}<br> |
| @param certChain: Certificate chain for client authentication.<br> |
| Requires the 'privateKey' argument. Excludes the SRP or<br> |
| shared-key related arguments.<br> |
| <br> |
| @type privateKey: L{tlslite.utils.RSAKey.RSAKey}<br> |
| @param privateKey: Private key for client authentication.<br> |
| Requires the 'certChain' argument. Excludes the SRP or<br> |
| shared-key related arguments.<br> |
| <br> |
| @type cryptoID: str<br> |
| @param cryptoID: cryptoID for server authentication. Mutually<br> |
| exclusive with the 'x509...' arguments.<br> |
| <br> |
| @type protocol: str<br> |
| @param protocol: cryptoID protocol URI for server<br> |
| authentication. Requires the 'cryptoID' argument.<br> |
| <br> |
| @type x509Fingerprint: str<br> |
| @param x509Fingerprint: Hex-encoded X.509 fingerprint for<br> |
| server authentication. Mutually exclusive with the 'cryptoID'<br> |
| and 'x509TrustList' arguments.<br> |
| <br> |
| @type x509TrustList: list of L{tlslite.X509.X509}<br> |
| @param x509TrustList: A list of trusted root certificates. The<br> |
| other party must present a certificate chain which extends to<br> |
| one of these root certificates. The cryptlib_py module must be<br> |
| installed to use this parameter. Mutually exclusive with the<br> |
| 'cryptoID' and 'x509Fingerprint' arguments.<br> |
| <br> |
| @type x509CommonName: str<br> |
| @param x509CommonName: The end-entity certificate's 'CN' field<br> |
| must match this value. For a web server, this is typically a<br> |
| server name such as 'www.amazon.com'. Mutually exclusive with<br> |
| the 'cryptoID' and 'x509Fingerprint' arguments. Requires the<br> |
| 'x509TrustList' argument.<br> |
| <br> |
| @type settings: L{tlslite.HandshakeSettings.HandshakeSettings}<br> |
| @param settings: Various settings which can be used to control<br> |
| the ciphersuites, certificate types, and SSL/TLS versions<br> |
| offered by the client.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-open"><strong>open</strong></a>(self, host<font color="#909090">=''</font>, port<font color="#909090">=993</font>)</dt><dd><tt>Setup connection to remote server on "host:port".<br> |
| <br> |
| This connection will be used by the routines:<br> |
| read, readline, send, shutdown.</tt></dd></dl> |
| |
| <hr> |
| Methods inherited from <a href="imaplib.html#IMAP4">imaplib.IMAP4</a>:<br> |
| <dl><dt><a name="IMAP4_TLS-__getattr__"><strong>__getattr__</strong></a>(self, attr)</dt></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-append"><strong>append</strong></a>(self, mailbox, flags, date_time, message)</dt><dd><tt>Append message to named mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-append">append</a>(mailbox, flags, date_time, message)<br> |
| <br> |
| All args except `message' can be None.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-authenticate"><strong>authenticate</strong></a>(self, mechanism, authobject)</dt><dd><tt>Authenticate command - requires response processing.<br> |
| <br> |
| 'mechanism' specifies which authentication mechanism is to<br> |
| be used - it must appear in <instance>.capabilities in the<br> |
| form AUTH=<mechanism>.<br> |
| <br> |
| 'authobject' must be a callable object:<br> |
| <br> |
| data = authobject(response)<br> |
| <br> |
| It will be called to process server continuation responses.<br> |
| It should return data that will be encoded and sent to server.<br> |
| It should return None if the client abort response '*' should<br> |
| be sent instead.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-capability"><strong>capability</strong></a>(self)</dt><dd><tt>(typ, [data]) = <instance>.<a href="#IMAP4_TLS-capability">capability</a>()<br> |
| Fetch capabilities list from server.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-check"><strong>check</strong></a>(self)</dt><dd><tt>Checkpoint mailbox on server.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-check">check</a>()</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-close"><strong>close</strong></a>(self)</dt><dd><tt>Close currently selected mailbox.<br> |
| <br> |
| Deleted messages are removed from writable mailbox.<br> |
| This is the recommended command before 'LOGOUT'.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-close">close</a>()</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-copy"><strong>copy</strong></a>(self, message_set, new_mailbox)</dt><dd><tt>Copy 'message_set' messages onto end of 'new_mailbox'.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-copy">copy</a>(message_set, new_mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-create"><strong>create</strong></a>(self, mailbox)</dt><dd><tt>Create new mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-create">create</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-delete"><strong>delete</strong></a>(self, mailbox)</dt><dd><tt>Delete old mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-delete">delete</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-deleteacl"><strong>deleteacl</strong></a>(self, mailbox, who)</dt><dd><tt>Delete the ACLs (remove any rights) set for who on mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-deleteacl">deleteacl</a>(mailbox, who)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-expunge"><strong>expunge</strong></a>(self)</dt><dd><tt>Permanently remove deleted items from selected mailbox.<br> |
| <br> |
| Generates 'EXPUNGE' response for each deleted message.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-expunge">expunge</a>()<br> |
| <br> |
| 'data' is list of 'EXPUNGE'd message numbers in order received.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-fetch"><strong>fetch</strong></a>(self, message_set, message_parts)</dt><dd><tt>Fetch (parts of) messages.<br> |
| <br> |
| (typ, [data, ...]) = <instance>.<a href="#IMAP4_TLS-fetch">fetch</a>(message_set, message_parts)<br> |
| <br> |
| 'message_parts' should be a string of selected parts<br> |
| enclosed in parentheses, eg: "(UID BODY[TEXT])".<br> |
| <br> |
| 'data' are tuples of message part envelope and data.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-getacl"><strong>getacl</strong></a>(self, mailbox)</dt><dd><tt>Get the ACLs for a mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-getacl">getacl</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-getannotation"><strong>getannotation</strong></a>(self, mailbox, entry, attribute)</dt><dd><tt>(typ, [data]) = <instance>.<a href="#IMAP4_TLS-getannotation">getannotation</a>(mailbox, entry, attribute)<br> |
| Retrieve ANNOTATIONs.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-getquota"><strong>getquota</strong></a>(self, root)</dt><dd><tt>Get the quota root's resource usage and limits.<br> |
| <br> |
| Part of the <a href="imaplib.html#IMAP4">IMAP4</a> QUOTA extension defined in rfc2087.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-getquota">getquota</a>(root)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-getquotaroot"><strong>getquotaroot</strong></a>(self, mailbox)</dt><dd><tt>Get the list of quota roots for the named mailbox.<br> |
| <br> |
| (typ, [[QUOTAROOT responses...], [QUOTA responses]]) = <instance>.<a href="#IMAP4_TLS-getquotaroot">getquotaroot</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-list"><strong>list</strong></a>(self, directory<font color="#909090">='""'</font>, pattern<font color="#909090">='*'</font>)</dt><dd><tt>List mailbox names in directory matching pattern.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-list">list</a>(directory='""', pattern='*')<br> |
| <br> |
| 'data' is list of LIST responses.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-login"><strong>login</strong></a>(self, user, password)</dt><dd><tt>Identify client using plaintext password.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-login">login</a>(user, password)<br> |
| <br> |
| NB: 'password' will be quoted.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-login_cram_md5"><strong>login_cram_md5</strong></a>(self, user, password)</dt><dd><tt>Force use of CRAM-MD5 authentication.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-login_cram_md5">login_cram_md5</a>(user, password)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-logout"><strong>logout</strong></a>(self)</dt><dd><tt>Shutdown connection to server.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-logout">logout</a>()<br> |
| <br> |
| Returns server 'BYE' response.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-lsub"><strong>lsub</strong></a>(self, directory<font color="#909090">='""'</font>, pattern<font color="#909090">='*'</font>)</dt><dd><tt>List 'subscribed' mailbox names in directory matching pattern.<br> |
| <br> |
| (typ, [data, ...]) = <instance>.<a href="#IMAP4_TLS-lsub">lsub</a>(directory='""', pattern='*')<br> |
| <br> |
| 'data' are tuples of message part envelope and data.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-myrights"><strong>myrights</strong></a>(self, mailbox)</dt><dd><tt>Show my ACLs for a mailbox (i.e. the rights that I have on mailbox).<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-myrights">myrights</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-namespace"><strong>namespace</strong></a>(self)</dt><dd><tt>Returns IMAP namespaces ala rfc2342<br> |
| <br> |
| (typ, [data, ...]) = <instance>.<a href="#IMAP4_TLS-namespace">namespace</a>()</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-noop"><strong>noop</strong></a>(self)</dt><dd><tt>Send NOOP command.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-noop">noop</a>()</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-partial"><strong>partial</strong></a>(self, message_num, message_part, start, length)</dt><dd><tt>Fetch truncated part of a message.<br> |
| <br> |
| (typ, [data, ...]) = <instance>.<a href="#IMAP4_TLS-partial">partial</a>(message_num, message_part, start, length)<br> |
| <br> |
| 'data' is tuple of message part envelope and data.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-print_log"><strong>print_log</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-proxyauth"><strong>proxyauth</strong></a>(self, user)</dt><dd><tt>Assume authentication as "user".<br> |
| <br> |
| Allows an authorised administrator to proxy into any user's<br> |
| mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-proxyauth">proxyauth</a>(user)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-read"><strong>read</strong></a>(self, size)</dt><dd><tt>Read 'size' bytes from remote.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-readline"><strong>readline</strong></a>(self)</dt><dd><tt>Read line from remote.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-recent"><strong>recent</strong></a>(self)</dt><dd><tt>Return most recent 'RECENT' responses if any exist,<br> |
| else prompt server for an update using the 'NOOP' command.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-recent">recent</a>()<br> |
| <br> |
| 'data' is None if no new messages,<br> |
| else list of RECENT responses, most recent last.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-rename"><strong>rename</strong></a>(self, oldmailbox, newmailbox)</dt><dd><tt>Rename old mailbox name to new.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-rename">rename</a>(oldmailbox, newmailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-response"><strong>response</strong></a>(self, code)</dt><dd><tt>Return data for response 'code' if received, or None.<br> |
| <br> |
| Old value for response 'code' is cleared.<br> |
| <br> |
| (code, [data]) = <instance>.<a href="#IMAP4_TLS-response">response</a>(code)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-search"><strong>search</strong></a>(self, charset, *criteria)</dt><dd><tt>Search mailbox for matching messages.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-search">search</a>(charset, criterion, ...)<br> |
| <br> |
| 'data' is space separated list of matching message numbers.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-select"><strong>select</strong></a>(self, mailbox<font color="#909090">='INBOX'</font>, readonly<font color="#909090">=False</font>)</dt><dd><tt>Select a mailbox.<br> |
| <br> |
| Flush all untagged responses.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-select">select</a>(mailbox='INBOX', readonly=False)<br> |
| <br> |
| 'data' is count of messages in mailbox ('EXISTS' response).<br> |
| <br> |
| Mandated responses are ('FLAGS', 'EXISTS', 'RECENT', 'UIDVALIDITY'), so<br> |
| other responses should be obtained via <instance>.<a href="#IMAP4_TLS-response">response</a>('FLAGS') etc.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-send"><strong>send</strong></a>(self, data)</dt><dd><tt>Send data to remote.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-setacl"><strong>setacl</strong></a>(self, mailbox, who, what)</dt><dd><tt>Set a mailbox acl.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-setacl">setacl</a>(mailbox, who, what)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-setannotation"><strong>setannotation</strong></a>(self, *args)</dt><dd><tt>(typ, [data]) = <instance>.<a href="#IMAP4_TLS-setannotation">setannotation</a>(mailbox[, entry, attribute]+)<br> |
| Set ANNOTATIONs.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-setquota"><strong>setquota</strong></a>(self, root, limits)</dt><dd><tt>Set the quota root's resource limits.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-setquota">setquota</a>(root, limits)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-shutdown"><strong>shutdown</strong></a>(self)</dt><dd><tt>Close I/O established in "open".</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-socket"><strong>socket</strong></a>(self)</dt><dd><tt>Return socket instance used to connect to <a href="imaplib.html#IMAP4">IMAP4</a> server.<br> |
| <br> |
| socket = <instance>.<a href="#IMAP4_TLS-socket">socket</a>()</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-sort"><strong>sort</strong></a>(self, sort_criteria, charset, *search_criteria)</dt><dd><tt>IMAP4rev1 extension SORT command.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-sort">sort</a>(sort_criteria, charset, search_criteria, ...)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-status"><strong>status</strong></a>(self, mailbox, names)</dt><dd><tt>Request named status conditions for mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-status">status</a>(mailbox, names)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-store"><strong>store</strong></a>(self, message_set, command, flags)</dt><dd><tt>Alters flag dispositions for messages in mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-store">store</a>(message_set, command, flags)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-subscribe"><strong>subscribe</strong></a>(self, mailbox)</dt><dd><tt>Subscribe to new mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-subscribe">subscribe</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-thread"><strong>thread</strong></a>(self, threading_algorithm, charset, *search_criteria)</dt><dd><tt>IMAPrev1 extension THREAD command.<br> |
| <br> |
| (type, [data]) = <instance>.<a href="#IMAP4_TLS-thread">thread</a>(threading_algorithm, charset, search_criteria, ...)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-uid"><strong>uid</strong></a>(self, command, *args)</dt><dd><tt>Execute "command arg ..." with messages identified by UID,<br> |
| rather than message number.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-uid">uid</a>(command, arg1, arg2, ...)<br> |
| <br> |
| Returns response appropriate to 'command'.</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-unsubscribe"><strong>unsubscribe</strong></a>(self, mailbox)</dt><dd><tt>Unsubscribe from old mailbox.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-unsubscribe">unsubscribe</a>(mailbox)</tt></dd></dl> |
| |
| <dl><dt><a name="IMAP4_TLS-xatom"><strong>xatom</strong></a>(self, name, *args)</dt><dd><tt>Allow simple extension commands<br> |
| notified by server in CAPABILITY response.<br> |
| <br> |
| Assumes command is legal in current state.<br> |
| <br> |
| (typ, [data]) = <instance>.<a href="#IMAP4_TLS-xatom">xatom</a>(name, arg, ...)<br> |
| <br> |
| Returns response appropriate to extension command `name'.</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="imaplib.html#IMAP4">imaplib.IMAP4</a>:<br> |
| <dl><dt><strong>abort</strong> = <class 'imaplib.abort'></dl> |
| |
| <dl><dt><strong>error</strong> = <class 'imaplib.error'></dl> |
| |
| <dl><dt><strong>mustquote</strong> = <_sre.SRE_Pattern object></dl> |
| |
| <dl><dt><strong>readonly</strong> = <class 'imaplib.readonly'></dl> |
| |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#55aa55"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| <td width="100%"><strong>IMAP4_TLS_PORT</strong> = 993</td></tr></table> |
| </body></html> |
