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

NAME

6       mail::ACCOUNT::getMessageStructure - Return message MIME structure
7

SYNOPSIS

9       #include <libmail/sync.H>
10
11       #include <libmail/structure.H>
12
13       mail::ACCOUNT *mail;
14
15       bool ok=mail->getMessageStructure(const std::vector<size_t> &msgList,
16                                         std::vector<mail::mimestruct> &structures);
17
18                                         std::string errmsg=mail->getErrmsg();
19
20       mail::mimestruct
21                                                               myMimeStruct=mail->getMessageStructure(size_t messageNum);
22

USAGE

24       msgList specifies a list of messages. Messages are numbered starting
25       with message #0 and up to one less than
26       mail::ACCOUNT::getFolderIndexSize(3x) (when
27       mail::account::getFolderIndexSize returns 6, the messages are numbered
28       0 through 5). Only the messages that appear in msgList are processed by
29       this request. When a message is removed from the folder, by
30       mail::ACCOUNT::updateFolderIndexInfo(3x), the following messages are
31       renumbered accordingly.
32
33           Note
34           Most mail servers allow multiple applications to open the same
35           folder. Therefore, changes to the folder´s contents can occur at
36           any time. Before making this request, the application should use
37           mail::ACCOUNT::checkNewMail(3x) to verify that no unexpected
38           changes have been made to the folder´s contents.
39
40       This function returns the MIME structure information of each message
41       specified by msgList. This function initializes the structures array to
42       the same size as msgList, with each array member containing the MIME
43       structure for the corresponding message in msgList.
44

RETURN CODES

46       This method returns true if it succeeds, or false if it fails. If the
47       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
48       description of the error.
49
50       The second version of mail::ACCOUNT::getMessageStructure returns the
51       MIME structure of a single message, ignoring any error condition (a
52       failure results in the returned mail::mimestruct object being
53       completely empty).
54

SEE ALSO

56       mail::mimestruct(3x), mail::ACCOUNT::getFolderIndexInfo(3x),
57       mail::ACCOUNT::getFolderIndexSize(3x).
58
59
60
61[FIXME: source]                   05/08/2010          MAIL::ACCOUNT::GETME(3x)
Impressum