mail::ACCOUNT::getFolderFromString.3x man page

Cone©

mail::ACCOUNT::getFolderFromString — Restore a folder object

Synopsis

#include <libmail/sync.H>

mail::ACCOUNT *mail;
mail::folder *folder;

std::string savedFolder=folder->toString();

...

mail::folder *f=mail->getFolderFromString(std::string savedFolder);

Usage

This function is the mail::ACCOUNT equivalent of mail::account::folderFromString(3x). See the description of this function for more information.

Return Codes and Callbacks

This function returns a NULL pointer if it cannot allocate memory for the new mail::folder object.

Note

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.

See Also

mail::account::folderFromString(3x).

Author

Sam Varshavchik

Info

08/25/2013 Cone© Cone: COnsole Newsreader And E