maildirMessage Class Reference
maildir message implementation. More...
Public Member Functions | |
| int | getNumber () const |
| const uid | getUniqueId () const |
| int | getSize () const |
| bool | isExpunged () const |
| ref< const structure > | getStructure () const |
| ref< structure > | getStructure () |
| ref< const header > | getHeader () const |
| int | getFlags () const |
| void | setFlags (const int flags, const int mode=FLAG_MODE_SET) |
| void | extract (utility::outputStream &os, utility::progressListener *progress=NULL, const int start=0, const int length=-1, const bool peek=false) const |
| void | extractPart (ref< const part > p, utility::outputStream &os, utility::progressListener *progress=NULL, const int start=0, const int length=-1, const bool peek=false) const |
| void | fetchPartHeader (ref< part > p) |
Detailed Description
maildir message implementation.
Member Function Documentation
| void extract | ( | utility::outputStream & | os, | |
| utility::progressListener * | progress = NULL, |
|||
| const int | start = 0, |
|||
| const int | length = -1, |
|||
| const bool | peek = false | |||
| ) | const [virtual] |
Extract the whole message data (header + contents).
- Warning:
- Partial fetch might not be supported by the underlying protocol.
- Parameters:
-
os output stream in which to write message data progress progress listener, or NULL if not used start index of the first byte to retrieve (used for partial fetch) length number of bytes to retrieve (used for partial fetch) peek if true, try not to mark the message as read. This may not be supported by the protocol (IMAP supports this), but it will NOT throw an exception if not supported.
Implements message.
| void extractPart | ( | ref< const part > | p, | |
| utility::outputStream & | os, | |||
| utility::progressListener * | progress = NULL, |
|||
| const int | start = 0, |
|||
| const int | length = -1, |
|||
| const bool | peek = false | |||
| ) | const [virtual] |
Extract the specified MIME part of the message (header + contents).
- Warning:
- Partial fetch might not be supported by the underlying protocol.
- Parameters:
-
p part to extract os output stream in which to write part data progress progress listener, or NULL if not used start index of the first byte to retrieve (used for partial fetch) length number of bytes to retrieve (used for partial fetch) peek if true, try not to mark the message as read. This may not be supported by the protocol (IMAP supports this), but it will NOT throw an exception if not supported.
Implements message.
| void fetchPartHeader | ( | ref< part > | p | ) | [virtual] |
Fetch the MIME header for the specified part.
- Parameters:
-
p the part for which to fetch the header
Implements message.
References platform::getHandler().
| int getFlags | ( | ) | const [virtual] |
Return the flags of this message.
- Returns:
- flags of the message
Implements message.
References message::FLAG_UNDEFINED.
| ref< const header > getHeader | ( | ) | const [virtual] |
Return a reference to the header fields of the message (must fetch before).
- Returns:
- header section of the message
Implements message.
| int getNumber | ( | ) | const [virtual] |
Return the sequence number of this message.
This number is used to reference the message in the folder.
- Returns:
- sequence number of the message
Implements message.
| int getSize | ( | ) | const [virtual] |
Return the size of the message (must fetch before).
- Returns:
- size of the message (in bytes)
Implements message.
| ref< structure > getStructure | ( | ) | [virtual] |
Return the MIME structure of the message (must fetch before).
- Returns:
- MIME structure of the message
Implements message.
| ref< const structure > getStructure | ( | ) | const [virtual] |
Return the MIME structure of the message (must fetch before).
- Returns:
- MIME structure of the message
Implements message.
| const message::uid getUniqueId | ( | ) | const [virtual] |
Return the unique identified of this message (must fetch before).
- Returns:
- UID of the message
Implements message.
| bool isExpunged | ( | ) | const [virtual] |
Check whether this message has been expunged (ie: definitively deleted).
- Returns:
- true if the message is expunged, false otherwise
Implements message.
| void setFlags | ( | const int | flags, | |
| const int | mode = FLAG_MODE_SET | |||
| ) | [virtual] |
Set the flags of this message.
- Parameters:
-
flags set of flags (see Flags) mode indicate how to treat old and new flags (see FlagsModes)
Implements message.
The documentation for this class was generated from the following files:
