1mail::ACCOUNT::getSubmFaoilld:e:rAsC(C3OxU)NT Synchronous AmPaIilr:e:fAeCrCeOnUcNeT::getSubFolders(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
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 hier‐
26       archy.   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: Use mail::folder::hasSubFolders(3x)  to  check  if  folder
31              contains  subfolders,  and  invoke  mail::ACCOUNT::getSubFolders
32              only if mail::folder::hasSubFolders returns true.
33

RETURN CODES AND CALLBACKS

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

SEE ALSO

43       mail::ACCOUNT::getParentFolder(3x),     mail::ACCOUNT::getTopLevelFold‐
44       ers(3x).
45
46
47
48                                 10 April 2006mail::ACCOUNT::getSubFolders(3x)
Impressum