interface documentation

class twisted.mail.interfaces.IMessageIMAPPart(Interface): (source)

Known subclasses: twisted.mail.interfaces.IMessageIMAP

View In Hierarchy

Undocumented

Method getHeaders Retrieve a group of message headers.
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 isMultipart Indicate whether this message has subparts.
Method getSubPart Retrieve a MIME sub-message
def getHeaders(negate, *names): (source)

Retrieve a group of message headers.

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

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

def getSize(): (source)

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

ReturnsUndocumented (type: int)
def isMultipart(): (source)

Indicate whether this message has subparts.

ReturnsUndocumented (type: bool)
def getSubPart(part): (source)

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 20.12.1 at 2021-02-28 19:53:36.