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

NAME

8       mail::ACCOUNT::getParentFolder - Find parent folder
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->getParentFolder(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::getParentFolder finds a folder's parent
27       folder (folder is obtained from a previous mail::ACCOUNT::getSubFolders
28       or a mail::ACCOUNT::getTopLevelFolders(3x) call).
29

RETURN CODES AND CALLBACKS

31       This method returns true if it succeeds, or false if it fails. If the
32       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
33       description of the error.
34
35       If successful, folderList will contain a single pointer to a
36       mail::folder object that will refer to folder's parent folder.
37
38       See mail::ACCOUNT::getTopLevelFolders(3x) for additional notes and
39       instructions on handling folder lists.
40

SEE ALSO

42       mail::ACCOUNT::getSubFolders(3x),
43       mail::ACCOUNT::getTopLevelFolders(3x).
44

AUTHOR

46       Sam Varshavchik
47
48
49
50Cone©                             08/25/2016          MAIL::ACCOUNT::GETPA(3x)