1mail::ACCOUNT::getMesmsaaigle:E:nAvCeClOoUpNeT(3Sxy)nchronmoauisl:A:PAICCrOeUfNeTr:e:ngceetMessageEnvelope(3x)
2
3
4

NAME

6       mail::ACCOUNT::getMessageEnvelope - Return message header envelope
7

SYNOPSIS

9       #include <libmail/sync.H>
10
11       #include <libmail/envelope.H>
12
13       mail::ACCOUNT *mail;
14
15
16
17       bool  ok=mail->getMessageEnvelope  (const std::vector<size_t> &msgList,
18       std::vector<mail::xenvelope> &envelopes);
19
20       std::string errmsg=mail->getErrmsg();
21
22
23
24       mail::xenvelope   myEnvelope=mail->getMessageEnvelope   (size_t    mes‐
25       sageNum);
26

USAGE

28       msgList  specifies  a list of messages.  Messages are numbered starting
29       with message #0 and up to one less than  mail::ACCOUNT::getFolderIndex‐
30       Size(3x)  (when  mail::account::getFolderIndexSize  returns 6, the mes‐
31       sages are numbered 0 through 5).  Only  the  messages  that  appear  in
32       msgList  are processed by this request.  When a message is removed from
33       the folder, by mail::ACCOUNT::updateFolderIndexInfo(3x), the  following
34       messages are renumbered accordingly.
35
36              Note:  Most mail servers allow multiple applications to open the
37              same folder.  Therefore, changes to the  folder's  contents  can
38              occur  at any time.  Before making this request, the application
39              should use mail::ACCOUNT::checkNewMail(3x)  to  verify  that  no
40              unexpected changes have been made to the folder's contents.
41
42       This  function  reads  the  message envelope header information of each
43       message specified by msgList.  This function initializes the  envelopes
44       array  to  the  same size as msgList, with each array member containing
45       the envelope  header  information  for  the  corresponding  message  in
46       msgList.
47
48   MAIL::XENVELOPE
49       The mail::xenvelope structure is a subclass of mail::envelope(3x), with
50       two additional fields:
51
52       time_t arrivalDate
53              When this message was received by the mail server (or 0  if  the
54              time cannot be determined).
55
56       unsigned long messageSize
57              The approximate size of the message, in bytes.  This size should
58              be considered as an estimated only, and the actual size  may  be
59              slightly higher or lower.
60

RETURN CODES

62       This  method returns true if it succeeds, or false if it fails.  If the
63       method fails, use mail::ACCOUNT::getErrmsg() to read a  brief  descrip‐
64       tion of the error.
65
66       The  second  version  of  mail::ACCOUNT::getMessageEnvelope returns the
67       envelope information of a single message, ignoring any error  condition
68       (a  failure  results  in the returned mail::xenvelope object being com‐
69       pletely empty).
70

SEE ALSO

72       mail::envelope(3x),              mail::ACCOUNT::getFolderIndexInfo(3x),
73       mail::ACCOUNT::getFolderIndexSize(3x).
74
75
76
77                                 10 Aprilm2a0i0l6::ACCOUNT::getMessageEnvelope(3x)
Impressum