mail::folder::toString.3x man page


mail::folder::toString — Save a folder object


#include <libmail/mail.H>
mail::folder *folder;

std::string str=folder->toString(void);


This method returns a std::string that can be placed in some quiet, out of the way spot. At some later point in time, passing the std::string to mail::account::folderfromstring(3x) will create a mail::folder object that will refer to the same folder as the original object.


Folders may only be recreated by mail::account objects that reference the same mail account referenced by the original mail::folder object.

Return Codes and Callbacks

This function returns a std::string that the application should not attempt to interpret in any way (except as a parameter to mail::account::folderfromstring(3x).


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



Sam Varshavchik


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