<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::ACCOUNT::getMessageStructure</title>
<link rel="stylesheet" href="manpage.css" type="text/css"/>
<link rel="start" href="index.html" title="Cone: COnsole Newsreader And Emailer"/>
<link rel="up" href="synchronous.html" title="mail::ACCOUNT Synchronous API reference"/>
<link rel="prev" href="account-getmessageenvelope.html" title="mail::ACCOUNT::getMessageEnvelope"/>
<link rel="next" href="account-getmyrights.html" title="mail::ACCOUNT::getMyRights"/>
<link xmlns="" rel="icon" href="icon.gif" type="image/gif"/>
<meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/>
<!--
Copyright 2002 - 2007 Double Precision, Inc. See COPYING for distribution
information.
-->
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center" rowspan="1">
mail::ACCOUNT::getMessageStructure</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-getmessageenvelope.html" shape="rect">Prev</a> </td>
<th width="60%" align="center" rowspan="1" colspan="1">
<span class="structname">mail::ACCOUNT</span> Synchronous
API reference</th>
<td width="20%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="account-getmyrights.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" lang="en" xml:lang="en">
<a id="account-getmessagestructure" shape="rect" name="account-getmessagestructure"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::ACCOUNT::getMessageStructure — Return message
MIME structure</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="literallayout">
<p><br clear="none"/>
<br clear="none"/>
<br clear="none"/>
<br clear="none"/>
#include <libmail/sync.H><br clear="none"/>
<br clear="none"/>
#include <libmail/structure.H><br clear="none"/>
<br clear="none"/>
mail::ACCOUNT *mail;<br clear="none"/></p>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">bool
ok=mail-><b class="fsfunc">getMessageStructure</b>(</code></td>
<td rowspan="1" colspan="1">const
std::vector<size_t> & </td>
<td rowspan="1" colspan="1"><var class="pdparam">msgList</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">
std::vector<mail::mimestruct> & </td>
<td rowspan="1" colspan="1"><var class="pdparam">structures</var><code>)</code>;</td>
</tr>
</table>
</div>
<div class="literallayout">
<p><br clear="none"/>
std::string errmsg=mail->getErrmsg();<br clear="none"/></p>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">mail::mimestruct
myMimeStruct=mail-><b class="fsfunc">getMessageStructure</b>(</code></td>
<td rowspan="1" colspan="1">size_t  </td>
<td rowspan="1" colspan="1"><var class="pdparam">messageNum</var><code>)</code>;</td>
</tr>
</table>
</div>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id563844" shape="rect" name="id563844"> </a>
<h2>USAGE</h2>
<p><em class="parameter"><code>msgList</code></em> specifies
a list of messages. Messages are numbered starting with
message #0 and up to one less than <a class="link" href="account-getfolderindexsize.html" title="mail::ACCOUNT::getFolderIndexSize" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexSize</span>(3x)</span></a>
(when <code class="function">mail::account::getFolderIndexSize</code> returns
6, the messages are numbered 0 through 5). Only the messages
that appear in <em class="parameter"><code>msgList</code></em> are processed by this
request. When a message is removed from the folder, by
<a class="link" href="account-updatefolderindexinfo.html" title="mail::ACCOUNT::updateFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::updateFolderIndexInfo</span>(3x)</span></a>,
the following messages are renumbered accordingly.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>Most mail servers allow multiple applications to open
the same folder. Therefore, changes to the folder's
contents can occur at any time. Before making this request,
the application should use <a class="link" href="account-checknewmail.html" title="mail::ACCOUNT::checkNewMail" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::checkNewMail</span>(3x)</span></a>
to verify that no unexpected changes have been made to the
folder's contents.</p>
</div>
<p>This function returns the MIME structure information of
each message specified by <em class="parameter"><code>msgList</code></em>. This function
initializes the <em class="parameter"><code>structures</code></em> array to the same
size as <em class="parameter"><code>msgList</code></em>, with
each array member containing the MIME structure for the
corresponding message in <em class="parameter"><code>msgList</code></em>.</p>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id563962" shape="rect" name="id563962"> </a>
<h2>Return Codes</h2>
<p>This method returns <code class="literal">true</code> if
it succeeds, or <code class="literal">false</code> if it
fails. If the method fails, use <em class="structfield"><code>mail::ACCOUNT::getErrmsg()</code></em> to
read a brief description of the error.</p>
<p>The second version of <code class="function">mail::ACCOUNT::getMessageStructure</code> returns
the MIME structure of a single message, ignoring any error
condition (a failure results in the returned <span class="structname">mail::mimestruct</span> object being completely
empty).</p>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id564012" shape="rect" name="id564012"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="mimestruct.html" title="mail::mimestruct" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::mimestruct</span>(3x)</span></a>,
<a class="link" href="account-getfolderindexinfo.html" title="mail::ACCOUNT::getFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexInfo</span>(3x)</span></a>,
<a class="link" href="account-getfolderindexsize.html" title="mail::ACCOUNT::getFolderIndexSize" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexSize</span>(3x)</span></a>.</p>
</div>
</div>
<div class="navfooter">
<hr/>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-getmessageenvelope.html" shape="rect">Prev</a> </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="u" href="synchronous.html" shape="rect">Up</a></td>
<td width="40%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="account-getmyrights.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::getMessageEnvelope </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="h" href="index.html" shape="rect">Home</a> | <a accesskey="t" href="bk01-toc.html" shape="rect">ToC</a></td>
<td width="40%" align="right" valign="top" rowspan="1" colspan="1"> mail::ACCOUNT::getMyRights</td>
</tr>
</table>
</div>
</body>
</html>
