Package twisted :: Package protocols :: Module smtp :: Class SMTPClient

[show private | hide private]
[frames | no frames]

## Class SMTPClient

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

Known Subclasses:
  `SMTPRelayer`, `SMTPSender`

SMTP client for sending emails.

Method Summary
| `__init__(self, identity)`
| ``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`)
| ``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.
| `pauseProducing(self)`
| ``rawDataReceived`(self, data)` Override this for when raw data is received. (inherited from `LineReceiver`)
| ``resumeProducing`(self)` Write another
| ``sendLine`(self, line)` Sends a line to the other end of the connection. (inherited from `LineReceiver`)
| `sendToOrData(self)`
| ``sentMail`(self, addresses)` Called with list of emails to which we sent the message.
| ``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`)
| `smtpCode_220_helo(self, line)`
| `smtpCode_221_quit(self, line)`
| `smtpCode_250_afterData(self, line)`
| `smtpCode_250_afterFrom(self, line)`
| `smtpCode_250_from(self, line)`
| `smtpCode_250_to(self, line)`
| `smtpCode_354_data(self, line)`
| `smtpCode_550_to(self, line)`
| `smtpCode_default(self, line)`
| `stopProducing(self)`

Method Details

### 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)

### 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'.

### getMailFrom(self)

Return the email address the mail is from.

### getMailTo(self)

Return a list of emails to send to.

### lineReceived(self, line)

Override this for when each line is received.

  Overrides:
    `twisted.protocols.basic.LineReceiver.lineReceived` (inherited documentation)

### resumeProducing(self)

Write another

### sentMail(self, addresses)

Called with list of emails to which we sent the message.

Generated by Epydoc 1.1 on Sat Feb 15 21:18:02 2003 | http://epydoc.sf.net