IMAPMessage Class Reference

#include <IMAPMessage.hpp>

Inheritance diagram for IMAPMessage:

Collaboration diagram for IMAPMessage:

Public Member Functions
	IMAPMessage (shared_ptr< IMAPFolder > folder, const size_t num)
	IMAPMessage (shared_ptr< IMAPFolder > folder, const size_t num, const uid &uid)
	~IMAPMessage ()
size_t	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
virtual	~message ()

Additional Inherited Members
Public Types inherited from message
enum	Flags {   FLAG_SEEN = (1 << 0) , FLAG_RECENT = (1 << 1) , FLAG_DELETED = (1 << 2) , FLAG_REPLIED = (1 << 3) ,   FLAG_MARKED = (1 << 4) , FLAG_PASSED = (1 << 5) , FLAG_DRAFT = (1 << 6) }
enum	FlagsModes { FLAG_MODE_SET , FLAG_MODE_ADD , FLAG_MODE_REMOVE }
Protected Types inherited from message
enum	PrivateConstants { FLAG_UNDEFINED = 9999 }
Protected Member Functions inherited from message
	message ()
	message (const 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() [1/2]

IMAPMessage	(	shared_ptr< IMAPFolder >	folder,
		const size_t	num
	)

IMAPMessage() [2/2]

IMAPMessage	(	shared_ptr< IMAPFolder >	folder,
		const size_t	num,
		const uid &	uid
	)

~IMAPMessage()

~IMAPMessage

(

)

References vmime::dynamicCast().

Member Function Documentation

extract()

void extract ( utility::outputStream &  os, utility::progressListener *  progress = NULL, const size_t  start = 0, const size_t  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.

References vmime::dynamicCast().

extractPart()

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

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.

References vmime::dynamicCast().

fetchPartHeader()

void fetchPartHeader ( shared_ptr< messagePart >  p )

virtual

Fetch the MIME header for the specified part.

Parameters

p	the part for which to fetch the header

Implements message.

References vmime::dynamicCast().

getFlags()

int getFlags ( ) const

virtual

Return the flags of this message.

Returns

flags of the message

Implements message.

References message::FLAG_UNDEFINED.

getHeader()

shared_ptr< 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.

References vmime::dynamicCast().

getModSequence()

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

getNumber()

size_t 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.

getParsedMessage()

shared_ptr< vmime::message > getParsedMessage ( )

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 vmime::dynamicCast(), IMAPMessage::getStructure(), and fetchAttributes::STRUCTURE.

getSize()

size_t getSize ( ) const

virtual

Return the size of the message (must fetch before).

Returns

size of the message (in bytes)

Implements message.

getStructure() [1/2]

shared_ptr< messageStructure > getStructure ( )

virtual

Return the MIME structure of the message (must fetch before).

Returns

MIME structure of the message

Implements message.

References vmime::dynamicCast().

getStructure() [2/2]

shared_ptr< const messageStructure > getStructure ( ) const

virtual

Return the MIME structure of the message (must fetch before).

Returns

MIME structure of the message

Implements message.

References vmime::dynamicCast().

Referenced by IMAPMessage::getParsedMessage().

getUID()

const message::uid getUID ( ) const

virtual

Return the unique identifier (UID) of this message in its folder (must fetch before).

Returns

UID of the message

Implements message.

isExpunged()

bool isExpunged ( ) const

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.

setFlags()

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.

References messageSet::byNumber(), messageSet::byUID(), vmime::dynamicCast(), message::uid::empty(), and folder::setMessageFlags().

---

The documentation for this class was generated from the following files:

• IMAPMessage.hpp
• IMAPMessage.cpp