mail::account::updateFolderIndexFlags(3x)

1mail::account::updateFomladielr:I:nadcecxoFulnatgsN(am3taxii)vle::AaPcIcoruenfte:r:eunpcdeateFolderIndexFlags(3x)
2
3
4

NAME

6       mail::account::updateFolderIndexFlags  - Update status of multiple mes‐
7       sages
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->updateFolderIndexFlags  (const  std::vector<size_t>   msgList,
24       bool doFlip, bool enableDisable, const messageInfo &msgInfo, myCallback
25       &callback);
26

USAGE

28       This  is  a  version  of  mail::account::saveFolderIndexInfo(3x)   that
29       updates the status of multiple messages with one request.
30
31       msgList  specifies  a list of messages.  Messages are numbered starting
32       with message #0 and up to one less than  mail::account::getFolderIndex‐
33       Size(3x)()  (when mail::account::getFolderIndexSize returns 6, the mes‐
34       sages are numbered 0 through 5).  Only  the  messages  that  appear  in
35       msgList are processed by this request.
36
37       msgInfo  selects  which message status flags should be updated in every
38       message.  See mail::account::getFolderIndexInfo(3x).
39
40       msgInfo does NOT specify the new value of the status flags, only  which
41       status flags should be updated.  For example, setting msgInfo.marked to
42       true indicates that the messages' marked status flag will be set to the
43       value specified by doFlip and enableDisable.
44
45       Setting  doFlip  to  true  "flips" the selected status flags (each mes‐
46       sage's flag will be set to false if  the  status  flag  was  originally
47       true, and set to true if the status flag was originalfalse).  If doFlip
48       is false, then the selected status  flags  are  set  to  the  value  of
49       enableDisable enableDisable is ignored when Setting doFlip is true.
50

RETURN CODES

52       The  application  must  wait until callback's success or fail method is
53       invoked.  The success method is invoked when this  request  is  succes‐
54       fully  processed.  The fail method is invoked if this request cannot be
55       processed.  The application must not destroy callback until either  the
56       success or fail method is invoked.
57
58              Note:  callback's  fail  method  may be invoked even after other
59              callback methods were invoked.  This indicates that the  request
60              was partially completed before the error was encountered.
61
62              Note:  The application is notified about when a message's status
63              changes by by invoking the messageChanged callback method of the
64              currently  opened folder's mail::folderCallback object.  Depend‐
65              ing on the mail server, the messageChanged method may be invoked
66              as  part  of  processing  this request, or some time later after
67              this request is completed, and  callback's  success  method  was
68              invoked.
69
70              Note: Multiple applications may have the same account and folder
71              opened at the same time.  It is possible that a  message  refer‐
72              enced  by  this  request was already deleted by another applica‐
73              tion.  Depending on the underlying  server  implementation  this
74              will  result in either a failed request, invoking callback.fail,
75              or the request completing (callback.success invoked) but without
76              invoking any callback function that refer to the message.
77

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO