Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members  

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

#include <Folder.h>

List of all members.


Detailed Description

Allows querying and manipulation of folders.

This class offers a way for applications to query and manipulate folders on an HttpMail server.

When using a folder for the first time, a call to refresh() is required so that the folder can contact the server and retrieve its list of folders and messages.


Public Member Functions

 Folder (Mailbox &mailbox, Folder *parent, String url)
 Constructor.

 ~Folder ()
 Destructor.

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

String getName () const
 Gets the name of the folder.

String getDisplayName () const
 Gets the display name of the folder (what the user sees).

int getMessageCount () const
 Gets the number of messages contained in this folder.

int getMessageCountUnread () const
 Gets the number of unread messages contained in this folder.

int getFolderCount () const
 Gets the number of folders contained in this folder.

Folder * getFolder (int index)
 Gets a folder using an index value.

const Folder * getFolder (int index) const
 overload

Folder * getFolder (String folderName)
 Gets a folder using the folder's name.

const Folder * getFolder (String folderName) const
 overload

Array< Folder * > getFolders ()
 Gets an array of all the folders contained in this folder.

const Array< Folder * > getFolders () const
 overload

MessagegetMessage (int index)
 Gets an email message using an index value.

const MessagegetMessage (int index) const
 overload

Array< Message * > getMessages ()
 Gets an array of all the email messages contained in this folder.

const Array< Message * > getMessages () const
 overload

Folder * getParent ()
 Returns the parent folder of this folder.

const Folder * getParent () const
 overload

void setUrl (String url)
 Sets the url used to access this folder.

void setName (String name)
 Sets the name of the folder.

void setDisplay (String display)
 Sets the display name of the folder (what the user sees).

void setMessageCount (int messageCnt)
 Sets the number of messages contained in this folder.

void setMessageCountUnread (int messageCntUnread)
 Sets the number of unread messages contained in this folder.

int createFolder (String folderName)
 Creates a new folder within this folder.

void removeFolder (int index)
 Removes a folder from this folder.

void removeFolder (String folderName)
 overload

void moveMessage (int index, Folder *to)
 Moves a message from this folder to the given folder.

void moveMessage (Message *message, Folder *to)
 overload

void copyMessage (int index, Folder *to)
 Copies a message from this folder to the given folder.

void copyMessage (Message *message, Folder *to)
 overload

void removeMessage (int index)
 Deletes the given message.

void removeMessage (Message *message)
 overload

void setMessageRead (int index, bool read)
 Marks the message as read or unread on the server.

void setMessageRead (Message *message, bool read)
 overload

void refresh ()
 Refreshes the information about the folders and messages contained within this folder.


Constructor & Destructor Documentation

blue::ext::httpmail::Folder::Folder Mailbox   mailbox,
Folder *    parent,
String    url
 

Constructor.

blue::ext::httpmail::Folder::~Folder  
 

Destructor.


Member Function Documentation

String blue::ext::httpmail::Folder::getUrl   const
 

Gets the url used to access this folder.

String blue::ext::httpmail::Folder::getName   const
 

Gets the name of the folder.

String blue::ext::httpmail::Folder::getDisplayName   const
 

Gets the display name of the folder (what the user sees).

int blue::ext::httpmail::Folder::getMessageCount   const
 

Gets the number of messages contained in this folder.

int blue::ext::httpmail::Folder::getMessageCountUnread   const
 

Gets the number of unread messages contained in this folder.

int blue::ext::httpmail::Folder::getFolderCount   const
 

Gets the number of folders contained in this folder.

Folder* blue::ext::httpmail::Folder::getFolder int    index
 

Gets a folder using an index value.

const Folder* blue::ext::httpmail::Folder::getFolder int    index const
 

overload

Folder* blue::ext::httpmail::Folder::getFolder String    folderName
 

Gets a folder using the folder's name.

const Folder* blue::ext::httpmail::Folder::getFolder String    folderName const
 

overload

Array<Folder*> blue::ext::httpmail::Folder::getFolders  
 

Gets an array of all the folders contained in this folder.

const Array<Folder*> blue::ext::httpmail::Folder::getFolders   const
 

overload

Message* blue::ext::httpmail::Folder::getMessage int    index
 

Gets an email message using an index value.

const Message* blue::ext::httpmail::Folder::getMessage int    index const
 

overload

Array<Message*> blue::ext::httpmail::Folder::getMessages  
 

Gets an array of all the email messages contained in this folder.

const Array<Message*> blue::ext::httpmail::Folder::getMessages   const
 

overload

Folder* blue::ext::httpmail::Folder::getParent  
 

Returns the parent folder of this folder.

For the root level folder, this returns 0.

const Folder* blue::ext::httpmail::Folder::getParent   const
 

overload

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

Sets the url used to access this folder.

This should only be called by the Mailbox class unless you're sure you know what you're doing.

void blue::ext::httpmail::Folder::setName String    name
 

Sets the name of the folder.

This should only be called by the Mailbox class unless you're sure you know what you're doing.

void blue::ext::httpmail::Folder::setDisplay String    display
 

Sets the display name of the folder (what the user sees).

This should only be called by the Mailbox class unless you're sure you know what you're doing.

void blue::ext::httpmail::Folder::setMessageCount int    messageCnt
 

Sets the number of messages contained in this folder.

This should only be called by the Mailbox class unless you're sure you know what you're doing.

void blue::ext::httpmail::Folder::setMessageCountUnread int    messageCntUnread
 

Sets the number of unread messages contained in this folder.

This should only be called by the Mailbox class unless you're sure you know what you're doing.

int blue::ext::httpmail::Folder::createFolder String    folderName
 

Creates a new folder within this folder.

Returns:
the index used to access the new folder.

void blue::ext::httpmail::Folder::removeFolder int    index
 

Removes a folder from this folder.

void blue::ext::httpmail::Folder::removeFolder String    folderName
 

overload

void blue::ext::httpmail::Folder::moveMessage int    index,
Folder *    to
 

Moves a message from this folder to the given folder.

void blue::ext::httpmail::Folder::moveMessage Message   message,
Folder *    to
 

overload

void blue::ext::httpmail::Folder::copyMessage int    index,
Folder *    to
 

Copies a message from this folder to the given folder.

void blue::ext::httpmail::Folder::copyMessage Message   message,
Folder *    to
 

overload

void blue::ext::httpmail::Folder::removeMessage int    index
 

Deletes the given message.

void blue::ext::httpmail::Folder::removeMessage Message   message
 

overload

void blue::ext::httpmail::Folder::setMessageRead int    index,
bool    read
 

Marks the message as read or unread on the server.

void blue::ext::httpmail::Folder::setMessageRead Message   message,
bool    read
 

overload

void blue::ext::httpmail::Folder::refresh  
 

Refreshes the information about the folders and messages contained within this folder.


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