| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.tlslite.integration.POP3_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>.POP3_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/POP3_TLS.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/tlslite/integration/POP3_TLS.py</a></font></td></tr></table> |
| <p><tt>TLS Lite + poplib.</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.POP3_TLS.html#POP3_TLS">POP3_TLS</a>(<a href="poplib.html#POP3">poplib.POP3</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="poplib.html#POP3">poplib.POP3</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.tlslite.integration.POP3_TLS.html#POP3_TLS">POP3_TLS</a>(<a href="poplib.html#POP3">poplib.POP3</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="POP3_TLS">class <strong>POP3_TLS</strong></a>(<a href="poplib.html#POP3">poplib.POP3</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{poplib.<a href="poplib.html#POP3">POP3</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.POP3_TLS.html#POP3_TLS">POP3_TLS</a></dd> |
| <dd><a href="poplib.html#POP3">poplib.POP3</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="POP3_TLS-__init__"><strong>__init__</strong></a>(self, host, port<font color="#909090">=995</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="#POP3_TLS">POP3_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> |
| |
| <hr> |
| Methods inherited from <a href="poplib.html#POP3">poplib.POP3</a>:<br> |
| <dl><dt><a name="POP3_TLS-apop"><strong>apop</strong></a>(self, user, secret)</dt><dd><tt>Authorisation<br> |
| <br> |
| - only possible if server has supplied a timestamp in initial greeting.<br> |
| <br> |
| Args:<br> |
| user - mailbox user;<br> |
| secret - secret shared between client and server.<br> |
| <br> |
| NB: mailbox is locked by server from here to '<a href="#POP3_TLS-quit">quit</a>()'</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-dele"><strong>dele</strong></a>(self, which)</dt><dd><tt>Delete message number 'which'.<br> |
| <br> |
| Result is 'response'.</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-getwelcome"><strong>getwelcome</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="POP3_TLS-list"><strong>list</strong></a>(self, which<font color="#909090">=None</font>)</dt><dd><tt>Request listing, return result.<br> |
| <br> |
| Result without a message number argument is in form<br> |
| ['response', ['mesg_num octets', ...], octets].<br> |
| <br> |
| Result when a message number argument is given is a<br> |
| single response: the "scan listing" for that message.</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-noop"><strong>noop</strong></a>(self)</dt><dd><tt>Does nothing.<br> |
| <br> |
| One supposes the response indicates the server is alive.</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-pass_"><strong>pass_</strong></a>(self, pswd)</dt><dd><tt>Send password, return response<br> |
| <br> |
| (response includes message count, mailbox size).<br> |
| <br> |
| NB: mailbox is locked by server from here to '<a href="#POP3_TLS-quit">quit</a>()'</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-quit"><strong>quit</strong></a>(self)</dt><dd><tt>Signoff: commit changes on server, unlock mailbox, close connection.</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-retr"><strong>retr</strong></a>(self, which)</dt><dd><tt>Retrieve whole message number 'which'.<br> |
| <br> |
| Result is in form ['response', ['line', ...], octets].</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-rpop"><strong>rpop</strong></a>(self, user)</dt><dd><tt>Not sure what this does.</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-rset"><strong>rset</strong></a>(self)</dt><dd><tt>Unmark all messages marked for deletion.</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-set_debuglevel"><strong>set_debuglevel</strong></a>(self, level)</dt></dl> |
| |
| <dl><dt><a name="POP3_TLS-stat"><strong>stat</strong></a>(self)</dt><dd><tt>Get mailbox status.<br> |
| <br> |
| Result is tuple of 2 ints (message count, mailbox size)</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-top"><strong>top</strong></a>(self, which, howmuch)</dt><dd><tt>Retrieve message header of message number 'which'<br> |
| and first 'howmuch' lines of message body.<br> |
| <br> |
| Result is in form ['response', ['line', ...], octets].</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-uidl"><strong>uidl</strong></a>(self, which<font color="#909090">=None</font>)</dt><dd><tt>Return message digest (unique id) list.<br> |
| <br> |
| If 'which', result contains unique id for that message<br> |
| in the form 'response mesgnum uid', otherwise result is<br> |
| the list ['response', ['mesgnum uid', ...], octets]</tt></dd></dl> |
| |
| <dl><dt><a name="POP3_TLS-user"><strong>user</strong></a>(self, user)</dt><dd><tt>Send user name, return response<br> |
| <br> |
| (should indicate password required).</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="poplib.html#POP3">poplib.POP3</a>:<br> |
| <dl><dt><strong>timestamp</strong> = <_sre.SRE_Pattern object></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>POP3_TLS_PORT</strong> = 995</td></tr></table> |
| </body></html> |
