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

NAME

6       mail::ACCOUNT::getSubFolders - Enumerate subfolders
7

SYNOPSIS

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

USAGE

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

RETURN CODES AND CALLBACKS

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

SEE ALSO

42       mail::ACCOUNT::getParentFolder(3x),
43       mail::ACCOUNT::getTopLevelFolders(3x).
44
45
46
47[FIXME: source]                   05/08/2010          MAIL::ACCOUNT::GETSU(3x)
Impressum