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

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

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

<synopsis>
#define             <link linkend="STATUS-PINE:CAPS">STATUS_PINE</link>
                    <link linkend="CamelMboxSummary">CamelMboxSummary</link>;
                    <link linkend="CamelMboxMessageContentInfo">CamelMboxMessageContentInfo</link>;
                    <link linkend="CamelMboxMessageInfo">CamelMboxMessageInfo</link>;
<link linkend="CamelMboxSummary">CamelMboxSummary</link>*   <link linkend="camel-mbox-summary-new">camel_mbox_summary_new</link>              (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *,
                                                         const <link linkend="char">char</link> *filename,
                                                         const <link linkend="char">char</link> *mbox_name,
                                                         <link linkend="CamelIndex">CamelIndex</link> *index);
<link linkend="void">void</link>                <link linkend="camel-mbox-summary-xstatus">camel_mbox_summary_xstatus</link>          (<link linkend="CamelMboxSummary">CamelMboxSummary</link> *mbs,
                                                         <link linkend="int">int</link> state);
<link linkend="int">int</link>                 <link linkend="camel-mbox-summary-sync-mbox">camel_mbox_summary_sync_mbox</link>        (<link linkend="CamelMboxSummary">CamelMboxSummary</link> *cls,
                                                         <link linkend="guint32">guint32</link> flags,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *changeinfo,
                                                         <link linkend="int">int</link> fd,
                                                         <link linkend="int">int</link> fdout,
                                                         <link linkend="CamelException">CamelException</link> *ex);
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1 id="camel-CamelMboxSummary.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="STATUS-PINE:CAPS" role="macro">
<title>STATUS_PINE</title>
<indexterm zone="STATUS-PINE:CAPS"><primary>STATUS_PINE</primary></indexterm><programlisting>#define STATUS_PINE
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CamelMboxSummary" role="struct">
<title>CamelMboxSummary</title>
<indexterm zone="CamelMboxSummary"><primary>CamelMboxSummary</primary></indexterm><programlisting>typedef struct {
	CamelLocalSummary parent;

	CamelFolderChangeInfo *changes;	/* used to build change sets */

	guint32 version;
	size_t folder_size;	/* size of the mbox file, last sync */

	unsigned int xstatus:1;	/* do we store/honour xstatus/status headers */
} CamelMboxSummary;
</programlisting>
<para>

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

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

	off_t frompos;
} CamelMboxMessageInfo;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-mbox-summary-new" role="function">
<title>camel_mbox_summary_new ()</title>
<indexterm zone="camel-mbox-summary-new"><primary>camel_mbox_summary_new</primary></indexterm><programlisting><link linkend="CamelMboxSummary">CamelMboxSummary</link>*   camel_mbox_summary_new              (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *,
                                                         const <link linkend="char">char</link> *filename,
                                                         const <link linkend="char">char</link> *mbox_name,
                                                         <link linkend="CamelIndex">CamelIndex</link> *index);</programlisting>
<para>
Create a new CamelMboxSummary object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mbox_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new CamelMboxSummary widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-mbox-summary-xstatus" role="function">
<title>camel_mbox_summary_xstatus ()</title>
<indexterm zone="camel-mbox-summary-xstatus"><primary>camel_mbox_summary_xstatus</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mbox_summary_xstatus          (<link linkend="CamelMboxSummary">CamelMboxSummary</link> *mbs,
                                                         <link linkend="int">int</link> state);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mbs</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-mbox-summary-sync-mbox" role="function">
<title>camel_mbox_summary_sync_mbox ()</title>
<indexterm zone="camel-mbox-summary-sync-mbox"><primary>camel_mbox_summary_sync_mbox</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_mbox_summary_sync_mbox        (<link linkend="CamelMboxSummary">CamelMboxSummary</link> *cls,
                                                         <link linkend="guint32">guint32</link> flags,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *changeinfo,
                                                         <link linkend="int">int</link> fd,
                                                         <link linkend="int">int</link> fdout,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>cls</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>changeinfo</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fd</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fdout</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


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

</refsect1>




</refentry>
