Public Member Functions | |
| IMAPMessage (shared_ptr< IMAPFolder > folder, const int num) | |
| IMAPMessage (shared_ptr< IMAPFolder > folder, const int num, const uid &uid) | |
| ~IMAPMessage () | |
| int | getNumber () const |
| const uid | getUID () const |
| vmime_uint64 | getModSequence () const |
| size_t | getSize () const |
| bool | isExpunged () const |
| shared_ptr< const messageStructure > | getStructure () const |
| shared_ptr< messageStructure > | getStructure () |
| shared_ptr< 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 size_t start=0, const size_t length=-1, const bool peek=false) const |
| void | extractPart (shared_ptr< const messagePart > p, utility::outputStream &os, utility::progressListener *progress=NULL, const size_t start=0, const size_t length=-1, const bool peek=false) const |
| void | fetchPartHeader (shared_ptr< messagePart > p) |
| shared_ptr< vmime::message > | getParsedMessage () |
 Public Member Functions inherited from message | |
Additional Inherited Members | |
| Public Types inherited from message | |
| Protected Types inherited from message | |
| Protected Member Functions inherited from message | |
| Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
IMAP message implementation.
Constructor & Destructor Documentation
| IMAPMessage | ( | shared_ptr< IMAPFolder > | folder, |
| const int | num | ||
| ) |
| IMAPMessage | ( | shared_ptr< IMAPFolder > | folder, |
| const int | num, | ||
| const uid & | uid | ||
| ) |
| ~IMAPMessage | ( | ) |
Member Function Documentation
|
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.
|
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.
|
virtual |
Fetch the MIME header for the specified part.
- Parameters
-
p the part for which to fetch the header
Implements message.
|
virtual |
Return the flags of this message.
- Returns
- flags of the message
Implements message.
References message::FLAG_UNDEFINED.
|
virtual |
Return a reference to the header fields of the message (must fetch before).
- Returns
- header section of the message
Implements message.
| vmime_uint64 getModSequence | ( | ) | const |
Returns the modification sequence for this message.
Every time metadata for this message changes, the modification sequence is updated, and is greater than the previous one. The server must support the CONDSTORE extension for this to be available.
- Returns
- modification sequence, or zero if not supported by the underlying protocol
|
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.
|
virtual |
Get the RFC-822 message for this abstract message.
Warning: This may require getting some data (ie: structure and headers) from the server, which is done automatically. Actual message contents (ie: body) will not be fetched if possible (IMAP allows it, whereas POP3 will require to fetch the whole message).
- Returns
- a RFC-822-parsed message
Implements message.
References IMAPMessage::getStructure(), and fetchAttributes::STRUCTURE.
|
virtual |
Return the size of the message (must fetch before).
- Returns
- size of the message (in bytes)
Implements message.
|
virtual |
Return the MIME structure of the message (must fetch before).
- Returns
- MIME structure of the message
Implements message.
Referenced by IMAPMessage::getParsedMessage().
|
virtual |
Return the MIME structure of the message (must fetch before).
- Returns
- MIME structure of the message
Implements message.
|
virtual |
Return the unique identifier (UID) of this message in its folder (must fetch before).
- Returns
- UID of the message
Implements message.
|
virtual |
Check whether this message has been expunged (ie: definitively deleted) and does not exist in the folder anymore.
- Returns
- true if the message is expunged, false otherwise
Implements message.
|
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.
References messageSet::byNumber(), messageSet::byUID(), and message::uid::empty().
The documentation for this class was generated from the following files:
