Implements interfaces: twisted.mail.interfaces.IMessageIMAP

Undocumented
Method __init__ Undocumented
Method getHeaders Retrieve a group of message headers.
Method getFlags Retrieve the flags associated with this message.
Method getInternalDate Retrieve the date internally associated with this message.
Method getBodyFile Retrieve a file object containing only the body of this message.
Method getSize Retrieve the total size, in octets, of this message.
Method getUID Retrieve the unique identifier associated with this message.
Method isMultipart Indicate whether this message has subparts.
Method getSubPart Retrieve a MIME sub-message

Inherited from FancyStrMixin:

Method __str__ Undocumented
def __init__(self, headers, flags, date, body, uid, subpart):
Undocumented
def getHeaders(self, negate, *names):

Retrieve a group of message headers.

ParametersnamesThe names of the headers to retrieve or omit. (type: tuple of str)
negateIf True, indicates that the headers listed in names should be omitted from the return value, rather than included. (type: bool)
ReturnsA mapping of header field names to header field values (type: dict)
def getFlags(self):

Retrieve the flags associated with this message.

ReturnsThe flags, represented as strings. (type: iterable)
def getInternalDate(self):

Retrieve the date internally associated with this message.

ReturnsAn RFC822-formatted date string. (type: bytes)
def getBodyFile(self):

Retrieve a file object containing only the body of this message.

def getSize(self):

Retrieve the total size, in octets, of this message.

Returns (type: int)
def getUID(self):

Retrieve the unique identifier associated with this message.

def isMultipart(self):

Indicate whether this message has subparts.

Returns (type: bool)
def getSubPart(self, part):

Retrieve a MIME sub-message

ParameterspartThe number of the part to retrieve, indexed from 0. (type: int)
ReturnsThe specified sub-part. (type: Any object implementing IMessageIMAPPart.)
RaisesIndexErrorRaised if the specified part does not exist.
TypeErrorRaised if this message is not multipart.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.