Lines Matching refs:POP3
1 :mod:`poplib` --- POP3 protocol client
5 :synopsis: POP3 protocol client (requires sockets).
12 .. index:: pair: POP3; protocol
16 This module defines a class, :class:`POP3`, which encapsulates a connection to a
17 POP3 server and implements the protocol as defined in :rfc:`1939`. The
18 :class:`POP3` class supports both the minimal and optional command sets from
19 :rfc:`1939`. The :class:`POP3` class also supports the ``STLS`` command introduced
23 support for connecting to POP3 servers that use SSL as an underlying protocol
26 Note that POP3, though widely supported, is obsolescent. The implementation
27 quality of POP3 servers varies widely, and too many are quite poor. If your
34 .. class:: POP3(host, port=POP3_PORT[, timeout])
36 This class implements the actual POP3 protocol. The connection is created when
37 the instance is initialized. If *port* is omitted, the standard POP3 port (110)
42 .. audit-event:: poplib.connect self,host,port poplib.POP3
44 .. audit-event:: poplib.putline self,line poplib.POP3
53 This is a subclass of :class:`POP3` that connects to the server over an SSL
54 encrypted socket. If *port* is not specified, 995, the standard POP3-over-SSL
55 port is used. *timeout* works as in the :class:`POP3` constructor.
105 POP3 server variations and RFC noncompliance that may be useful if you need to
111 POP3 Objects
114 All POP3 commands are represented by methods of the same name, in lower-case;
117 An :class:`POP3` instance has the following methods:
120 .. method:: POP3.set_debuglevel(level)
129 .. method:: POP3.getwelcome()
131 Returns the greeting string sent by the POP3 server.
134 .. method:: POP3.capa()
142 .. method:: POP3.user(username)
147 .. method:: POP3.pass_(password)
153 .. method:: POP3.apop(user, secret)
155 Use the more secure APOP authentication to log into the POP3 server.
158 .. method:: POP3.rpop(user)
160 Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server.
163 .. method:: POP3.stat()
169 .. method:: POP3.list([which])
175 .. method:: POP3.retr(which)
181 .. method:: POP3.dele(which)
188 .. method:: POP3.rset()
193 .. method:: POP3.noop()
198 .. method:: POP3.quit()
203 .. method:: POP3.top(which, howmuch)
209 The POP3 TOP command this method uses, unlike the RETR command, doesn't set the
212 POP3 servers you will use before trusting it.
215 .. method:: POP3.uidl(which=None)
222 .. method:: POP3.utf8()
230 .. method:: POP3.stls(context=None)
253 POP3 Example
261 M = poplib.POP3('localhost')