mail::account::getFolderIndexInfo(3x)

1mail::account::getFoldemraIinld:e:xaIcncfoou(n3tx)NativemaAiPlI::raecfceoruenntc:e:getFolderIndexInfo(3x)
2
3
4

NAME

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

SYNOPSIS

9       #include <libmail/mail.H>
10
11
12       mail::account *account;
13
14
15
16       mail::messageInfo   msgInfo=account->getFolderIndexInfo   (size_t  mes‐
17       sageNum);
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.  Appli‐
30              cations should consider this unique ID as  a  completely  opaque
31              string,  with no particular interpretation.  The only assumption
32              that applications may make is that no  two  messages  will  ever
33              have  the  same  uid  in  the  same folder.  A message copied to
34              another folder will receive a different unique ID in the  desti‐
35              nation folder (the 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
54              in the folder.
55
56              Note: This message flag is considered obsolete, and should  only
57              be  used  by  IMAP-based clients that absolutely need this flag.
58              Applications that absolutely require this flag should be  evalu‐
59              ated  for  correctness,  since  the IMAP specification indicates
60              that this flag's setting is not defined in situations where  the
61              same  mail folder is opened by multiple applications at the same
62              time.  Since this is nearly always the case, it seems that  this
63              flag's usability is rather limited.  For this reason, the recent
64              flag was not reimplemented in SMAP, and  will  not  be  set  for
65              accounts that are accessed via SMAP.
66
67              Note:  Not all types of mail accounts support every message sta‐
68              tus flag.  Unsupported message status flags  will  be  automati‐
69              cally   emulated,   where  possible.   Specifically,  POP3  mail
70              accounts do not have a concept of message status flags  at  all.
71              Each  time a POP3 mail account is opened, the status of all mes‐
72              sages in the POP3 account will be reset to  the  default  status
73              (unread message, no other flags set).
74

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO