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

NAME

8       mail::ACCOUNT::getFolderIndexInfo - Return message status
9

SYNOPSIS

11       #include <libmail/sync.H>
12
13       mail::ACCOUNT *mail;
14
15       mail::messageInfo msgInfo=mail->getFolderIndexSize(size_t messageNum);
16

USAGE

18       mail::ACCOUNT::getFolderIndexInfo returns a structure that contains a
19       message's unique identifier, and the message's current status flags.
20       messageNum must be between zero and one less than the return code from
21       mail::ACCOUNT::getFolderIndexSize(3x).
22

RETURN CODES AND CALLBACKS

24       This function returns an object with the following fields:
25
26       std::string uid
27           A unique ID that's assigned to each message in a folder.
28           Applications should consider this unique ID as a completely opaque
29           string, with no particular interpretation. The only assumption that
30           applications may make is that no two messages will ever have the
31           same uid in the same folder. A message copied to another folder
32           will receive a different unique ID in the destination folder (the
33           copy in the original folder is not affected).
34
35       bool draft
36           This is a draft message.
37
38       bool replied
39           A reply was previously sent to this message.
40
41       bool marked
42           This message is marked for further processing.
43
44       bool deleted
45           This message is marked for deletion.
46
47       bool unread
48           The contents of this message have not been read.
49
50       bool recent
51           This is the first time the folder was opened with this message in
52           the folder.
53
54               Note
55               This message flag is considered obsolete, and should only be
56               used by IMAP-based clients that absolutely need this flag.
57               Applications that absolutely require this flag should be
58               evaluated for correctness, since the IMAP specification
59               indicates that this flag's setting is not defined in situations
60               where the same mail folder is opened by multiple applications
61               at the same time. Since this is nearly always the case, it
62               seems that this flag's usability is rather limited. For this
63               reason, the recent flag was not reimplemented in SMAP, and will
64               not be set for accounts that are accessed via SMAP.
65
66           Note
67           Not all types of mail accounts support every message status flag.
68           Unsupported message status flags will be automatically emulated,
69           where possible. Specifically, POP3 mail accounts do not have a
70           concept of message status flags at all. Each time a POP3 mail
71           account is opened, the status of all messages in the POP3 account
72           will be reset to the default status (unread message, no other flags
73           set).
74

SEE ALSO

76       mail::ACCOUNT::getFolderIndexSize(3x),
77       mail::ACCOUNT::getFolderKeywordInfo(3x),
78       mail::ACCOUNT::getMessageEnvelope(3x),
79       mail::ACCOUNT::getMessageStructure(3x), mail::ACCOUNT::getMyRights(3x).
80

AUTHOR

82       Sam Varshavchik
83
84
85
86Cone©                             08/25/2016          MAIL::ACCOUNT::GETFO(3x)
Impressum