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

NAME

8       mail::ACCOUNT::updateFolderIndexFlags - Update status of multiple
9       messages
10

SYNOPSIS

12       #include <libmail/sync.H>
13
14       mail::ACCOUNT *mail;
15
16       bool ok=mail->updateFolderIndexFlags(const std::vector<size_t> msgList,
17                                            bool doFlip, bool enableDisable,
18                                            const messageInfo &msgInfo);
19
20                                            std::string errmsg=mail->getErrmsg();
21

USAGE

23       This is a version of mail::ACCOUNT::saveFolderIndexInfo(3x) that
24       updates the status of multiple messages with one request.
25
26       msgList specifies a list of messages. Messages are numbered starting
27       with message #0 and up to one less than
28       mail::ACCOUNT::getFolderIndexSize(3x) (when
29       mail::account::getFolderIndexSize returns 6, the messages are numbered
30       0 through 5). Only the messages that appear in msgList are processed by
31       this request. When a message is removed from the folder, by
32       mail::ACCOUNT::updateFolderIndexInfo(3x), the following messages are
33       renumbered accordingly.
34
35           Note
36           Most mail servers allow multiple applications to open the same
37           folder. Therefore, changes to the folder's contents can occur at
38           any time. Before making this request, the application should use
39           mail::ACCOUNT::checkNewMail(3x) to verify that no unexpected
40           changes have been made to the folder's contents.
41
42       msgInfo selects which message status flags should be updated in every
43       message. See mail::ACCOUNT::getFolderIndexInfo(3x).
44
45       msgInfo does NOT specify the new value of the status flags, only which
46       status flags should be updated. For example, setting msgInfo.marked to
47       true indicates that the messages' marked status flag will be set to the
48       value specified by doFlip and enableDisable.
49
50       Setting doFlip to true "flips" the selected status flags (each
51       message's flag will be set to false if the status flag was originally
52       true, and set to true if the status flag was originalfalse). If doFlip
53       is false, then the selected status flags are set to the value of
54       enableDisableenableDisable is ignored when Setting doFlip is true.
55

RETURN CODES

57       This method returns true if it succeeds, or false if it fails. If the
58       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
59       description of the error.
60

SEE ALSO

62       mail::ACCOUNT::saveFolderIndexInfo(3x),
63       mail::ACCOUNT::getFolderIndexInfo(3x).
64

AUTHOR

66       Sam Varshavchik
67
68
69
70Cone©                             08/25/2016          MAIL::ACCOUNT::UPDAT(3x)
Impressum