mail::ACCOUNT::updateKeywords(3x)

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

NAME

6       mail::ACCOUNT::updateKeywords - Update message keywords
7

SYNOPSIS

9       #include <libmail/sync.H>
10
11       mail::ACCOUNT *mail;
12
13       bool ok=mail->updateKeywords(const std::vector<size_t> msgList,
14                                    const std::set<std::string> &keywords,
15                                    bool setOrChange, bool changeTo);
16
17       bool ok=mail->updateKeywords(const std::vector<size_t> msgList,
18                                    const std::list<std::string> &keywords,
19                                    bool setOrChange, bool changeTo);
20
21       bool ok=mail->updateKeywords(const std::vector<size_t> msgList,
22                                    const std::vector<std::string> &keywords,
23                                    bool setOrChange, bool changeTo);
24

USAGE

26       This function updates the set of keywords of one or more messages.
27       keywords may also be specified as a list, or a vector (and duplicate
28       occurences of a keyword are automatically removed).
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. When a message is removed from the folder, by
36       mail::ACCOUNT::updateFolderIndexInfo(3x), the following messages are
37       renumbered accordingly.
38
39           Note
40           Most mail servers allow multiple applications to open the same
41           folder. Therefore, changes to the folder´s contents can occur at
42           any time. Before making this request, the application should use
43           mail::ACCOUNT::checkNewMail(3x) to verify that no unexpected
44           changes have been made to the folder´s contents.
45
46       When setOrChange is false, changeTo is ignored, and any existing
47       keywords set for each message in msgList are completely replaced by
48       keywords. When setOrChange is true changeTo selects whether keywords
49       are added to the existing set of keywords that are already set for each
50       message (changeTo is true), or removed from the existing set of
51       keywords (changeTo is false).
52
53   Keywords
54       Keywords are application-defined flags, or markers, that are associated
55       which each message in a folder. Keywords names are arbitrary, and are
56       subject to certain restrictions.
57
58
59
60       LibMAIL does not place any special meaning on any particular keyword
61       name.
62
63
64
65       LibMAIL ´s sole involvement is to store the save the list of keywords
66       set for a given message, and then retrieve it upon demand.
67
68       Which characters may be included in a keyword name depends on the
69       underlying account type. Applications that expect to use any supported
70       account type should limit themselves to the lowest common denominator:
71       case insensitive us-ascii character set; no whitespace or any of the
72       following characters: commas; apostrophes; quotes; backslashes; forward
73       slashes; opening/closing braces, brackets, and parenthesis; question
74       marks; asterisks; percent signs. In all cases, keyword names may not
75       include any control characters. Unless keywords are permanently saved,
76       and remain available after the folder is closed, and subsequently
77       reopened. When the folder is reopened at some point later, all keywords
78       will remain set for their corresponding messages (unless they were
79       modified by another process).
80
81       ·   Temporary folders do not implement keywords.
82
83       ·   IMAP accounts have case-insensitive keywords in the us-ascii
84           character set. Keyword names may not contain: apostrophes; quotes;
85           backslashes; forward slashes; opening/closing braces, brackets, and
86           parenthesis; question marks; asterisks; and percent signs.
87
88       ·    SMAP accounts have case-sensitive keywords that use the UTF-8
89           character set. Keyword names may not contain commas.
90
91               Note
92               IMAP restrictions also apply if the same account is accessible
93               via IMAP.
94
95       ·   Maildir accounts have case-sensitive keywords that use the UTF-8
96           character set.
97
98               Note
99               IMAP and/or SMAP restrictions also apply if the maildir is also
100               accessible via IMAP or SMAP.
101
102       ·   Mbox accounts have case-sensitive keywords that use the UTF-8
103           character set.
104
105       ·   NNTP and POP3 accounts have case-sensitive keywords that use the
106           UTF-8 character set. Keywords are not saved. When the folder is
107           closed, all set keywords are lost. Snapshots may be used to obtain
108           permanent keyword storage for NNTP and POP3 accounts. See
109           mail::folder::open(3x) for more information.
110

RETURN CODES

112       This method returns true if it succeeds, or false if it fails. If the
113       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
114       description of the error.
115

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO