Package twisted :: Package protocols :: Module smtp :: Class SMTPSender
[show private | hide private]
[frames | no frames]

Class SMTPSender

BaseProtocol --+            
               |            
        Protocol --+        
                   |        
        LineReceiver --+    
                       |    
              SMTPClient --+
                           |
                          SMTPSender


Utility class for sending emails easily - use with SMTPSenderFactory.
Method Summary
  __init__(self, identity, logsize)
(inherited from SMTPClient)
  clearLineBuffer(self)
Clear buffered data. (inherited from LineReceiver)
  connectionFailed(self)
(Deprecated) (inherited from Protocol)
  connectionLost(self, reason)
We are no longer connected (inherited from SMTPClient)
  connectionMade(self)
Called when a connection is made. (inherited from SMTPClient)
  dataReceived(self, data)
Protocol.dataReceived. (inherited from LineReceiver)
  finishedFileTransfer(self, lastsent)
(inherited from SMTPClient)
  getMailData(self)
Return file-like object containing data of message to be sent.
  getMailFrom(self)
Return the email address the mail is from.
  getMailTo(self)
Return a list of emails to send to.
  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 SMTPClient)
  rawDataReceived(self, data)
Override this for when raw data is received. (inherited from LineReceiver)
  sendLine(self, line)
Logging sendLine (inherited from SMTPClient)
  sentMail(self, code, resp, numOk, addresses, log)
Called when an attempt to send an email is completed.
  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)
  smtpConnectionFailed(self, code, resp)
(inherited from SMTPClient)
  smtpState_data(self, code, resp)
(inherited from SMTPClient)
  smtpState_disconnect(self, code, resp)
(inherited from SMTPClient)
  smtpState_from(self, code, resp)
(inherited from SMTPClient)
  smtpState_helo(self, code, resp)
(inherited from SMTPClient)
  smtpState_msgSent(self, code, resp)
(inherited from SMTPClient)
  smtpState_to(self, code, resp)
(inherited from SMTPClient)
  smtpState_toOrData(self, code, resp)
(inherited from SMTPClient)
  smtpTransferFailed(self, code, resp)
(inherited from SMTPClient)
  transformChunk(self, chunk)
(inherited from SMTPClient)

Class Variable Summary
int done

Method Details

getMailData(self)

Return file-like object containing data of message to be sent.

The file should be a text file with local line ending convention, i.e. readline() should return a line ending in '\n'.
Overrides:
twisted.protocols.smtp.SMTPClient.getMailData (inherited documentation)

getMailFrom(self)

Return the email address the mail is from.
Overrides:
twisted.protocols.smtp.SMTPClient.getMailFrom (inherited documentation)

getMailTo(self)

Return a list of emails to send to.
Overrides:
twisted.protocols.smtp.SMTPClient.getMailTo (inherited documentation)

sentMail(self, code, resp, numOk, addresses, log)

Called when an attempt to send an email is completed.

If some addresses were accepted, code and resp are the response to the DATA command. If no addresses were accepted, code is -1 and resp is an informative message.
Parameters:
addresses - is a list of tuples (address, code, resp) listing the response to each RCPT command.
log - is the SMTP session log
Overrides:
twisted.protocols.smtp.SMTPClient.sentMail (inherited documentation)

Class Variable Details

done

Type:
int
Value:
0                                                                      

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