mail::ACCOUNT::getParentFolder(3x)

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

NAME

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

RETURN CODES AND CALLBACKS

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

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO