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/sync.H>
11
12       mail::ACCOUNT *mail;
13
14       bool ok=mail->updateFolderIndexFlags(const std::vector<size_t> msgList,
15                                            bool doFlip, bool enableDisable,
16                                            const messageInfo &msgInfo);
17
18                                            std::string errmsg=mail->getErrmsg();
19

USAGE

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

RETURN CODES

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

SEE ALSO

60       mail::ACCOUNT::saveFolderIndexInfo(3x),
61       mail::ACCOUNT::getFolderIndexInfo(3x).
62
63
64
65[FIXME: source]                   05/08/2010          MAIL::ACCOUNT::UPDAT(3x)
Impressum