#include <Folder.h>
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 | |
Message * | getMessage (int index) |
Gets an email message using an index value. | |
const Message * | getMessage (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.
|
|
Gets the url used to access this folder.
|
|
Gets the name of the folder.
|
|
Gets the display name of the folder (what the user sees).
|
|
Gets the number of messages contained in this folder.
|
|
Gets the number of unread messages contained in this folder.
|
|
Gets the number of folders contained in this folder.
|
|
Gets a folder using an index value.
|
|
overload
|
|
Gets a folder using the folder's name.
|
|
overload
|
|
Gets an array of all the folders contained in this folder.
|
|
overload
|
|
Gets an email message using an index value.
|
|
overload
|
|
Gets an array of all the email messages contained in this folder.
|
|
overload
|
|
Returns the parent folder of this folder. For the root level folder, this returns 0. |
|
overload
|
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Creates a new folder within this folder.
|
|
Removes a folder from this folder.
|
|
overload
|
|
Moves a message from this folder to the given folder.
|
|
overload
|
|
Copies a message from this folder to the given folder.
|
|
overload
|
|
Deletes the given message.
|
|
overload
|
|
Marks the message as read or unread on the server.
|
|
overload
|
|
Refreshes the information about the folders and messages contained within this folder.
|