Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 1 | %By Andrew T. Csillag |
| 2 | %Even though I put it into LaTeX, I cannot really claim that I wrote |
| 3 | %it since I just stole most of it from the poplib.py source code and |
| 4 | %the imaplib ``chapter''. |
| 5 | |
Fred Drake | 295da24 | 1998-08-10 19:42:37 +0000 | [diff] [blame] | 6 | \section{\module{poplib} --- |
Fred Drake | e2effbd | 1999-04-22 16:21:09 +0000 | [diff] [blame^] | 7 | POP3 protocol client} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 8 | |
Fred Drake | e2effbd | 1999-04-22 16:21:09 +0000 | [diff] [blame^] | 9 | \declaremodule{standard}{poplib} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 10 | \modulesynopsis{POP3 protocol client (requires sockets).} |
| 11 | |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 12 | \indexii{POP3}{protocol} |
| 13 | |
| 14 | This module defines a class, \class{POP3}, which encapsulates a |
| 15 | connection to an POP3 server and implements protocol as defined in |
| 16 | \rfc{1725}. The \class{POP3} class supports both the minmal and |
| 17 | optional command sets. |
| 18 | |
| 19 | A single class is provided by the \module{poplib} module: |
| 20 | |
| 21 | \begin{classdesc}{POP3}{host\optional{, port}} |
| 22 | This class implements the actual POP3 protocol. The connection is |
| 23 | created when the instance is initialized. |
| 24 | If \var{port} is omitted, the standard POP3 port (110) is used. |
| 25 | \end{classdesc} |
| 26 | |
Fred Drake | e2effbd | 1999-04-22 16:21:09 +0000 | [diff] [blame^] | 27 | One exception is defined as an attribute of the \module{poplib} module: |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 28 | |
| 29 | \begin{excdesc}{error_proto} |
| 30 | Exception raised on any errors. The reason for the exception is |
| 31 | passed to the constructor as a string. |
| 32 | \end{excdesc} |
| 33 | |
| 34 | |
Fred Drake | e2effbd | 1999-04-22 16:21:09 +0000 | [diff] [blame^] | 35 | \subsection{POP3 Objects \label{pop3-objects}} |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 36 | |
| 37 | All POP3 commands are represented by methods of the same name, |
Fred Drake | e2effbd | 1999-04-22 16:21:09 +0000 | [diff] [blame^] | 38 | in lower-case; most return the response text sent by the server. |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 39 | |
| 40 | An \class{POP3} instance has the following methods: |
| 41 | |
| 42 | |
| 43 | \begin{methoddesc}{getwelcome}{} |
| 44 | Returns the greeting string sent by the POP3 server. |
| 45 | \end{methoddesc} |
| 46 | |
| 47 | |
| 48 | \begin{methoddesc}{user}{username} |
| 49 | Send user commad, response should indicate that a password is required. |
| 50 | \end{methoddesc} |
| 51 | |
| 52 | \begin{methoddesc}{pass_}{password} |
| 53 | Send password, response includes message count and mailbox size. |
| 54 | Note: the mailbox on the server is locked until \method{quit()} is |
| 55 | called. |
| 56 | \end{methoddesc} |
| 57 | |
| 58 | \begin{methoddesc}{apop}{user, secret} |
| 59 | Use the more secure APOP authentication to log into the POP3 server. |
| 60 | \end{methoddesc} |
| 61 | |
| 62 | \begin{methoddesc}{rpop}{user} |
| 63 | Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server. |
| 64 | \end{methoddesc} |
| 65 | |
| 66 | \begin{methoddesc}{stat}{} |
| 67 | Get mailbox status. The result is a tuple of 2 integers: |
| 68 | \code{(\var{message count}, \var{mailbox size})}. |
| 69 | \end{methoddesc} |
| 70 | |
| 71 | \begin{methoddesc}{list}{\optional{which}} |
| 72 | Request message list, result is in the form |
| 73 | \code{['response', ['mesg_num octets', ...]]}. If \var{which} is |
| 74 | set, it is the message to list. |
| 75 | \end{methoddesc} |
| 76 | |
| 77 | \begin{methoddesc}{retr}{which} |
| 78 | Retrieve whole message number \var{which}. Result is in form |
| 79 | \code{['response', ['line', ...], octets]}. |
| 80 | \end{methoddesc} |
| 81 | |
| 82 | \begin{methoddesc}{dele}{which} |
| 83 | Delete message number \var{which}. |
| 84 | \end{methoddesc} |
| 85 | |
| 86 | \begin{methoddesc}{rset}{} |
| 87 | Remove any deletion marks for the mailbox. |
| 88 | \end{methoddesc} |
| 89 | |
| 90 | \begin{methoddesc}{noop}{} |
| 91 | Do nothing. Might be used as a keep-alive. |
| 92 | \end{methoddesc} |
| 93 | |
| 94 | \begin{methoddesc}{quit}{} |
| 95 | Signoff: commit changes, unlock mailbox, drop connection. |
| 96 | \end{methoddesc} |
| 97 | |
| 98 | \begin{methoddesc}{top}{which, howmuch} |
| 99 | Retrieves the message header plus \var{howmuch} lines of the message |
| 100 | after the header of message number \var{which}. Result is in form |
| 101 | \code{['response', ['line', ...], octets]}. |
| 102 | \end{methoddesc} |
| 103 | |
| 104 | \begin{methoddesc}{uidl}{\optional{which}} |
| 105 | Return message digest (unique id) list. |
| 106 | If \var{which} is specified, result contains unique id for that |
| 107 | message, otherwise result is list \code{['response', |
| 108 | ['mesgnum uid', ...], octets]}. |
| 109 | \end{methoddesc} |
| 110 | |
| 111 | |
Fred Drake | e2effbd | 1999-04-22 16:21:09 +0000 | [diff] [blame^] | 112 | \subsection{POP3 Example \label{pop3-example}} |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 113 | |
| 114 | Here is a minimal example (without error checking) that opens a |
| 115 | mailbox and retrieves and prints all messages: |
| 116 | |
| 117 | \begin{verbatim} |
Guido van Rossum | aac399b | 1998-12-08 16:30:10 +0000 | [diff] [blame] | 118 | import getpass, poplib |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 119 | |
| 120 | M = poplib.POP3('localhost') |
| 121 | M.user(getpass.getuser()) |
Guido van Rossum | aac399b | 1998-12-08 16:30:10 +0000 | [diff] [blame] | 122 | M.pass_(getpass.getpass()) |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 123 | numMessages = len(M.list()[1]) |
| 124 | for i in range(numMessages): |
| 125 | for j in M.retr(i+1)[1]: |
Guido van Rossum | aac399b | 1998-12-08 16:30:10 +0000 | [diff] [blame] | 126 | print j |
Fred Drake | a468404 | 1998-04-24 20:49:02 +0000 | [diff] [blame] | 127 | \end{verbatim} |
| 128 | |
| 129 | At the end of the module, there is a test section that contains a more |
| 130 | extensive example of usage. |