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

NAME

8       mail::ACCOUNT::getSubFolders - Enumerate subfolders
9

SYNOPSIS

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

USAGE

25       A mail account contains folders that are arranged in a tree-like
26       hierarchy.  mail::ACCOUNT::getSubFolders enumerates folder's subfolders
27       (folder is obtained from a previous mail::ACCOUNT::getSubFolders or a
28       mail::ACCOUNT::getTopLevelFolders(3x) call).
29
30           Note
31           Use mail::folder::hasSubFolders(3x) to check if folder contains
32           subfolders, and invoke mail::ACCOUNT::getSubFolders only if
33           mail::folder::hasSubFolders returns true.
34

RETURN CODES AND CALLBACKS

36       This method returns true if it succeeds, or false if it fails. If the
37       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
38       description of the error.
39
40       See mail::ACCOUNT::getTopLevelFolders(3x) for additional notes and
41       instructions on handling folder lists.
42

SEE ALSO

44       mail::ACCOUNT::getParentFolder(3x),
45       mail::ACCOUNT::getTopLevelFolders(3x).
46

AUTHOR

48       Sam Varshavchik
49
50
51
52Cone©                             08/25/2016          MAIL::ACCOUNT::GETSU(3x)
Impressum