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/mail.H>
12
13
14       mail::account *account;
15
16       mail::messageInfo
17                                                             msgInfo=account->getFolderIndexInfo(size_t messageNum);
18

USAGE

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

RETURN CODES

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

SEE ALSO

78       mail::account::readMessageAttributes(3x),
79       mail::account::getFolderIndexSize(3x), mail::folder::getMyRights(3x).
80

AUTHOR

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