Package twisted :: Package protocols :: Module imap4 :: Class IMessage
[frames | no frames]

Class IMessage

Interface --+
            |
           IMessage


Method Summary
  getBodyFile(self)
Retrieve a file object containing the body of this message.
iterable getFlags(self)
Retrieve the flags associated with this message.
dict getHeaders(self, negate, *names)
Retrieve a group of message headers.
str getInternalDate(self)
Retrieve the date internally associated with this message.
int getSize(self)
Retrieve the total size, in octets, of this message.
Any object implementing IMessage. getSubPart(self, part)
Retrieve a MIME sub-message
  getUID(self)
Retrieve the unique identifier associated with this message.

Method Details

getBodyFile(self)

Retrieve a file object containing the body of this message.

getFlags(self)

Retrieve the flags associated with this message.
Returns:
The flags, represented as strings.
           (type=iterable)

getHeaders(self, negate, *names)

Retrieve a group of message headers.
Parameters:
negate - If True, indicates that the headers listed in names should be omitted from the return value, rather than included.
           (type=bool)
names - The names of the headers to retrieve or omit.
           (type=tuple of str)
Returns:
A mapping of header field names to header field values
           (type=dict)

getInternalDate(self)

Retrieve the date internally associated with this message.
Returns:
An RFC822-formatted date string.
           (type=str)

getSize(self)

Retrieve the total size, in octets, of this message.
Returns:
int

getSubPart(self, part)

Retrieve a MIME sub-message
Parameters:
part -

The number of the part to retrieve, indexed from 0.

@raise IndexError: Raised if the specified part does not exist. @raise TypeError: Raised if this message is not multipart.
           (type=int)
Returns:
The specified sub-part.
           (type=Any object implementing IMessage.)

getUID(self)

Retrieve the unique identifier associated with this message.

Generated by Epydoc 2.0 on Sat Sep 13 04:20:51 2003 http://epydoc.sf.net