#include <mailfolder.h>
Public Member Functions | |
MailFolder () throw () | |
MailFolder (const MailFolder &mf) throw () | |
MailFolder (MailFolderImpl *otherimpl) throw () | |
bool | valid () const throw () |
Return true if this MailFolder is not a null mail folder. | |
const std::string & | name () const throw () |
Return the presentation name of this mail folder. | |
const std::string & | path () const throw () |
Return the path to this mail folder. | |
std::string | type () const throw () |
Return the name of the type of this mail folder. | |
int | getMsgTotal () const throw () |
Get the total number of messages. | |
int | getMsgUnread () const throw () |
Get the number of unread messages. | |
int | getMsgNew () const throw () |
Get the number of new messages. | |
int | getMsgFlagged () const throw () |
Get the number of messages flagged 'important'. | |
bool | changed () |
Return true if the folder has been changed since the last updateStatistics. | |
void | updateStatistics () |
Rescan the folder to update its statistics. | |
Static Public Member Functions | |
static MailFolder | accessFolder (const std::string &path) |
Create a MailFolder object given a path, autodetecting the folder type. | |
static void | enumerateFolders (const std::string &path, Consumer< MailFolder > &cons) |
Scan a directory and pass to a Consumer all the folders that are found. | |
static std::vector< MailFolder > | enumerateFolders (const std::string &path) |
Scan a directory and return the folder it contains. |
buffy::MailFolder::MailFolder | ( | ) | throw () [inline] |
buffy::MailFolder::MailFolder | ( | const MailFolder & | mf | ) | throw () [inline] |
buffy::MailFolder::MailFolder | ( | MailFolderImpl * | otherimpl | ) | throw () [inline] |
bool buffy::MailFolder::valid | ( | ) | const throw () [inline] |
Return true if this MailFolder is not a null mail folder.
const std::string& buffy::MailFolder::name | ( | ) | const throw () [inline] |
Return the presentation name of this mail folder.
const std::string& buffy::MailFolder::path | ( | ) | const throw () [inline] |
Return the path to this mail folder.
std::string buffy::MailFolder::type | ( | ) | const throw () [inline] |
Return the name of the type of this mail folder.
For example: "Maildir" or "Mailbox"
int buffy::MailFolder::getMsgTotal | ( | ) | const throw () [inline] |
Get the total number of messages.
int buffy::MailFolder::getMsgUnread | ( | ) | const throw () [inline] |
Get the number of unread messages.
int buffy::MailFolder::getMsgNew | ( | ) | const throw () [inline] |
Get the number of new messages.
int buffy::MailFolder::getMsgFlagged | ( | ) | const throw () [inline] |
Get the number of messages flagged 'important'.
bool buffy::MailFolder::changed | ( | ) | [inline] |
Return true if the folder has been changed since the last updateStatistics.
A folder is not scanned automatically when the MailFolder object is created: at the beginning, all statistics will return -1 and changed() will return true;
void buffy::MailFolder::updateStatistics | ( | ) | [inline] |
Rescan the folder to update its statistics.
MailFolder MailFolder::accessFolder | ( | const std::string & | path | ) | [static] |
Create a MailFolder object given a path, autodetecting the folder type.
If no suitable folder type has been found or other problems happened, it will return a null MailFolder object.
void MailFolder::enumerateFolders | ( | const std::string & | path, | |
Consumer< MailFolder > & | cons | |||
) | [static] |
Scan a directory and pass to a Consumer all the folders that are found.
Referenced by enumerateFolders().
vector< MailFolder > MailFolder::enumerateFolders | ( | const std::string & | path | ) | [static] |