<html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/> <title>mail::ACCOUNT::readFolderInfo</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-openfolder.html" title="mail::ACCOUNT::openFolder"/> <link rel="next" href="account-removemessages.html" title="mail::ACCOUNT::removeMessages"/> <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::readFolderInfo</th> </tr> <tr> <td width="20%" align="left" rowspan="1" colspan="1"> <a accesskey="p" href="account-openfolder.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-removemessages.html" shape="rect">Next</a></td> </tr> </table> <hr/> </div> <div class="refentry" lang="en" xml:lang="en"> <a id="account-readfolderinfo" shape="rect" name="account-readfolderinfo"> </a> <div class="titlepage"/> <div class="refnamediv"> <h2>Name</h2> <p>mail::ACCOUNT::readFolderInfo — Get folder status</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"/></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">openFolder</b>(</code></td> <td rowspan="1" colspan="1">const mail::folder * </td> <td rowspan="1" colspan="1"><var class="pdparam">folder</var>,</td> </tr> <tr> <td rowspan="1" colspan="1"> </td> <td rowspan="1" colspan="1">mail::ACCOUNT::FolderInfo & </td> <td rowspan="1" colspan="1"><var class="pdparam">info</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> <div class="refsect1" lang="en" xml:lang="en"> <a id="id571008" shape="rect" name="id571008"> </a> <h2>USAGE</h2> <p>This function reads the current status of <em class="parameter"><code>folder</code></em>, which may refer to any folder in the mail account (not necessarily the currently open folder).</p> <p>The following fields in <em class="parameter"><code>info</code></em> will be initialized by this function:</p> <div class="variablelist"> <dl> <dt><span class="term">messageCount</span></dt> <dd> <p>Total number of messages in the folder.</p> </dd> <dt><span class="term">unreadCount</span></dt> <dd> <p>Total number of unread messages in the folder.</p> </dd> <dt><span class="term">fastInfo</span></dt> <dd> <p>This field should be initialized before calling this function. If set to <code class="literal">true</code> the message counts are returned only if they can be computed quickly. Otherwise <em class="parameter"><code>folderInfoCallback</code></em>'s <code class="function">success</code> method will not be invoked at all, but <em class="parameter"><code>callback</code></em>'s <code class="function">success</code> method will still be invoked.</p> <p>If this field is set to <code class="literal">false</code> (the default), the message counts are returned in all cases.</p> </dd> </dl> </div> </div> <div class="refsect1" lang="en" xml:lang="en"> <a id="id571092" shape="rect" name="id571092"> </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="id571127" shape="rect" name="id571127"> </a> <h2>SEE ALSO</h2> <p><a class="link" href="account-openfolder.html" title="mail::ACCOUNT::openFolder" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::openFolder</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-openfolder.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-removemessages.html" shape="rect">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::openFolder </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::removeMessages</td> </tr> </table> </div> </body> </html>