Package twisted :: Package mail :: Module protocols :: Class VirtualPOP3
[show private | hide private]
[frames | no frames]

Class VirtualPOP3

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


Virtual hosting POP3.
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. (inherited from POP3)
  dataReceived(self, data)
Protocol.dataReceived. (inherited from LineReceiver)
  do_APOP(self, user, digest)
(inherited from POP3)
  do_DELE(self, i)
(inherited from POP3)
  do_LAST(self)
Respond with the highest message access thus far (inherited from POP3)
  do_LIST(self, i)
(inherited from POP3)
  do_NOOP(self)
Perform no operation. (inherited from POP3)
  do_PASS(self, password)
(inherited from POP3)
  do_QUIT(self)
(inherited from POP3)
  do_RETR(self, i)
(inherited from POP3)
  do_RPOP(self, user)
(inherited from POP3)
  do_RSET(self)
Unset all deleted message flags (inherited from POP3)
  do_STAT(self)
(inherited from POP3)
  do_TOP(self, i, size)
(inherited from POP3)
  do_UIDL(self, i)
(inherited from POP3)
  do_USER(self, user)
(inherited from POP3)
  failResponse(self, message)
(inherited from POP3)
  finishedFileTransfer(self, lastsent)
(inherited from POP3)
  getMessageFile(self, i)
(inherited from POP3)
  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. (inherited from POP3)
  lookupDomain(self, user)
  makeConnection(self, transport)
Make a connection to a transport and a server. (inherited from BaseProtocol)
  processCommand(self, command, *args)
(inherited from POP3)
  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)
(inherited from POP3)
  transformChunk(self, chunk)
(inherited from POP3)
  _cbMailbox(self, ial, user)
(inherited from POP3)
  _ebMailbox(self, failure)
(inherited from POP3)
  _ebUnexpected(self, failure)
(inherited from POP3)

Class Variable Summary
str domainSpecifier
NoneType service

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)
Overrides:
twisted.protocols.pop3.POP3.authenticateUserAPOP (inherited documentation)

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)
Overrides:
twisted.protocols.pop3.POP3.authenticateUserPASS (inherited documentation)

Class Variable Details

domainSpecifier

Type:
str
Value:
'@'                                                                    

service

Type:
NoneType
Value:
None                                                                   

Generated by Epydoc 1.1 on Fri Jun 27 03:48:19 2003 http://epydoc.sf.net