<refentry id="camel-CamelImapSummary">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelImapSummary.top_of_page">CamelImapSummary</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CamelImapSummary</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="camel-CamelImapSummary.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
#define             <link linkend="CAMEL-IMAP-SERVER-FLAGS:CAPS">CAMEL_IMAP_SERVER_FLAGS</link>
                    <link linkend="CamelImapMessageContentInfo">CamelImapMessageContentInfo</link>;
                    <link linkend="CamelImapMessageInfo">CamelImapMessageInfo</link>;
struct              <link linkend="CamelImapSummary">CamelImapSummary</link>;
<link linkend="CamelFolderSummary">CamelFolderSummary</link>* <link linkend="camel-imap-summary-new">camel_imap_summary_new</link>              (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder,
                                                         const <link linkend="char">char</link> *filename);
<link linkend="void">void</link>                <link linkend="camel-imap-summary-add-offline">camel_imap_summary_add_offline</link>      (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
                                                         const <link linkend="char">char</link> *uid,
                                                         <link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);
<link linkend="void">void</link>                <link linkend="camel-imap-summary-add-offline-uncached">camel_imap_summary_add_offline_uncached</link>
                                                        (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);
</synopsis>
</refsynopsisdiv>









<refsect1 id="camel-CamelImapSummary.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="camel-CamelImapSummary.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CAMEL-IMAP-SERVER-FLAGS:CAPS" role="macro">
<title>CAMEL_IMAP_SERVER_FLAGS</title>
<indexterm zone="CAMEL-IMAP-SERVER-FLAGS:CAPS"><primary>CAMEL_IMAP_SERVER_FLAGS</primary></indexterm><programlisting>#define             CAMEL_IMAP_SERVER_FLAGS</programlisting>
<para>

</para></refsect2>
<refsect2 id="CamelImapMessageContentInfo" role="struct">
<title>CamelImapMessageContentInfo</title>
<indexterm zone="CamelImapMessageContentInfo"><primary>CamelImapMessageContentInfo</primary></indexterm><programlisting>typedef struct {
	CamelMessageContentInfo info;
} CamelImapMessageContentInfo;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CamelImapMessageInfo" role="struct">
<title>CamelImapMessageInfo</title>
<indexterm zone="CamelImapMessageInfo"><primary>CamelImapMessageInfo</primary></indexterm><programlisting>typedef struct {
	CamelMessageInfoBase info;

	guint32 server_flags;
} CamelImapMessageInfo;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CamelImapSummary" role="struct">
<title>struct CamelImapSummary</title>
<indexterm zone="CamelImapSummary"><primary>CamelImapSummary</primary></indexterm><programlisting>struct CamelImapSummary {
	CamelFolderSummary parent;

	guint32 version;
	guint32 validity;
};
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-imap-summary-new" role="function">
<title>camel_imap_summary_new ()</title>
<indexterm zone="camel-imap-summary-new"><primary>camel_imap_summary_new</primary></indexterm><programlisting><link linkend="CamelFolderSummary">CamelFolderSummary</link>* camel_imap_summary_new              (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder,
                                                         const <link linkend="char">char</link> *filename);</programlisting>
<para>
This will create a new CamelImapSummary object and read in the
summary data from disk, if it exists.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>folder</parameter>&nbsp;:</term>
<listitem><simpara> Parent folder.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> the file to store the summary in.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new CamelImapSummary object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-summary-add-offline" role="function">
<title>camel_imap_summary_add_offline ()</title>
<indexterm zone="camel-imap-summary-add-offline"><primary>camel_imap_summary_add_offline</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imap_summary_add_offline      (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
                                                         const <link linkend="char">char</link> *uid,
                                                         <link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-summary-add-offline-uncached" role="function">
<title>camel_imap_summary_add_offline_uncached ()</title>
<indexterm zone="camel-imap-summary-add-offline-uncached"><primary>camel_imap_summary_add_offline_uncached</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imap_summary_add_offline_uncached
                                                        (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
