mail::ACCOUNT::getMessageEnvelope(3x)

1MAIL::ACCOUNT::GETME(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::GETME(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       bool ok=mail->getMessageEnvelope(const std::vector<size_t> &msgList,
16                                        std::vector<mail::xenvelope> &envelopes);
17
18                                        std::string errmsg=mail->getErrmsg();
19
20       mail::xenvelope myEnvelope=mail->getMessageEnvelope(size_t messageNum);
21

USAGE

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

RETURN CODES

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

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO