class documentation

Undocumented

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

Inherited from FancyStrMixin:

Method __str__ Undocumented
def __init__(self, headers, flags, date, body, uid, subpart): (source)

Undocumented

def getBodyFile(self): (source)

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

def getFlags(self): (source)

Retrieve the flags associated with this message.

Returns
iterableThe flags, represented as strings.
def getHeaders(self, negate, *names): (source)

Retrieve a group of message headers.

Parameters
negate:boolIf True, indicates that the headers listed in names should be omitted from the return value, rather than included.
*names:tuple of strThe names of the headers to retrieve or omit.
Returns
dictA mapping of header field names to header field values
def getInternalDate(self): (source)

Retrieve the date internally associated with this message.

Returns
bytesAn RFC822-formatted date string.
def getSize(self): (source)

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

Returns
intUndocumented
def getSubPart(self, part): (source)

Retrieve a MIME sub-message

Parameters
part:intThe number of the part to retrieve, indexed from 0.
Returns
Any object implementing IMessageIMAPPart.The specified sub-part.
Raises
IndexErrorRaised if the specified part does not exist.
TypeErrorRaised if this message is not multipart.
def getUID(self): (source)

Retrieve the unique identifier associated with this message.

def isMultipart(self): (source)

Indicate whether this message has subparts.

Returns
boolUndocumented

Undocumented

Undocumented

got_headers = (source)

Undocumented

got_subpart = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented