mail::ACCOUNT::readFolderInfo(3x)

1MAIL::ACCOUNT::READF(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::READF(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       bool ok=mail->openFolder(const mail::folder *folder,
14                                mail::ACCOUNT::FolderInfo &info);
15
16                                std::string errmsg=mail->getErrmsg();
17

USAGE

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

RETURN CODES AND CALLBACKS

42       This method returns true if it succeeds, or false if it fails. If the
43       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
44       description of the error.
45

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO