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

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

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

<synopsis>
                    <link linkend="CamelMaildirSummary">CamelMaildirSummary</link>;
                    <link linkend="CamelMaildirMessageContentInfo">CamelMaildirMessageContentInfo</link>;
                    <link linkend="CamelMaildirMessageInfo">CamelMaildirMessageInfo</link>;
<link linkend="CamelMaildirSummary">CamelMaildirSummary</link>* <link linkend="camel-maildir-summary-new">camel_maildir_summary_new</link>          (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder,
                                                         const <link linkend="char">char</link> *filename,
                                                         const <link linkend="char">char</link> *maildirdir,
                                                         <link linkend="CamelIndex">CamelIndex</link> *index);
<link linkend="char">char</link>*               <link linkend="camel-maildir-summary-info-to-name">camel_maildir_summary_info_to_name</link>  (const <link linkend="CamelMaildirMessageInfo">CamelMaildirMessageInfo</link> *info);
<link linkend="int">int</link>                 <link linkend="camel-maildir-summary-name-to-info">camel_maildir_summary_name_to_info</link>  (<link linkend="CamelMaildirMessageInfo">CamelMaildirMessageInfo</link> *info,
                                                         const <link linkend="char">char</link> *name);
#define             <link linkend="camel-maildir-info-filename">camel_maildir_info_filename</link>         (x)
#define             <link linkend="camel-maildir-info-set-filename">camel_maildir_info_set_filename</link>     (x, s)
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1 id="camel-CamelMaildirSummary.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelMaildirSummary" role="struct">
<title>CamelMaildirSummary</title>
<indexterm zone="CamelMaildirSummary"><primary>CamelMaildirSummary</primary></indexterm><programlisting>typedef struct {
	CamelLocalSummary parent;
	struct _CamelMaildirSummaryPrivate *priv;
} CamelMaildirSummary;
</programlisting>
<para>

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

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

	char *filename;		/* maildir has this annoying status shit on the end of the filename, use this to get the real message id */
} CamelMaildirMessageInfo;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-maildir-summary-new" role="function">
<title>camel_maildir_summary_new ()</title>
<indexterm zone="camel-maildir-summary-new"><primary>camel_maildir_summary_new</primary></indexterm><programlisting><link linkend="CamelMaildirSummary">CamelMaildirSummary</link>* camel_maildir_summary_new          (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder,
                                                         const <link linkend="char">char</link> *filename,
                                                         const <link linkend="char">char</link> *maildirdir,
                                                         <link linkend="CamelIndex">CamelIndex</link> *index);</programlisting>
<para>
Create a new CamelMaildirSummary object.</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> Path to root of this maildir directory (containing new/tmp/cur directories).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>maildirdir</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
<listitem><simpara> Index if one is reqiured.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="CamelMaildirSummary"><type>CamelMaildirSummary</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-maildir-summary-info-to-name" role="function">
<title>camel_maildir_summary_info_to_name ()</title>
<indexterm zone="camel-maildir-summary-info-to-name"><primary>camel_maildir_summary_info_to_name</primary></indexterm><programlisting><link linkend="char">char</link>*               camel_maildir_summary_info_to_name  (const <link linkend="CamelMaildirMessageInfo">CamelMaildirMessageInfo</link> *info);</programlisting>
<para>

</para><variablelist role="params">
<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-maildir-summary-name-to-info" role="function">
<title>camel_maildir_summary_name_to_info ()</title>
<indexterm zone="camel-maildir-summary-name-to-info"><primary>camel_maildir_summary_name_to_info</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_maildir_summary_name_to_info  (<link linkend="CamelMaildirMessageInfo">CamelMaildirMessageInfo</link> *info,
                                                         const <link linkend="char">char</link> *name);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</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-maildir-info-filename" role="macro">
<title>camel_maildir_info_filename()</title>
<indexterm zone="camel-maildir-info-filename"><primary>camel_maildir_info_filename</primary></indexterm><programlisting>#define camel_maildir_info_filename(x) (((CamelMaildirMessageInfo *)x)-&gt;filename)
</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-maildir-info-set-filename" role="macro">
<title>camel_maildir_info_set_filename()</title>
<indexterm zone="camel-maildir-info-set-filename"><primary>camel_maildir_info_set_filename</primary></indexterm><programlisting>#define camel_maildir_info_set_filename(x, s) (g_free(((CamelMaildirMessageInfo *)x)-&gt;filename),((CamelMaildirMessageInfo *)x)-&gt;filename = s)
</programlisting>
<para>

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


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

</refsect1>




</refentry>
