mail::ACCOUNT::getFolderIndexInfo(3x)

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

NAME

6       mail::ACCOUNT::getFolderIndexInfo - Return message status
7

SYNOPSIS

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

USAGE

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

RETURN CODES AND CALLBACKS

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

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO