1mail::folder::toString(3mxa)il::folder Native API referemnaciel::folder::toString(3x)
2
3
4
6 mail::folder::toString - Save a folder object
7
9 #include <libmail/mail.H>
10 mail::folder *folder;
11
12
13
14 std::string str=folder->toString(void);
15
17 This method returns a std::string that can be placed in some quiet, out
18 of the way spot. At some later point in time, passing the std::string
19 to mail::account::folderfromstring(3x) will create a mail::folder
20 object that will refer to the same folder as the original object.
21
22 Note: Folders may only be recreated by mail::account objects
23 that reference the same mail account referenced by the original
24 mail::folder object.
25
27 This function returns a std::string that the application should not
28 attempt to interpret in any way (except as a parameter to
29 mail::account::folderfromstring(3x).
30
31 Note: mail::folders are linked to their corresponding
32 mail::accounts. A mail::folder created by one mail::account may
33 not be used with a different mail::folder. All mail::folders
34 created by a mail::account are invalidated when this
35 mail::account object is destroyed. Note that the mail::folder
36 objects are not automatically destroyed; the application is
37 still responsible for destroying any remaining mail::folders,
38 after their a mail::account is destroyed.
39
41 mail::account::folderfromstring(3x).
42
43
44
45 10 April 2006 mail::folder::toString(3x)