1        Cone©
2
3MAIL::ACCOUNT::GETME(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::GETME(3x)
4
5
6

NAME

8       mail::ACCOUNT::getMessageEnvelope - Return message header envelope
9

SYNOPSIS

11       #include <libmail/sync.H>
12
13       #include <libmail/envelope.H>
14
15       mail::ACCOUNT *mail;
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       mail::xenvelope myEnvelope=mail->getMessageEnvelope(size_t messageNum);
23

USAGE

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

RETURN CODES

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

SEE ALSO

71       mail::envelope(3x), mail::ACCOUNT::getFolderIndexInfo(3x),
72       mail::ACCOUNT::getFolderIndexSize(3x).
73

AUTHOR

75       Sam Varshavchik
76
77
78
79Cone©                             08/25/2016          MAIL::ACCOUNT::GETME(3x)
Impressum