Diffstat (limited to 'kmicromail/libetpan/generic/mailthread.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | kmicromail/libetpan/generic/mailthread.h | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/kmicromail/libetpan/generic/mailthread.h b/kmicromail/libetpan/generic/mailthread.h new file mode 100644 index 0000000..e4e33ff --- a/dev/null +++ b/kmicromail/libetpan/generic/mailthread.h | |||
@@ -0,0 +1,108 @@ | |||
1 | /* | ||
2 | * libEtPan! -- a mail stuff library | ||
3 | * | ||
4 | * Copyright (C) 2001, 2002 - DINH Viet Hoa | ||
5 | * All rights reserved. | ||
6 | * | ||
7 | * Redistribution and use in source and binary forms, with or without | ||
8 | * modification, are permitted provided that the following conditions | ||
9 | * are met: | ||
10 | * 1. Redistributions of source code must retain the above copyright | ||
11 | * notice, this list of conditions and the following disclaimer. | ||
12 | * 2. Redistributions in binary form must reproduce the above copyright | ||
13 | * notice, this list of conditions and the following disclaimer in the | ||
14 | * documentation and/or other materials provided with the distribution. | ||
15 | * 3. Neither the name of the libEtPan! project nor the names of its | ||
16 | * contributors may be used to endorse or promote products derived | ||
17 | * from this software without specific prior written permission. | ||
18 | * | ||
19 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
20 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
21 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
22 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
23 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
24 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
25 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
26 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
27 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
28 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
29 | * SUCH DAMAGE. | ||
30 | */ | ||
31 | |||
32 | /* | ||
33 | * $Id$ | ||
34 | */ | ||
35 | |||
36 | #ifndef MAILTHREAD_H | ||
37 | |||
38 | #define MAILTHREAD_H | ||
39 | |||
40 | #include <libetpan/mailthread_types.h> | ||
41 | |||
42 | #ifdef __cplusplus | ||
43 | extern "C" { | ||
44 | #endif | ||
45 | |||
46 | /* | ||
47 | mail_build_thread constructs a tree with the message using the | ||
48 | given style. | ||
49 | |||
50 | @param type is the type of threading to apply, the value can be | ||
51 | MAIL_THREAD_REFERENCES, MAIL_THREAD_REFERENCES_NO_SUBJECT or | ||
52 | MAIL_THREAD_ORDEREDSUBJECT. | ||
53 | |||
54 | @param default_from is the default charset to use whenever the | ||
55 | subject is not tagged with a charset. "US-ASCII" can be used | ||
56 | if you don't know what to use. | ||
57 | |||
58 | @param env_list is the message list (with header fields fetched) | ||
59 | to use to build the message tree. | ||
60 | |||
61 | @param result * result) will contain the resulting message tree. | ||
62 | |||
63 | @param if comp_func is NULL, no sorting algorithm is used. | ||
64 | |||
65 | @return MAIL_NO_ERROR is returned on success, MAIL_ERROR_XXX is returned | ||
66 | on error | ||
67 | */ | ||
68 | |||
69 | int mail_build_thread(int type, char * default_from, | ||
70 | struct mailmessage_list * env_list, | ||
71 | struct mailmessage_tree ** result, | ||
72 | int (* comp_func)(struct mailmessage_tree **, | ||
73 | struct mailmessage_tree **)); | ||
74 | |||
75 | /* | ||
76 | mail_thread_sort sort the messages in the message tree, using the | ||
77 | given sort function. | ||
78 | |||
79 | @param tree is the message tree to sort. | ||
80 | |||
81 | @param comp_func is the sort function to use (this is the same kind of | ||
82 | functions than those used for qsort()). mailthread_tree_timecomp can be | ||
83 | used for default sort. | ||
84 | |||
85 | @param sort_sub if this value is 0, only the children of the root message | ||
86 | are sorted. | ||
87 | */ | ||
88 | |||
89 | int mail_thread_sort(struct mailmessage_tree * tree, | ||
90 | int (* comp_func)(struct mailmessage_tree **, | ||
91 | struct mailmessage_tree **), | ||
92 | int sort_sub); | ||
93 | |||
94 | /* | ||
95 | mailthread_tree_timecomp is the default sort function. | ||
96 | |||
97 | The message are compared by date, then by message numbers. | ||
98 | The tree are given in (* ptree1) and (* ptree2). | ||
99 | */ | ||
100 | |||
101 | int mailthread_tree_timecomp(struct mailmessage_tree ** ptree1, | ||
102 | struct mailmessage_tree ** ptree2); | ||
103 | |||
104 | #ifdef __cplusplus | ||
105 | } | ||
106 | #endif | ||
107 | |||
108 | #endif | ||