mail::account::findFolder — A direct short-cut to a folder
#include <libmail/mail.H>
class myCallback : public mail::callback {
public:
void success(std::string msg);
void fail(std::string msg);
};
class myFolderCallback : public mail::callback::folderlist {
public:
void success(const std::vector<const mail::folder *> &folders);
};
mail::account *account;
mail::folder *folder;
std::string folderPath=folder->getPath();
mail::folder
*folder=account->findFolder( |
std::string folderPath, |
| myFolderCallback &folderCallback, | |
myCallback &callback); |
This function is very similar to mail::account::folderFromString(3x).
mail::account::findFolder
recreates a mail::folder
object, given its server path (which is returned by mail::folder::getPath(3x).
The differences between mail::account::findFolder and mail::account::folderFromString are:
mail::account::folderFromString uses
a string created by mail::account::folder::toString,
which includes all of the folder's properties (such as
whether the folder contains messages, subfolders, or
both, and its canonical name). mail::account::findFolder uses only
the folder's "path", or "address" on the server.
The application must not destroy folderCallback until this
request fails or succeeds. folderCallback's success method is invoked just before the
callback's
success method.
The folderCallback.success
method receives a vector with a single pointer mail::folder object, that's initialized
to represent the folder referenced by folderPath.
The application must wait until callback's success or fail method is invoked. The success method is invoked when this request
is succesfully processed. The fail method is invoked if this request
cannot be processed. The application must not destroy
callback until either
the success or fail method is invoked.
callback's
fail method may be invoked
even after other callback methods were invoked. This
indicates that the request was partially completed before
the error was encountered.
The folderCallback.success
method receives a (possibly empty) vector of pointers to
mail::folder objects. These
objects will be destroyed when folderCallback.success terminates. The
application must use mail::folder::clone(3x)
to create copies of mail::folder objects it wants to use
later.
Both folderCallback.success and myCallback.success method will be invoked
if this request succeeds. folderCallback.success will be invoked
before myCallback.success
(since by definition this indicates that the request has
been completed).
mail::folders are linked to their corresponding mail::accounts. A mail::folder created by one mail::account may not be used with a different mail::folder. All mail::folders created by a mail::account are invalidated when this mail::account object is destroyed. Note that the mail::folder objects are not automatically destroyed; the application is still responsible for destroying any remaining mail::folders, after their a mail::account is destroyed.