1        Cone©
2
3MAIL::ACCOUNT::GETTO(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::GETTO(3x)
4
5
6

NAME

8       mail::ACCOUNT::getTopLevelFolders - Enumerate top-level folders
9

SYNOPSIS

11       #include <libmail/sync.H>
12
13       mail::ACCOUNT *mail;
14       mail::ACCOUNT::FolderList folderList;
15
16       bool ok=mail->getTopLevelFolders(folderList);
17
18                                        std::string errmsg=mail->getErrmsg();
19
20                                        size_t nFolders=folderList::size();
21                                        const mail::folder *folder=folderList[n];
22

USAGE

24       A mail account contains a collection of folders, arranged in a
25       top-to-bottom hierarchy. This function returns the list of the folders
26       at the top-level of the folder hierarchy.
27
28       mail::ACCOUNT::getTopLevelFolders, if succesful, initializes a list of
29       mail::folder objects, which are maintained by the
30       mail::ACCOUNT::FolderList class. Each mail::folder object represents a
31       mail account's folder. The number of folders, and a pointer to each
32       folder object, is obtained according to the example above.
33
34           Note
35           Pointers to mail::folder objects are no longer valid after the
36           mail::ACCOUNT::FolderList object is destroyed. The application
37           should use mail::folder::clone(3x) to create a duplicate copy of
38           the mail::folder object (which the application is now responsible
39           for destroying).
40

RETURN CODES AND CALLBACKS

42       This method returns true if it succeeds, or false if it fails. If the
43       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
44       description of the error.
45

SEE ALSO

47       mail::ACCOUNT::login(3x), mail::ACCOUNT::getSubFolders(3x).
48

AUTHOR

50       Sam Varshavchik
51
52
53
54Cone©                             08/25/2016          MAIL::ACCOUNT::GETTO(3x)