t.m.m.FileMessage : class documentation

Part of twisted.mail.mail View Source View In Hierarchy

Known subclasses: twisted.mail.maildir.MaildirMessage

Implements interfaces: twisted.mail.smtp.IMessage

A message receiver which delivers a message to a file.
Instance Variable fp See __init__.
Instance Variable name See __init__.
Instance Variable finalName See __init__.
Method __init__
Method lineReceived Write a received line to the file.
Method eomReceived At the end of message, rename the file holding the message to its final name.
Method connectionLost Delete the file holding the partially received message.
fp =
See __init__.
name =
See __init__.
finalName =
See __init__.
def __init__(self, fp, name, finalName): (source)
ParametersfpThe file in which to store the message while it is being received. (type: file-like object)
nameThe full path name of the temporary file. (type: bytes)
finalNameThe full path name that should be given to the file holding the message after it has been fully received. (type: bytes)
def lineReceived(self, line): (source)
Write a received line to the file.
ParameterslineA received line. (type: bytes)
def eomReceived(self): (source)
At the end of message, rename the file holding the message to its final name.
ReturnsA deferred which returns the final name of the file. (type: Deferred which successfully results in bytes)
def connectionLost(self): (source)
Delete the file holding the partially received message.
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.