1mail::ACCOUNT::getMesmsaaigle:S:tArCuCcOtUuNrTe(S3yxn)chromnaoiuls::AAPCICOrUeNfTe:r:egnecteMessageStructure(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
16
17       bool  ok=mail->getMessageStructure (const std::vector<size_t> &msgList,
18       std::vector<mail::mimestruct> &structures);
19
20       std::string errmsg=mail->getErrmsg();
21
22
23
24       mail::mimestruct  myMimeStruct=mail->getMessageStructure  (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  returns  the MIME structure information of each message
43       specified by msgList.  This function initializes the  structures  array
44       to the same size as msgList, with each array member containing the MIME
45       structure for the corresponding message in msgList.
46

RETURN CODES

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

SEE ALSO

58       mail::mimestruct(3x),            mail::ACCOUNT::getFolderIndexInfo(3x),
59       mail::ACCOUNT::getFolderIndexSize(3x).
60
61
62
63                                 10 Aprilma2i0l0:6:ACCOUNT::getMessageStructure(3x)
Impressum