1mail::ACCOUNT::readFomladielr:I:nAfCoC(O3UxN)T SynchronousmAaPiIl:r:eAfCeCrOeUnNcTe::readFolderInfo(3x)
2
3
4

NAME

6       mail::ACCOUNT::readFolderInfo - Get folder status
7

SYNOPSIS

9       #include <libmail/sync.H>
10
11       mail::ACCOUNT *mail;
12
13
14
15       bool      ok=mail->openFolder      (const     mail::folder     *folder,
16       mail::ACCOUNT::FolderInfo &info);
17
18       std::string errmsg=mail->getErrmsg();
19

USAGE

21       This function reads the current status of folder, which  may  refer  to
22       any  folder  in  the  mail  account (not necessarily the currently open
23       folder).
24
25       The following fields in info will be initialized by this function:
26
27       messageCount
28              Total number of messages in the folder.
29
30       unreadCount
31              Total number of unread messages in the folder.
32
33       fastInfo
34              This field should be initialized before calling  this  function.
35              If  set to true the message counts are returned only if they can
36              be computed  quickly.   Otherwise  folderInfoCallback's  success
37              method will not be invoked at all, but callback's success method
38              will still be invoked.
39
40              If this field is set to false (the default), the message  counts
41              are returned in all cases.
42

RETURN CODES AND CALLBACKS

44       This  method returns true if it succeeds, or false if it fails.  If the
45       method fails, use mail::ACCOUNT::getErrmsg() to read a  brief  descrip‐
46       tion of the error.
47

SEE ALSO

49       mail::ACCOUNT::openFolder(3x).
50
51
52
53                                 10 April 2006mail::ACCOUNT::readFolderInfo(3x)
Impressum