| Server IP : 182.53.201.61 / Your IP : 216.73.217.175 Web Server : Apache/2.2.15 (Fedora) System : Linux km10.dyndns.org 2.6.31.5-127.fc12.i686.PAE #1 SMP Sat Nov 7 21:25:57 EST 2009 i686 User : apache ( 48) PHP Version : 5.3.3 Disable Function : NONE MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/gtk-doc/html/camel/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>camel-folder-thread</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Folders.html" title="Folders">
<link rel="prev" href="camel-CamelFolderSummary.html" title="CamelFolderSummary">
<link rel="next" href="camel-CamelOfflineFolder.html" title="CamelOfflineFolder">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="classes.html" title="Part I. Camel Classes">
<link rel="chapter" href="ClassTree.html" title="Class Hierarchy">
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
<link rel="chapter" href="Streams.html" title="Streams">
<link rel="chapter" href="StreamFilters.html" title="Stream Filters">
<link rel="chapter" href="Services.html" title="Services">
<link rel="chapter" href="Filters.html" title="Filters">
<link rel="chapter" href="Folders.html" title="Folders">
<link rel="chapter" href="SearchFolders.html" title="Search Folders">
<link rel="chapter" href="Addresses.html" title="Addresses">
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
<link rel="chapter" href="MIME.html" title="MIME Objects">
<link rel="chapter" href="Storage.html" title="Metadata Storage">
<link rel="chapter" href="Utilities.html" title="Utilities">
<link rel="chapter" href="Deprecated.html" title="Deprecated Objects">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="camel-CamelFolderSummary.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Folders.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-CamelOfflineFolder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-camel-folder-thread.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-folder-thread.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="camel-folder-thread">
<a name="camel-camel-folder-thread"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-folder-thread.top_of_page"></a>camel-folder-thread</span></h2>
<p>camel-folder-thread</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-camel-folder-thread.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="camel-camel-folder-thread.html#CamelFolderThreadNode" title="CamelFolderThreadNode">CamelFolderThreadNode</a>;
<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a>;
<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> * <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-new" title="camel_folder_thread_messages_new ()">camel_folder_thread_messages_new</a> (<a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder">CamelFolder</a> *folder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *uids,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> thread_subject);
void <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-apply" title="camel_folder_thread_messages_apply ()">camel_folder_thread_messages_apply</a> (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *uids);
<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> * <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-new-summary" title="camel_folder_thread_messages_new_summary ()">camel_folder_thread_messages_new_summary</a>
(<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *summary);
void <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-add" title="camel_folder_thread_messages_add ()">camel_folder_thread_messages_add</a> (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *summary);
void <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-remove" title="camel_folder_thread_messages_remove ()">camel_folder_thread_messages_remove</a> (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *uids);
void <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-ref" title="camel_folder_thread_messages_ref ()">camel_folder_thread_messages_ref</a> (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread);
void <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-unref" title="camel_folder_thread_messages_unref ()">camel_folder_thread_messages_unref</a> (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="camel-camel-folder-thread.html#camel-folder-threaded-messages-dump" title="camel_folder_threaded_messages_dump ()">camel_folder_threaded_messages_dump</a> (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThreadNode" title="CamelFolderThreadNode">CamelFolderThreadNode</a> *c);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-camel-folder-thread.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-camel-folder-thread.details"></a><h2>Details</h2>
<div class="refsect2" title="CamelFolderThreadNode">
<a name="CamelFolderThreadNode"></a><h3>CamelFolderThreadNode</h3>
<pre class="programlisting">typedef struct {
struct _CamelFolderThreadNode *next, *parent, *child;
const CamelMessageInfo *message;
gchar *root_subject; /* cached root equivalent subject */
guint32 order:31;
guint32 re:1; /* re version of subject? */
} CamelFolderThreadNode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CamelFolderThread">
<a name="CamelFolderThread"></a><h3>CamelFolderThread</h3>
<pre class="programlisting">typedef struct {
guint32 refcount : 31;
guint32 subject : 1;
struct _CamelFolderThreadNode *tree;
struct _EMemChunk *node_chunks;
CamelFolder *folder;
GPtrArray *summary;
} CamelFolderThread;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_new ()">
<a name="camel-folder-thread-messages-new"></a><h3>camel_folder_thread_messages_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> * camel_folder_thread_messages_new (<a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder">CamelFolder</a> *folder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *uids,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> thread_subject);</pre>
<p>
Thread a (subset) of the messages in a folder. And sort the result
in summary order.
</p>
<p>
If <em class="parameter"><code>thread_subject</code></em> is <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a>, messages with
related subjects will also be threaded. The default behaviour is to
only thread based on message-id.
</p>
<p>
This function is probably to be removed soon.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td> The subset of uid's to thread. If NULL. then thread all
uid's in <em class="parameter"><code>folder</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>thread_subject</code></em> :</span></p></td>
<td> thread based on subject also
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A CamelFolderThread contianing a tree of CamelFolderThreadNode's
which represent the threaded structure of the messages.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_apply ()">
<a name="camel-folder-thread-messages-apply"></a><h3>camel_folder_thread_messages_apply ()</h3>
<pre class="programlisting">void camel_folder_thread_messages_apply (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *uids);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>thread</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_new_summary ()">
<a name="camel-folder-thread-messages-new-summary"></a><h3>camel_folder_thread_messages_new_summary ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> * camel_folder_thread_messages_new_summary
(<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *summary);</pre>
<p>
Thread a list of MessageInfo's. The summary must remain valid for the
life of the CamelFolderThread created by this function, and it is upto the
caller to ensure this.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td> Array of CamelMessageInfo's to thread.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A CamelFolderThread contianing a tree of CamelFolderThreadNode's
which represent the threaded structure of the messages.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_add ()">
<a name="camel-folder-thread-messages-add"></a><h3>camel_folder_thread_messages_add ()</h3>
<pre class="programlisting">void camel_folder_thread_messages_add (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *summary);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>thread</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_remove ()">
<a name="camel-folder-thread-messages-remove"></a><h3>camel_folder_thread_messages_remove ()</h3>
<pre class="programlisting">void camel_folder_thread_messages_remove (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread,
<a
href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a> *uids);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>thread</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_ref ()">
<a name="camel-folder-thread-messages-ref"></a><h3>camel_folder_thread_messages_ref ()</h3>
<pre class="programlisting">void camel_folder_thread_messages_ref (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>thread</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_thread_messages_unref ()">
<a name="camel-folder-thread-messages-unref"></a><h3>camel_folder_thread_messages_unref ()</h3>
<pre class="programlisting">void camel_folder_thread_messages_unref (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a> *thread);</pre>
<p>
Free all memory associated with the thread descriptor <em class="parameter"><code>thread</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>thread</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_folder_threaded_messages_dump ()">
<a name="camel-folder-threaded-messages-dump"></a><h3>camel_folder_threaded_messages_dump ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_folder_threaded_messages_dump (<a class="link" href="camel-camel-folder-thread.html#CamelFolderThreadNode" title="CamelFolderThreadNode">CamelFolderThreadNode</a> *c);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>c</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>