t.m.smtp : module documentation

Part of twisted.mail View Source

Simple Mail Transfer Protocol implementation.
Interface IMessageDelivery No interface docstring; 3/3 methods documented
Interface IMessageDeliveryFactory An alternate interface to implement for handling message delivery.
Class SMTPError Undocumented
Class SMTPClientError Base class for SMTP client errors.
Class ESMTPClientError Base class for ESMTP client errors.
Class EHLORequiredError The server does not support EHLO.
Class AUTHRequiredError Authentication was required but the server does not support it.
Class TLSRequiredError Transport security was required but the server does not support it.
Class AUTHDeclinedError The server rejected our credentials.
Class AuthenticationError An error ocurred while authenticating.
Class TLSError An error occurred while negiotiating for transport security.
Class SMTPConnectError Failed to connect to the mail exchange host.
Class SMTPTimeoutError Failed to receive a response from the server in the expected time period.
Class SMTPProtocolError The server sent a mangled response.
Class SMTPDeliveryError Indicates that a delivery attempt has had an error.
Class SMTPServerError Undocumented
Class SMTPAddressError Undocumented
Class SMTPBadRcpt Undocumented
Class SMTPBadSender Undocumented
Function rfc822date Format an RFC-2822 compliant date string.
Function idGenerator Undocumented
Function messageid Return a globally unique random string in RFC 2822 Message-ID format
Function quoteaddr Turn an email address, possibly with realname part etc, into a form suitable for and SMTP envelope.
Class AddressError Parse error in address
Class Address Parse and hold an RFC 2821 address.
Class User Hold information about and SMTP message recipient, including information on where the message came from
Interface IMessage Interface definition for messages that can be sent via SMTP.
Class SMTP SMTP server-side protocol.
Class SMTPFactory Factory for SMTP.
Class SMTPClient SMTP client for sending emails.
Class ESMTPClient No class docstring; 1/18 methods documented
Class ESMTP No class docstring; 3/12 methods documented
Class SenderMixin Utility class for sending emails easily.
Class SMTPSender SMTP protocol that sends a single email based on information it gets from its factory, a SMTPSenderFactory.
Class SMTPSenderFactory Utility factory for sending emails easily.
Interface IClientAuthentication No interface docstring; 2/2 methods documented
Class CramMD5ClientAuthenticator Undocumented
Class LOGINAuthenticator Undocumented
Class PLAINAuthenticator Undocumented
Class ESMTPSender Undocumented
Class ESMTPSenderFactory Utility factory for sending emails easily.
Function sendmail Send an email
Function sendEmail Send an email, optionally with attachments.
Function xtext_encode Undocumented
Function xtext_decode Decode the xtext-encoded string s using a fast extension function.
Class xtextStreamReader Undocumented
Class xtextStreamWriter Undocumented
Function xtext_codec Undocumented
Function _slowXTextDecode Decode the xtext-encoded string s.
def rfc822date(timeinfo=None, local=1): (source)
Format an RFC-2822 compliant date string.
Parameterstimeinfo(optional) A sequence as returned by time.localtime() or time.gmtime(). Default is now.
local(optional) Indicates if the supplied time is local or universal time, or if no time is given, whether now should be local or universal time. Default is local, as suggested (SHOULD) by rfc-2822.
ReturnsA string representing the time and date in RFC-2822 format.
def idGenerator(): (source)
def messageid(uniq=None, N=idGenerator().next): (source)

Return a globally unique random string in RFC 2822 Message-ID format


Optional uniq string will be added to strenghten uniqueness if given.
def quoteaddr(addr): (source)
Turn an email address, possibly with realname part etc, into a form suitable for and SMTP envelope.
def sendmail(smtphost, from_addr, to_addrs, msg, senderDomainName=None, port=25): (source)

Send an email

This interface is intended to be a direct replacement for smtplib.SMTP.sendmail() (with the obvious change that you specify the smtphost as well). Also, ESMTP options are not accepted, as we don't do ESMTP yet. I reserve the right to implement the ESMTP options differently.
ParameterssmtphostThe host the message should be sent to
from_addrThe (envelope) address sending this mail.
to_addrsA list of addresses to send this mail to. A string will be treated as a list of one address
msgThe message, including headers, either as a file or a string. File-like objects need to support read() and close(). Lines must be delimited by '\n'. If you pass something that doesn't look like a file, we try to convert it to a string (so you should be able to pass an email.Message directly, but doing the conversion with email.Generator manually will give you more control over the process).
senderDomainNameName by which to identify. If None, try to pick something sane (but this depends on external configuration and may not succeed).
portRemote port to which to connect.

A Deferred, its callback will be called if a message is sent to ANY address, the errback if no message is sent.

The callback will be called with a tuple (numOk, addresses) where numOk is the number of successful recipient addresses and addresses is a list of tuples (address, code, resp) giving the response to the RCPT command for each address. (type: Deferred )
def sendEmail(smtphost, fromEmail, toEmail, content, headers=None, attachments=None, multipartbody='mixed'): (source)
Send an email, optionally with attachments.
Parameterssmtphosthostname of SMTP server to which to connect (type: str )
fromEmailemail address to indicate this email is from (type: str )
toEmailemail address to which to send this email (type: str )
contentThe body if this email. (type: str )
headersDictionary of headers to include in the email (type: dict )
attachmentsEach 3-tuple should consist of the name of the attachment, the mime-type of the attachment, and a string that is the attachment itself. (type: list of 3-tuples )
multipartbodyThe type of MIME multi-part body. Generally either "mixed" (as in text and images) or "alternative" (html email with a fallback to text/plain). (type: str )
ReturnsThe returned Deferred has its callback or errback invoked when the mail is successfully sent or when an error occurs, respectively. (type: Deferred )
def xtext_encode(s, errors=None): (source)
def _slowXTextDecode(s, errors=None): (source)
Decode the xtext-encoded string s.
def xtext_decode(s, errors=None): (source)
Decode the xtext-encoded string s using a fast extension function.
def xtext_codec(name): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:07:41.