Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members  

blue::ext::httpmail::Message Class Reference
[HttpMail]

#include <Message.h>

List of all members.


Detailed Description

Allows retrieval of the message body.

This class offers a way for applications to retrieve the content of an email message.

Note that no manipulation to the actual message on the server is done through this class. To manipulate the messages, use the Folder class.


Public Member Functions

 Message (Mailbox &mailbox, String url)
 Constructor.

 ~Message ()
 Destructor.

String getUrl () const
 Gets the url used to access this message.

String getID () const
 Gets the ID of the message.

bool isLoaded () const
 Determines if the content of the message has been loaded.

bool isRead () const
 Determines if the message is marked as read on the server.

int getContentLength () const
 Gets the length of the message in bytes.

String getFrom () const
 Gets the name or email address of the entity that sent this message.

String getSubject () const
 Gets the subject of the message.

util::DateTime getDate () const
 Gets the date of the message (the date the server received it).

const Buffer getContent () const
 Gets the content of the message.

void setUrl (String url)
 Gets the url used to access this message.

void setRead (bool read)
 Sets if the message is marked as read on the server.

void setContentLength (int length)
 Sets the content length of the message.

void setFrom (String from)
 Sets the from entity of the message.

void setSubject (String subject)
 Sets the subject of the message.

void setDate (util::DateTime date)
 Sets the received date of the message.

void load ()
 Loads the message content into memory.

void unload ()
 Unloads the message content from memory.


Constructor & Destructor Documentation

blue::ext::httpmail::Message::Message Mailbox   mailbox,
String    url
 

Constructor.

blue::ext::httpmail::Message::~Message  
 

Destructor.


Member Function Documentation

String blue::ext::httpmail::Message::getUrl   const
 

Gets the url used to access this message.

String blue::ext::httpmail::Message::getID   const
 

Gets the ID of the message.

Each mail message has its own unique ID given to it by the server.

bool blue::ext::httpmail::Message::isLoaded   const
 

Determines if the content of the message has been loaded.

bool blue::ext::httpmail::Message::isRead   const
 

Determines if the message is marked as read on the server.

int blue::ext::httpmail::Message::getContentLength   const
 

Gets the length of the message in bytes.

String blue::ext::httpmail::Message::getFrom   const
 

Gets the name or email address of the entity that sent this message.

If a textual name is provided, that is returned, otherwise, the email address is returned.

String blue::ext::httpmail::Message::getSubject   const
 

Gets the subject of the message.

util::DateTime blue::ext::httpmail::Message::getDate   const
 

Gets the date of the message (the date the server received it).

const Buffer blue::ext::httpmail::Message::getContent   const
 

Gets the content of the message.

The message must have been previously loaded in order for this to return valid data.

void blue::ext::httpmail::Message::setUrl String    url
 

Gets the url used to access this message.

void blue::ext::httpmail::Message::setRead bool    read
 

Sets if the message is marked as read on the server.

This does NOT change the actual status of the message on the server. To do that, call Folder::setMessageRead() on the folder where this message resides.

void blue::ext::httpmail::Message::setContentLength int    length
 

Sets the content length of the message.

This only affects the value returned by getContentLength().

void blue::ext::httpmail::Message::setFrom String    from
 

Sets the from entity of the message.

This only affects the value returned by getFrom().

void blue::ext::httpmail::Message::setSubject String    subject
 

Sets the subject of the message.

This only affects the value returned by getSubject().

void blue::ext::httpmail::Message::setDate util::DateTime    date
 

Sets the received date of the message.

This only affects the value returned by getDate().

void blue::ext::httpmail::Message::load  
 

Loads the message content into memory.

void blue::ext::httpmail::Message::unload  
 

Unloads the message content from memory.


The documentation for this class was generated from the following file:
Generated on Wed Jun 30 14:44:27 2004 for Blue HttpMail Extension by doxygen1.3-rc3