mail::ACCOUNT::getFolderIndexInfo(3x)

1mail::ACCOUNT::getFolmdaeirlI:n:dAeCxCIOnUfNoT(3Sxy)nchronmoauisl:A:PAICCrOeUfNeTr:e:ngceetFolderIndexInfo(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
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.  Appli‐
28              cations  should  consider  this unique ID as a completely opaque
29              string, with no particular interpretation.  The only  assumption
30              that  applications  may  make  is that no two messages will ever
31              have the same uid in the  same  folder.   A  message  copied  to
32              another  folder will receive a different unique ID in the desti‐
33              nation folder (the 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
52              in the folder.
53
54              Note:  This message flag is considered obsolete, and should only
55              be used by IMAP-based clients that absolutely  need  this  flag.
56              Applications  that absolutely require this flag should be evalu‐
57              ated for correctness, since  the  IMAP  specification  indicates
58              that  this flag's setting is not defined in situations where the
59              same mail folder is opened by multiple applications at the  same
60              time.   Since this is nearly always the case, it seems that this
61              flag's usability is rather limited.  For this reason, the recent
62              flag  was  not  reimplemented  in  SMAP, and will not be set for
63              accounts that are accessed via SMAP.
64
65              Note: Not all types of mail accounts support every message  sta‐
66              tus  flag.   Unsupported  message status flags will be automati‐
67              cally  emulated,  where  possible.   Specifically,   POP3   mail
68              accounts  do  not have a concept of message status flags at all.
69              Each time a POP3 mail account is opened, the status of all  mes‐
70              sages  in  the  POP3 account will be reset to the default status
71              (unread message, no other flags set).
72

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO