twisted.mail.maildir.MaildirMessage : API documentation

class documentation

class MaildirMessage(mail.FileMessage): (source)

A message receiver which adds a header and delivers a message to a file whose name includes the size of the message.

Instance Variable	`size`	The number of octets in the message.
Method	`__init__`
Method	`lineReceived`	Write a line to the file.
Method	`eomReceived`	At the end of message, rename the file holding the message to its final name concatenated with the size of the file.
Instance Variable	`finalName`	Undocumented

Inherited from FileMessage:

Instance Variable	`fp`	See `__init__`.
Instance Variable	`name`	See `__init__`.
Method	`connectionLost`	Delete the file holding the partially received message.

The number of octets in the message.

(type: int)

def __init__(self, address, fp, *a, **kw): (source)

overrides twisted.mail.mail.FileMessage.__init__

Parameters	address	The address of the message recipient. (type: `bytes`)
	fp	The file in which to store the message while it is being received. (type: file-like object)
	a	Positional arguments for `FileMessage.__init__`. (type: 2-`tuple` of (0) `bytes`, (1) `bytes`)
	kw	Keyword arguments for `FileMessage.__init__`. (type: `dict`)

def lineReceived(self, line): (source)

from twisted.mail.interfaces.IMessageSMTP

overrides twisted.mail.mail.FileMessage.lineReceived

Write a line to the file.

Parameters line A received line. (type: bytes)

def eomReceived(self): (source)

from twisted.mail.interfaces.IMessageSMTP

overrides twisted.mail.mail.FileMessage.eomReceived

At the end of message, rename the file holding the message to its final name concatenated with the size of the file.

Returns A deferred which returns the name of the file holding the message. (type: Deferred which successfully results in bytes)

finalName = (source)

overrides twisted.mail.mail.FileMessage.finalName

Undocumented

API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.