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

<refnamediv>
<refname>CamelImapStoreSummary</refname>
<refpurpose></refpurpose>
</refnamediv>

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

<synopsis>
                    <link linkend="CamelImapStoreInfo">CamelImapStoreInfo</link>;
                    <link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link>;
                    <link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link>;
<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> * <link linkend="camel-imap-store-summary-new">camel_imap_store_summary_new</link>    (void);
<link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> * <link linkend="camel-imap-store-summary-namespace-new">camel_imap_store_summary_namespace_new</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="char">char</link> dir_sep);
<link linkend="void">void</link>                <link linkend="camel-imap-store-summary-namespace-set">camel_imap_store_summary_namespace_set</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         <link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> *ns);
<link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> * <link linkend="camel-imap-store-summary-namespace-find-path">camel_imap_store_summary_namespace_find_path</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *path);
<link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> * <link linkend="camel-imap-store-summary-namespace-find-full">camel_imap_store_summary_namespace_find_full</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name);
<link linkend="char">char</link> *              <link linkend="camel-imap-store-summary-full-to-path">camel_imap_store_summary_full_to_path</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="char">char</link> dir_sep);
<link linkend="char">char</link> *              <link linkend="camel-imap-store-summary-path-to-full">camel_imap_store_summary_path_to_full</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *path,
                                                         <link linkend="char">char</link> dir_sep);
<link linkend="CamelImapStoreInfo">CamelImapStoreInfo</link> * <link linkend="camel-imap-store-summary-full-name">camel_imap_store_summary_full_name</link> (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name);
<link linkend="CamelImapStoreInfo">CamelImapStoreInfo</link> * <link linkend="camel-imap-store-summary-add-from-full">camel_imap_store_summary_add_from_full</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="char">char</link> dir_sep);
<link linkend="char">char</link> *              <link linkend="camel-imap-store-summary-full-from-path">camel_imap_store_summary_full_from_path</link>
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *path);
#define             <link linkend="camel-imap-store-info-full-name">camel_imap_store_info_full_name</link>     (s, i)
</synopsis>
</refsynopsisdiv>









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

<refsect1 id="camel-CamelImapStoreSummary.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelImapStoreInfo" role="struct">
<title>CamelImapStoreInfo</title>
<indexterm zone="CamelImapStoreInfo"><primary sortas="CamelImapStoreInfo">CamelImapStoreInfo</primary></indexterm><programlisting>typedef struct {
	CamelStoreInfo info;
	char *full_name;
} CamelImapStoreInfo;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelImapStoreNamespace" role="struct">
<title>CamelImapStoreNamespace</title>
<indexterm zone="CamelImapStoreNamespace"><primary sortas="CamelImapStoreNamespace">CamelImapStoreNamespace</primary></indexterm><programlisting>typedef struct {
	char *path;		/* display path */
	char *full_name;	/* real name */
	char sep;		/* directory separator */
} CamelImapStoreNamespace;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelImapStoreSummary" role="struct">
<title>CamelImapStoreSummary</title>
<indexterm zone="CamelImapStoreSummary"><primary sortas="CamelImapStoreSummary">CamelImapStoreSummary</primary></indexterm><programlisting>typedef struct {
	CamelStoreSummary summary;

	struct _CamelImapStoreSummaryPrivate *priv;

	/* header info */
	guint32 version;	/* version of base part of file */
	guint32 capabilities;
	CamelImapStoreNamespace *namespace; /* eventually to be a list */
} CamelImapStoreSummary;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-imap-store-summary-new" role="function">
<title>camel_imap_store_summary_new ()</title>
<indexterm zone="camel-imap-store-summary-new"><primary sortas="camel_imap_store_summary_new">camel_imap_store_summary_new</primary></indexterm><programlisting><link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> * camel_imap_store_summary_new    (void);</programlisting>
<para>
Create a new CamelImapStoreSummary object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new CamelImapStoreSummary widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-namespace-new" role="function">
<title>camel_imap_store_summary_namespace_new ()</title>
<indexterm zone="camel-imap-store-summary-namespace-new"><primary sortas="camel_imap_store_summary_namespace_new">camel_imap_store_summary_namespace_new</primary></indexterm><programlisting><link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> * camel_imap_store_summary_namespace_new
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="char">char</link> dir_sep);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-namespace-set" role="function">
<title>camel_imap_store_summary_namespace_set ()</title>
<indexterm zone="camel-imap-store-summary-namespace-set"><primary sortas="camel_imap_store_summary_namespace_set">camel_imap_store_summary_namespace_set</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imap_store_summary_namespace_set
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         <link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> *ns);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-namespace-find-path" role="function">
<title>camel_imap_store_summary_namespace_find_path ()</title>
<indexterm zone="camel-imap-store-summary-namespace-find-path"><primary sortas="camel_imap_store_summary_namespace_find_path">camel_imap_store_summary_namespace_find_path</primary></indexterm><programlisting><link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> * camel_imap_store_summary_namespace_find_path
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *path);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-namespace-find-full" role="function">
<title>camel_imap_store_summary_namespace_find_full ()</title>
<indexterm zone="camel-imap-store-summary-namespace-find-full"><primary sortas="camel_imap_store_summary_namespace_find_full">camel_imap_store_summary_namespace_find_full</primary></indexterm><programlisting><link linkend="CamelImapStoreNamespace">CamelImapStoreNamespace</link> * camel_imap_store_summary_namespace_find_full
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-full-to-path" role="function">
<title>camel_imap_store_summary_full_to_path ()</title>
<indexterm zone="camel-imap-store-summary-full-to-path"><primary sortas="camel_imap_store_summary_full_to_path">camel_imap_store_summary_full_to_path</primary></indexterm><programlisting><link linkend="char">char</link> *              camel_imap_store_summary_full_to_path
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="char">char</link> dir_sep);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-path-to-full" role="function">
<title>camel_imap_store_summary_path_to_full ()</title>
<indexterm zone="camel-imap-store-summary-path-to-full"><primary sortas="camel_imap_store_summary_path_to_full">camel_imap_store_summary_path_to_full</primary></indexterm><programlisting><link linkend="char">char</link> *              camel_imap_store_summary_path_to_full
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *path,
                                                         <link linkend="char">char</link> dir_sep);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-full-name" role="function">
<title>camel_imap_store_summary_full_name ()</title>
<indexterm zone="camel-imap-store-summary-full-name"><primary sortas="camel_imap_store_summary_full_name">camel_imap_store_summary_full_name</primary></indexterm><programlisting><link linkend="CamelImapStoreInfo">CamelImapStoreInfo</link> * camel_imap_store_summary_full_name (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name);</programlisting>
<para>
Retrieve a summary item by full name.
</para>
<para>
A referenced to the summary item is returned, which may be
ref'd or free'd as appropriate.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The summary item, or NULL if the <parameter>full_name</parameter> name
is not available.
It must be freed using <link linkend="camel-store-summary-info-free"><function>camel_store_summary_info_free()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-add-from-full" role="function">
<title>camel_imap_store_summary_add_from_full ()</title>
<indexterm zone="camel-imap-store-summary-add-from-full"><primary sortas="camel_imap_store_summary_add_from_full">camel_imap_store_summary_add_from_full</primary></indexterm><programlisting><link linkend="CamelImapStoreInfo">CamelImapStoreInfo</link> * camel_imap_store_summary_add_from_full
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="char">char</link> dir_sep);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-summary-full-from-path" role="function">
<title>camel_imap_store_summary_full_from_path ()</title>
<indexterm zone="camel-imap-store-summary-full-from-path"><primary sortas="camel_imap_store_summary_full_from_path">camel_imap_store_summary_full_from_path</primary></indexterm><programlisting><link linkend="char">char</link> *              camel_imap_store_summary_full_from_path
                                                        (<link linkend="CamelImapStoreSummary">CamelImapStoreSummary</link> *s,
                                                         const <link linkend="char">char</link> *path);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-imap-store-info-full-name" role="macro">
<title>camel_imap_store_info_full_name()</title>
<indexterm zone="camel-imap-store-info-full-name"><primary sortas="camel_imap_store_info_full_name">camel_imap_store_info_full_name</primary></indexterm><programlisting>#define camel_imap_store_info_full_name(s, i) (camel_store_info_string((CamelStoreSummary *)s, (const CamelStoreInfo *)i, CAMEL_IMAP_STORE_INFO_FULL_NAME))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
