mail::folder::toString(3x)

1MAIL::FOLDER::TOSTRI(3x)Cone: COnsole Newsreader And EMAIL::FOLDER::TOSTRI(3x)
2
3
4

NAME

6       mail::folder::toString - Save a folder object
7

SYNOPSIS

9       #include <libmail/mail.H>
10       mail::folder *folder;
11
12       std::string str=folder->toString(void);
13

USAGE

15       This method returns a std::string that can be placed in some quiet, out
16       of the way spot. At some later point in time, passing the std::string
17       to mail::account::folderfromstring(3x) will create a mail::folder
18       object that will refer to the same folder as the original object.
19
20           Note
21           Folders may only be recreated by mail::account objects that
22           reference the same mail account referenced by the original
23           mail::folder object.
24

RETURN CODES AND CALLBACKS

26       This function returns a std::string that the application should not
27       attempt to interpret in any way (except as a parameter to
28       mail::account::folderfromstring(3x).
29
30           Note
31           mail::folders are linked to their corresponding mail::accounts. A
32           mail::folder created by one mail::account may not be used with a
33           different mail::folder. All mail::folders created by a
34           mail::account are invalidated when this mail::account object is
35           destroyed. Note that the mail::folder objects are not automatically
36           destroyed; the application is still responsible for destroying any
37           remaining mail::folders, after their a mail::account is destroyed.
38

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO