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

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

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

<synopsis>
struct              <link linkend="CamelDiscoFolder">CamelDiscoFolder</link>;
<link linkend="void">void</link>                <link linkend="camel-disco-folder-expunge-uids">camel_disco_folder_expunge_uids</link>     (<link linkend="CamelFolder">CamelFolder</link> *folder,
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="void">void</link>                <link linkend="camel-disco-folder-cache-message">camel_disco_folder_cache_message</link>    (<link linkend="CamelDiscoFolder">CamelDiscoFolder</link> *disco_folder,
                                                         const <link linkend="char">char</link> *uid,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="void">void</link>                <link linkend="camel-disco-folder-prepare-for-offline">camel_disco_folder_prepare_for_offline</link>
                                                        (<link linkend="CamelDiscoFolder">CamelDiscoFolder</link> *disco_folder,
                                                         const <link linkend="char">char</link> *expression,
                                                         <link linkend="CamelException">CamelException</link> *ex);
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1 id="camel-CamelDiscoFolder.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelDiscoFolder" role="struct">
<title>struct CamelDiscoFolder</title>
<indexterm zone="CamelDiscoFolder"><primary>CamelDiscoFolder</primary></indexterm><programlisting>struct CamelDiscoFolder {
	CamelFolder parent_object;

	unsigned int offline_sync:1;
};
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-disco-folder-expunge-uids" role="function">
<title>camel_disco_folder_expunge_uids ()</title>
<indexterm zone="camel-disco-folder-expunge-uids"><primary>camel_disco_folder_expunge_uids</primary></indexterm><programlisting><link linkend="void">void</link>                camel_disco_folder_expunge_uids     (<link linkend="CamelFolder">CamelFolder</link> *folder,
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This expunges the messages in <parameter>uids</parameter> from <parameter>folder</parameter>. It should take
whatever steps are needed to avoid expunging any other messages,
although in some cases it may not be possible to avoid expunging
messages that are marked deleted by another client at the same time
as the expunge_uids call is running.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>folder</parameter>&nbsp;:</term>
<listitem><simpara> a (disconnectable) folder
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uids</parameter>&nbsp;:</term>
<listitem><simpara> array of UIDs to expunge
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara> a CamelException
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-disco-folder-cache-message" role="function">
<title>camel_disco_folder_cache_message ()</title>
<indexterm zone="camel-disco-folder-cache-message"><primary>camel_disco_folder_cache_message</primary></indexterm><programlisting><link linkend="void">void</link>                camel_disco_folder_cache_message    (<link linkend="CamelDiscoFolder">CamelDiscoFolder</link> *disco_folder,
                                                         const <link linkend="char">char</link> *uid,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
Requests that <parameter>disco_folder</parameter> cache message <parameter>uid</parameter> to disk.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>disco_folder</parameter>&nbsp;:</term>
<listitem><simpara> the folder
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara> the UID of the message to cache
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara> a CamelException
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-disco-folder-prepare-for-offline" role="function">
<title>camel_disco_folder_prepare_for_offline ()</title>
<indexterm zone="camel-disco-folder-prepare-for-offline"><primary>camel_disco_folder_prepare_for_offline</primary></indexterm><programlisting><link linkend="void">void</link>                camel_disco_folder_prepare_for_offline
                                                        (<link linkend="CamelDiscoFolder">CamelDiscoFolder</link> *disco_folder,
                                                         const <link linkend="char">char</link> *expression,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This prepares <parameter>disco_folder</parameter> for offline operation, by downloading
the bodies of all messages described by <parameter>expression</parameter> (using the
same syntax as <link linkend="camel-folder-search-by-expression"><function>camel_folder_search_by_expression()</function></link> ).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>disco_folder</parameter>&nbsp;:</term>
<listitem><simpara> the folder
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>expression</parameter>&nbsp;:</term>
<listitem><simpara> an expression describing messages to synchronize, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if all messages should be sync'ed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara> a CamelException
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
