mail::account::updateFolderIndexInfo(3x)

1mail::account::updateFomladielr:I:nadcecxoIunnfto(N3axtm)iaviel:A:PaIccroeufnetr:e:nucpedateFolderIndexInfo(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
22
23       account->updateFolderIndexInfo (myCallback &callback);
24

USAGE

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

RETURN CODES

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

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO