mail::account::updateFolderIndexInfo(3x)

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

NAME

6       mail::account::updateFolderIndexInfo - Update status of the currently
7       open folder
8

SYNOPSIS

10       #include <libmail/mail.H>
11
12
13       class myCallback : public mail::callback {
14       public:
15           void success(std::string msg);
16           void fail(std::string msg);
17       };
18
19       mail::account *account;
20
21       account->updateFolderIndexInfo(myCallback &callback);
22

USAGE

24       This function requests that the status of the currently open folder be
25       updated. Messages marked as deleted are removed. The application will
26       also be notified about changes to the folder made by any other
27       application that has the same folder opened.
28
29       This request invokes methods in the currently opened folder´s
30       mail::callback::folder object, as follows:
31
32       ·   The mail::account::messageChanged method is invoked for all
33           messages which have an updated status flag set.
34
35       ·    mail::account::messagesRemoved is invoked for all messages removed
36           from the folder (those that were marked as deleted by this
37           application and those that were removed from the folder by any
38           other application that has this folder opened).
39
40       ·    mail::account::newMessages is invoked if any messages were added
41           to this folder. The application should use
42           mail::account::getFolderIndexSize(3x), and compare it to the
43           previously-known folder size, in order to determine how many
44           messages were added to the folder (new messages are always added to
45           the end of the message list).
46

RETURN CODES

48       The application must wait until callback´s success or fail method is
49       invoked. The success method is invoked when this request is succesfully
50       processed. The fail method is invoked if this request cannot be
51       processed. The application must not destroy callback until either the
52       success or fail method is invoked.
53
54           Note
55           callback´s fail method may be invoked even after other callback
56           methods were invoked. This indicates that the request was partially
57           completed before the error was encountered.
58

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO