<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::ACCOUNT::getTopLevelFolders</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-getsubfolders.html" title="mail::ACCOUNT::getSubFolders"/>
<link rel="next" href="account-login.html" title="mail::ACCOUNT::login"/>
<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::getTopLevelFolders</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-getsubfolders.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-login.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" lang="en" xml:lang="en">
<a id="account-gettoplevelfolders" shape="rect" name="account-gettoplevelfolders"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::ACCOUNT::getTopLevelFolders — Enumerate
top-level folders</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"/>
mail::ACCOUNT *mail;<br clear="none"/>
mail::ACCOUNT::FolderList folderList;<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">getTopLevelFolders</b>(</code></td>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1"><var class="pdparam">folderList</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="literallayout">
<p><br clear="none"/>
size_t nFolders=folderList::size();<br clear="none"/>
const mail::folder *folder=folderList[n];<br clear="none"/>
</p>
</div>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id568427" shape="rect" name="id568427"> </a>
<h2>USAGE</h2>
<p>A mail account contains a collection of folders, arranged
in a top-to-bottom hierarchy. This function returns the list
of the folders at the top-level of the folder hierarchy.</p>
<p><code class="function">mail::ACCOUNT::getTopLevelFolders</code>, if
succesful, initializes a list of <span class="structname">mail::folder</span> objects, which are
maintained by the <span class="structname">mail::ACCOUNT::FolderList</span> class. Each
<span class="structname">mail::folder</span> object
represents a mail account's folder. The number of folders,
and a pointer to each folder object, is obtained according to
the example above.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>Pointers to <span class="structname">mail::folder</span>
objects are no longer valid after the <span class="structname">mail::ACCOUNT::FolderList</span> object is
destroyed. The application should use <a class="link" href="folder-clone.html" title="mail::folder::clone" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::folder::clone</span>(3x)</span></a>
to create a duplicate copy of the <span class="structname">mail::folder</span> object (which the
application is now responsible for destroying).</p>
</div>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id568493" shape="rect" name="id568493"> </a>
<h2>RETURN CODES AND CALLBACKS</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>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id568529" shape="rect" name="id568529"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="account-login.html" title="mail::ACCOUNT::login" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::login</span>(3x)</span></a>,
<a class="link" href="account-getsubfolders.html" title="mail::ACCOUNT::getSubFolders" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getSubFolders</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-getsubfolders.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-login.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::getSubFolders </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::login</td>
</tr>
</table>
</div>
</body>
</html>
