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

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

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

<synopsis>
                    <link linkend="CamelLocalSummary">CamelLocalSummary</link>;
                    <link linkend="CamelLocalMessageInfo">CamelLocalMessageInfo</link>;
<link linkend="void">void</link>                <link linkend="camel-local-summary-construct">camel_local_summary_construct</link>       (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *new,
                                                         const <link linkend="char">char</link> *filename,
                                                         const <link linkend="char">char</link> *local_name,
                                                         <link linkend="CamelIndex">CamelIndex</link> *index);
<link linkend="int">int</link>                 <link linkend="camel-local-summary-load">camel_local_summary_load</link>            (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="int">int</link> forceindex,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="int">int</link>                 <link linkend="camel-local-summary-check">camel_local_summary_check</link>           (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="int">int</link>                 <link linkend="camel-local-summary-sync">camel_local_summary_sync</link>            (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="gboolean">gboolean</link> expunge,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>*   <link linkend="camel-local-summary-add">camel_local_summary_add</link>             (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="CamelMimeMessage">CamelMimeMessage</link> *msg,
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="void">void</link>                <link linkend="camel-local-summary-check-force">camel_local_summary_check_force</link>     (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls);
<link linkend="char">char</link>*               <link linkend="camel-local-summary-encode-x-evolution">camel_local_summary_encode_x_evolution</link>
                                                        (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         const <link linkend="CamelLocalMessageInfo">CamelLocalMessageInfo</link> *info);
<link linkend="int">int</link>                 <link linkend="camel-local-summary-decode-x-evolution">camel_local_summary_decode_x_evolution</link>
                                                        (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         const <link linkend="char">char</link> *xev,
                                                         <link linkend="CamelLocalMessageInfo">CamelLocalMessageInfo</link> *info);
<link linkend="int">int</link>                 <link linkend="camel-local-summary-write-headers">camel_local_summary_write_headers</link>   (<link linkend="int">int</link> fd,
                                                         <link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *header,
                                                         const <link linkend="char">char</link> *xevline,
                                                         const <link linkend="char">char</link> *status,
                                                         const <link linkend="char">char</link> *xstatus);
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1 id="camel-CamelLocalSummary.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelLocalSummary" role="struct">
<title>CamelLocalSummary</title>
<indexterm zone="CamelLocalSummary"><primary>CamelLocalSummary</primary></indexterm><programlisting>typedef struct {
	CamelFolderSummary parent;

	guint32 version;	/* file version being loaded */

	char *folder_path;	/* name of matching folder */
	
	CamelIndex *index;
	unsigned int index_force:1; /* do we force index during creation? */
	unsigned int check_force:1; /* does a check force a full check? */
} CamelLocalSummary;
</programlisting>
<para>

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

</para></refsect2>
<refsect2 id="camel-local-summary-construct" role="function">
<title>camel_local_summary_construct ()</title>
<indexterm zone="camel-local-summary-construct"><primary>camel_local_summary_construct</primary></indexterm><programlisting><link linkend="void">void</link>                camel_local_summary_construct       (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *new,
                                                         const <link linkend="char">char</link> *filename,
                                                         const <link linkend="char">char</link> *local_name,
                                                         <link linkend="CamelIndex">CamelIndex</link> *index);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>new</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>local_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-local-summary-load" role="function">
<title>camel_local_summary_load ()</title>
<indexterm zone="camel-local-summary-load"><primary>camel_local_summary_load</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_summary_load            (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="int">int</link> forceindex,
                                                         <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>forceindex</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>
<refsect2 id="camel-local-summary-check" role="function">
<title>camel_local_summary_check ()</title>
<indexterm zone="camel-local-summary-check"><primary>camel_local_summary_check</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_summary_check           (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *,
                                                         <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>Param2</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>
<refsect2 id="camel-local-summary-sync" role="function">
<title>camel_local_summary_sync ()</title>
<indexterm zone="camel-local-summary-sync"><primary>camel_local_summary_sync</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_summary_sync            (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="gboolean">gboolean</link> expunge,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *,
                                                         <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>expunge</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param3</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>
<refsect2 id="camel-local-summary-add" role="function">
<title>camel_local_summary_add ()</title>
<indexterm zone="camel-local-summary-add"><primary>camel_local_summary_add</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>*   camel_local_summary_add             (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         <link linkend="CamelMimeMessage">CamelMimeMessage</link> *msg,
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info,
                                                         <link linkend="CamelFolderChangeInfo">CamelFolderChangeInfo</link> *,
                                                         <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>msg</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param4</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>
<refsect2 id="camel-local-summary-check-force" role="function">
<title>camel_local_summary_check_force ()</title>
<indexterm zone="camel-local-summary-check-force"><primary>camel_local_summary_check_force</primary></indexterm><programlisting><link linkend="void">void</link>                camel_local_summary_check_force     (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-local-summary-encode-x-evolution" role="function">
<title>camel_local_summary_encode_x_evolution ()</title>
<indexterm zone="camel-local-summary-encode-x-evolution"><primary>camel_local_summary_encode_x_evolution</primary></indexterm><programlisting><link linkend="char">char</link>*               camel_local_summary_encode_x_evolution
                                                        (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         const <link linkend="CamelLocalMessageInfo">CamelLocalMessageInfo</link> *info);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>cls</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-local-summary-decode-x-evolution" role="function">
<title>camel_local_summary_decode_x_evolution ()</title>
<indexterm zone="camel-local-summary-decode-x-evolution"><primary>camel_local_summary_decode_x_evolution</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_summary_decode_x_evolution
                                                        (<link linkend="CamelLocalSummary">CamelLocalSummary</link> *cls,
                                                         const <link linkend="char">char</link> *xev,
                                                         <link linkend="CamelLocalMessageInfo">CamelLocalMessageInfo</link> *info);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>cls</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xev</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-local-summary-write-headers" role="function">
<title>camel_local_summary_write_headers ()</title>
<indexterm zone="camel-local-summary-write-headers"><primary>camel_local_summary_write_headers</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_summary_write_headers   (<link linkend="int">int</link> fd,
                                                         <link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *header,
                                                         const <link linkend="char">char</link> *xevline,
                                                         const <link linkend="char">char</link> *status,
                                                         const <link linkend="char">char</link> *xstatus);</programlisting>
<para>
Write a bunch of headers to the file <parameter>fd</parameter>.  IF xevline is non NULL, then
an X-Evolution header line is created at the end of all of the headers.
If <parameter>status</parameter> is non NULL, then a Status header line is also written.
The headers written are termianted with a blank line.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fd</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xevline</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xstatus</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> -1 on error, otherwise the number of bytes written.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
