mail::account::updateFolderIndexFlags(3x)

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

NAME

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

USAGE

27       This is a version of mail::account::saveFolderIndexInfo(3x) that
28       updates the status of multiple messages with one request.
29
30       msgList specifies a list of messages. Messages are numbered starting
31       with message #0 and up to one less than
32       mail::account::getFolderIndexSize(3x)() (when
33       mail::account::getFolderIndexSize returns 6, the messages are numbered
34       0 through 5). Only the messages that appear in msgList are processed by
35       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
46       message´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 succesfully
54       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
59           callback´s fail method may be invoked even after other callback
60           methods were invoked. This indicates that the request was partially
61           completed before the error was encountered.
62
63           Note
64           The application is notified about when a message´s status changes
65           by by invoking the messageChanged callback method of the currently
66           opened folder´s mail::folderCallback object. Depending on the mail
67           server, the messageChanged method may be invoked as part of
68           processing this request, or some time later after this request is
69           completed, and callback´s success method was invoked.
70
71           Note
72           Multiple applications may have the same account and folder opened
73           at the same time. It is possible that a message referenced by this
74           request was already deleted by another application. Depending on
75           the underlying server implementation this will result in either a
76           failed request, invoking callback.fail, or the request completing
77           (callback.success invoked) but without invoking any callback
78           function that refer to the message.
79

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO