1
<refentry id="camel-CamelVTrashFolder">
3
<refentrytitle role="top_of_page" id="camel-CamelVTrashFolder.top_of_page">CamelVTrashFolder</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>CAMEL Library</refmiscinfo>
9
<refname>CamelVTrashFolder</refname>
10
<refpurpose></refpurpose>
13
<refsynopsisdiv id="camel-CamelVTrashFolder.synopsis" role="synopsis">
14
<title role="synopsis.title">Synopsis</title>
17
#define <link linkend="CAMEL-VTRASH-NAME--CAPS">CAMEL_VTRASH_NAME</link>
18
#define <link linkend="CAMEL-VJUNK-NAME--CAPS">CAMEL_VJUNK_NAME</link>
19
<link linkend="CamelVTrashFolder">CamelVTrashFolder</link>;
20
enum <link linkend="camel-vtrash-folder-t">camel_vtrash_folder_t</link>;
21
<link linkend="CamelFolder">CamelFolder</link> * <link linkend="camel-vtrash-folder-new">camel_vtrash_folder_new</link> (<link linkend="CamelStore">CamelStore</link> *parent_store,
22
<link linkend="camel-vtrash-folder-t">camel_vtrash_folder_t</link> type);
34
<refsect1 id="camel-CamelVTrashFolder.description" role="desc">
35
<title role="desc.title">Description</title>
40
<refsect1 id="camel-CamelVTrashFolder.details" role="details">
41
<title role="details.title">Details</title>
42
<refsect2 id="CAMEL-VTRASH-NAME--CAPS" role="macro">
43
<title>CAMEL_VTRASH_NAME</title>
44
<indexterm zone="CAMEL-VTRASH-NAME--CAPS"><primary sortas="CAMEL_VTRASH_NAME">CAMEL_VTRASH_NAME</primary></indexterm><programlisting>#define CAMEL_VTRASH_NAME ".#evolution/Trash"
48
<refsect2 id="CAMEL-VJUNK-NAME--CAPS" role="macro">
49
<title>CAMEL_VJUNK_NAME</title>
50
<indexterm zone="CAMEL-VJUNK-NAME--CAPS"><primary sortas="CAMEL_VJUNK_NAME">CAMEL_VJUNK_NAME</primary></indexterm><programlisting>#define CAMEL_VJUNK_NAME ".#evolution/Junk"
54
<refsect2 id="CamelVTrashFolder" role="struct">
55
<title>CamelVTrashFolder</title>
56
<indexterm zone="CamelVTrashFolder"><primary sortas="CamelVTrashFolder">CamelVTrashFolder</primary></indexterm><programlisting>typedef struct {
57
CamelVeeFolder parent;
59
camel_vtrash_folder_t type;
65
<refsect2 id="camel-vtrash-folder-t" role="enum">
66
<title>enum camel_vtrash_folder_t</title>
67
<indexterm zone="camel-vtrash-folder-t"><primary sortas="camel_vtrash_folder_t">camel_vtrash_folder_t</primary></indexterm><programlisting>typedef enum {
68
CAMEL_VTRASH_FOLDER_TRASH,
69
CAMEL_VTRASH_FOLDER_JUNK,
70
CAMEL_VTRASH_FOLDER_LAST
71
} camel_vtrash_folder_t;
75
<refsect2 id="camel-vtrash-folder-new" role="function">
76
<title>camel_vtrash_folder_new ()</title>
77
<indexterm zone="camel-vtrash-folder-new"><primary sortas="camel_vtrash_folder_new">camel_vtrash_folder_new</primary></indexterm><programlisting><link linkend="CamelFolder">CamelFolder</link> * camel_vtrash_folder_new (<link linkend="CamelStore">CamelStore</link> *parent_store,
78
<link linkend="camel-vtrash-folder-t">camel_vtrash_folder_t</link> type);</programlisting>
80
Create a new CamelVTrashFolder object.</para>
82
</para><variablelist role="params">
83
<varlistentry><term><parameter>parent_store</parameter> :</term>
84
<listitem><simpara> the parent <link linkend="CamelVeeStore"><type>CamelVeeStore</type></link> object
85
</simpara></listitem></varlistentry>
86
<varlistentry><term><parameter>type</parameter> :</term>
87
<listitem><simpara> type of vfolder, <link linkend="CAMEL-VTRASH-FOLDER-TRASH--CAPS"><type>CAMEL_VTRASH_FOLDER_TRASH</type></link> or
88
<link linkend="CAMEL-VTRASH-FOLDER-JUNK--CAPS"><type>CAMEL_VTRASH_FOLDER_JUNK</type></link> currently.
89
</simpara></listitem></varlistentry>
90
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="CamelVTrashFolder"><type>CamelVTrashFolder</type></link> object
91
</simpara></listitem></varlistentry>
92
</variablelist></refsect2>