Home       Trees       Index       Help   
Package twisted :: Package protocols :: Module pop3 :: Class POP3
[show private | hide private]
[frames | no frames]

Class POP3

BaseProtocol --+        
               |        
        Protocol --+    
                   |    
        LineReceiver --+
                       |
                      POP3

Known Subclasses:
VirtualPOP3
Method Summary
Deferred authenticateUserAPOP(self, user, digest)
Perform authentication of an APOP login.
Deferred authenticateUserPASS(self, user, password)
Perform authentication of a username/password login.
  clearLineBuffer(self)
Clear buffered data. (inherited from LineReceiver)
  connectionFailed(self)
(Deprecated) (inherited from Protocol)
  connectionLost(self, reason)
Called when the connection is shut down. (inherited from Protocol)
  connectionMade(self)
Called when a connection is made.
  dataReceived(self, data)
Protocol.dataReceived. (inherited from LineReceiver)
  do_APOP(self, user, digest)
  do_DELE(self, i)
  do_LAST(self)
Respond with the highest message access thus far
  do_LIST(self, i)
  do_NOOP(self)
Perform no operation.
  do_PASS(self, password)
  do_QUIT(self)
  do_RETR(self, i)
  do_RPOP(self, user)
  do_RSET(self)
Unset all deleted message flags
  do_STAT(self)
  do_TOP(self, i, size)
  do_UIDL(self, i)
  do_USER(self, user)
  failResponse(self, message)
  finishedFileTransfer(self, lastsent)
  getMessageFile(self, i)
  lineLengthExceeded(self, line)
Called when the maximum line length has been reached. (inherited from LineReceiver)
  lineReceived(self, line)
Override this for when each line is received.
  makeConnection(self, transport)
Make a connection to a transport and a server. (inherited from BaseProtocol)
  processCommand(self, command, *args)
  rawDataReceived(self, data)
Override this for when raw data is received. (inherited from LineReceiver)
  sendLine(self, line)
Sends a line to the other end of the connection. (inherited from LineReceiver)
  setLineMode(self, extra)
Sets the line-mode of this receiver. (inherited from LineReceiver)
  setRawMode(self)
Sets the raw mode of this receiver. (inherited from LineReceiver)
  successResponse(self, message)
  transformChunk(self, chunk)
  _cbMailbox(self, ial, user)
  _ebMailbox(self, failure)
  _ebUnexpected(self, failure)

Class Variable Summary
tuple __implements__
int highest
NoneType magic
NoneType portal
NoneType _userIs

Method Details

authenticateUserAPOP(self, user, digest)

Perform authentication of an APOP login.
Parameters:
user - The name of the user attempting to log in.
           (type=str)
digest - The response string with which the user replied.
           (type=str)
Returns:
A deferred whose callback is invoked if the login is successful, and whose errback will be invoked otherwise. The callback will be passed a 3-tuple consisting of IMailbox, an object implementing IMailbox, and a zero-argument callable to be invoked when this session is terminated.
           (type=Deferred)

authenticateUserPASS(self, user, password)

Perform authentication of a username/password login.
Parameters:
user - The name of the user attempting to log in.
           (type=str)
password - The password to attempt to authenticate with.
           (type=str)
Returns:
A deferred whose callback is invoked if the login is successful, and whose errback will be invoked otherwise. The callback will be passed a 3-tuple consisting of IMailbox, an object implementing IMailbox, and a zero-argument callable to be invoked when this session is terminated.
           (type=Deferred)

connectionMade(self)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Overrides:
twisted.internet.protocol.BaseProtocol.connectionMade (inherited documentation)

do_LAST(self)

Respond with the highest message access thus far

do_NOOP(self)

Perform no operation. Return a success code

do_RSET(self)

Unset all deleted message flags

lineReceived(self, line)

Override this for when each line is received.
Overrides:
twisted.protocols.basic.LineReceiver.lineReceived (inherited documentation)

Class Variable Details

__implements__

Type:
tuple
Value:
(<class twisted.internet.interfaces.IProducer at 0x823bfdc>,)

highest

Type:
int
Value:
0

magic

Type:
NoneType
Value:
None

portal

Type:
NoneType
Value:
None

_userIs

Type:
NoneType
Value:
None

   Home       Trees       Index       Help   
Generated by Epydoc 1.1 on Fri Jun 27 03:48:37 2003 http://epydoc.sf.net