2006-02-24 [wwp] 2.0.0cvs81
[claws.git] / src / procmsg.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  */
19
20 #ifndef __PROCMSG_H__
21 #define __PROCMSG_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <stdio.h>
29 #include <time.h>
30 #include <sys/types.h>
31 #include <string.h>
32
33 typedef struct _MsgInfo                 MsgInfo;
34 typedef struct _MsgFlags                MsgFlags;
35 typedef struct _MsgFileInfo             MsgFileInfo;
36 typedef struct _MsgInfoUpdate           MsgInfoUpdate;
37 typedef struct _MailFilteringData       MailFilteringData;
38
39 typedef GSList MsgInfoList;
40 typedef GSList MsgNumberList;
41
42 #define MSG_NEW                 (1U << 0)
43 #define MSG_UNREAD              (1U << 1)
44 #define MSG_MARKED              (1U << 2)
45 #define MSG_DELETED             (1U << 3)
46 #define MSG_REPLIED             (1U << 4)
47 #define MSG_FORWARDED           (1U << 5)
48 #if 0
49 #define MSG_REALLY_DELETED      (1U << 6)               /* mbox stuff */
50 #endif
51
52 #define MSG_CLABEL_SBIT (7)             /* start bit of color label */
53 #define MAKE_MSG_CLABEL(h, m, l)        (((h) << (MSG_CLABEL_SBIT + 2)) | \
54                                          ((m) << (MSG_CLABEL_SBIT + 1)) | \
55                                          ((l) << (MSG_CLABEL_SBIT + 0)))
56
57 #define MSG_CLABEL_NONE         MAKE_MSG_CLABEL(0U, 0U, 0U)
58 #define MSG_CLABEL_1            MAKE_MSG_CLABEL(0U, 0U, 1U)
59 #define MSG_CLABEL_2            MAKE_MSG_CLABEL(0U, 1U, 0U)
60 #define MSG_CLABEL_3            MAKE_MSG_CLABEL(0U, 1U, 1U)
61 #define MSG_CLABEL_4            MAKE_MSG_CLABEL(1U, 0U, 0U)
62 #define MSG_CLABEL_5            MAKE_MSG_CLABEL(1U, 0U, 1U)
63 #define MSG_CLABEL_6            MAKE_MSG_CLABEL(1U, 1U, 0U)
64 #define MSG_CLABEL_7            MAKE_MSG_CLABEL(1U, 1U, 1U)
65
66 #define MSG_CLABEL_ORANGE       MSG_CLABEL_1
67 #define MSG_CLABEL_RED          MSG_CLABEL_2
68 #define MSG_CLABEL_PINK         MSG_CLABEL_3
69 #define MSG_CLABEL_SKYBLUE      MSG_CLABEL_4
70 #define MSG_CLABEL_BLUE         MSG_CLABEL_5
71 #define MSG_CLABEL_GREEN        MSG_CLABEL_6
72 #define MSG_CLABEL_BROWN        MSG_CLABEL_7
73
74 #define MSG_IGNORE_THREAD       (1U << 10)   /* ignore threads */
75 #define MSG_LOCKED              (1U << 11)   /* msg is locked  */
76 #define MSG_RETRCPT_SENT        (1U << 12)   /* new one */ 
77                                                 
78 /* RESERVED */
79 #define MSG_RESERVED_CLAWS      (1U << 30)   /* for sylpheed-claws */
80 #define MSG_RESERVED            (1U << 31)
81
82 typedef guint32 MsgPermFlags;
83
84 #define MSG_CLABEL_FLAG_MASK    (MSG_CLABEL_7)
85
86 #define MSG_MOVE                (1U << 0)
87 #define MSG_COPY                (1U << 1)
88 #define MSG_QUEUED              (1U << 16)
89 #define MSG_DRAFT               (1U << 17)
90 #define MSG_ENCRYPTED           (1U << 18)
91 #define MSG_IMAP                (1U << 19)
92 #define MSG_NEWS                (1U << 20)
93 #define MSG_SIGNED              (1U << 21)
94 #define MSG_MULTIPART           (1U << 29)
95 #define MSG_HAS_ATTACHMENT      (1U << 30)
96 #define MSG_SCANNED             (1U << 31)
97
98 typedef guint32 MsgTmpFlags;
99
100 #define MSG_CACHED_FLAG_MASK    (MSG_MULTIPART | MSG_ENCRYPTED | MSG_SIGNED | MSG_HAS_ATTACHMENT | MSG_SCANNED)
101
102 #define MSG_SET_FLAGS(msg, flags)       { (msg) |= (flags); }
103 #define MSG_UNSET_FLAGS(msg, flags)     { (msg) &= ~(flags); }
104 #define MSG_SET_PERM_FLAGS(msg, flags) \
105         MSG_SET_FLAGS((msg).perm_flags, flags)
106 #define MSG_SET_TMP_FLAGS(msg, flags) \
107         MSG_SET_FLAGS((msg).tmp_flags, flags)
108 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
109         MSG_UNSET_FLAGS((msg).perm_flags, flags)
110 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
111         MSG_UNSET_FLAGS((msg).tmp_flags, flags)
112
113 #define MSG_IS_NEW(msg)                 (((msg).perm_flags & MSG_NEW) != 0)
114 #define MSG_IS_UNREAD(msg)              (((msg).perm_flags & MSG_UNREAD) != 0)
115 #define MSG_IS_MARKED(msg)              (((msg).perm_flags & MSG_MARKED) != 0)
116 #define MSG_IS_DELETED(msg)             (((msg).perm_flags & MSG_DELETED) != 0)
117 #define MSG_IS_REPLIED(msg)             (((msg).perm_flags & MSG_REPLIED) != 0)
118 #define MSG_IS_LOCKED(msg)              (((msg).perm_flags & MSG_LOCKED) != 0)
119 #define MSG_IS_FORWARDED(msg)           (((msg).perm_flags & MSG_FORWARDED) != 0)
120
121 #define MSG_GET_COLORLABEL(msg)         (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
122 #define MSG_GET_COLORLABEL_VALUE(msg)   (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
123 #define MSG_SET_COLORLABEL_VALUE(msg, val) \
124         MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
125
126 #define MSG_COLORLABEL_TO_FLAGS(val) ((((guint)(val)) & 7) << MSG_CLABEL_SBIT)
127 #define MSG_COLORLABEL_FROM_FLAGS(val) (val >> MSG_CLABEL_SBIT)
128
129 #define MSG_IS_MOVE(msg)                (((msg).tmp_flags & MSG_MOVE) != 0)
130 #define MSG_IS_COPY(msg)                (((msg).tmp_flags & MSG_COPY) != 0)
131
132 #define MSG_IS_QUEUED(msg)              (((msg).tmp_flags & MSG_QUEUED) != 0)
133 #define MSG_IS_DRAFT(msg)               (((msg).tmp_flags & MSG_DRAFT) != 0)
134 #define MSG_IS_ENCRYPTED(msg)           (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
135 #define MSG_IS_SIGNED(msg)              (((msg).tmp_flags & MSG_SIGNED) != 0)
136 #define MSG_IS_IMAP(msg)                (((msg).tmp_flags & MSG_IMAP) != 0)
137 #define MSG_IS_NEWS(msg)                (((msg).tmp_flags & MSG_NEWS) != 0)
138 #define MSG_IS_MULTIPART(msg)           (((msg).tmp_flags & MSG_MULTIPART) != 0)
139 #define MSG_IS_WITH_ATTACHMENT(msg)     (((msg).tmp_flags & MSG_HAS_ATTACHMENT) != 0)
140 #define MSG_IS_SCANNED(msg)             (((msg).tmp_flags & MSG_SCANNED) != 0)
141
142 /* Claws related flags */
143 #define MSG_IS_REALLY_DELETED(msg)      (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
144 #define MSG_IS_IGNORE_THREAD(msg)       (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
145 #define MSG_IS_RETRCPT_PENDING(msg)     (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
146 #define MSG_IS_RETRCPT_SENT(msg)        (((msg).perm_flags & MSG_RETRCPT_SENT) != 0)
147
148 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
149 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
150 #define MAIL_POSTFILTERING_HOOKLIST "mail_postfiltering_hooklist"
151
152 typedef enum {
153         MSGINFO_UPDATE_FLAGS = 1 << 0,
154         MSGINFO_UPDATE_DELETED = 1 << 1
155 } MsgInfoUpdateFlags;
156
157 #include "procmime.h"
158 #include "prefs_filtering.h"
159 #include "folder.h"
160
161 struct _MsgFlags
162 {
163         MsgPermFlags perm_flags;
164         MsgTmpFlags  tmp_flags;
165 };
166
167
168 struct _MsgInfo
169 {
170         guint refcnt;
171
172         guint  msgnum;
173         off_t  size;
174         time_t mtime;
175         time_t date_t;
176
177         MsgFlags flags;
178
179         gchar *fromname;
180
181         gchar *date;
182         gchar *from;
183         gchar *to;
184         gchar *cc;
185         gchar *newsgroups;
186         gchar *subject;
187         gchar *msgid;
188         gchar *inreplyto;
189         gchar *xref;
190
191         FolderItem *folder;
192         FolderItem *to_folder;
193
194         FolderItem *to_filter_folder;   
195         gboolean is_move;
196         gboolean is_copy;
197
198         gchar *xface;
199         gchar *face;
200
201         gchar *dispositionnotificationto;
202         gchar *returnreceiptto;
203
204         GSList *references;
205         gchar *fromspace;
206
207         gint score;
208
209         /* used only for encrypted messages */
210         gchar *plaintext_file;
211         
212         gint hidden;
213         
214         /* used only for partially received messages */
215         gchar *partial_recv;
216         gint total_size;
217         gchar *account_server;
218         gchar *account_login;
219         gint planned_download;
220 };
221
222 struct _MsgFileInfo
223 {
224         MsgInfo *msginfo;
225         gchar *file;
226         MsgFlags *flags;
227 };
228
229 struct _MsgInfoUpdate {
230         MsgInfo *msginfo;
231         MsgInfoUpdateFlags flags;
232 };
233
234 struct _MailFilteringData
235 {
236         MsgInfo *msginfo;
237 };
238
239 GHashTable *procmsg_msg_hash_table_create       (GSList         *mlist);
240 void procmsg_msg_hash_table_append              (GHashTable     *msg_table,
241                                                  GSList         *mlist);
242 GHashTable *procmsg_to_folder_hash_table_create (GSList         *mlist);
243
244 GSList *procmsg_read_cache              (FolderItem     *item,
245                                          gboolean        scan_file);
246 gint    procmsg_get_last_num_in_msg_list(GSList         *mlist);
247 void    procmsg_msg_list_free           (GSList         *mlist);
248 void    procmsg_get_mark_sum            (const gchar    *folder,
249                                          gint           *new_msgs,
250                                          gint           *unread_msgs,
251                                          gint           *total_msgs,
252                                          gint           *min,
253                                          gint           *max,
254                                          gint            first);
255
256 GNode  *procmsg_get_thread_tree         (GSList         *mlist);
257
258 gint    procmsg_move_messages           (GSList         *mlist);
259 void    procmsg_copy_messages           (GSList         *mlist);
260
261 /* return path is locale charset */
262 gchar  *procmsg_get_message_file_path   (MsgInfo        *msginfo);
263 gchar  *procmsg_get_message_file        (MsgInfo        *msginfo);
264 gchar  *procmsg_get_message_file_full   (MsgInfo        *msginfo, 
265                                          gboolean        get_headers,
266                                          gboolean        get_body);
267 GSList *procmsg_get_message_file_list   (MsgInfoList    *mlist);
268 void    procmsg_message_file_list_free  (MsgInfoList    *file_list);
269 FILE   *procmsg_open_message            (MsgInfo        *msginfo);
270 gboolean procmsg_msg_exist              (MsgInfo        *msginfo);
271
272 void    procmsg_get_filter_keyword      (MsgInfo          *msginfo,
273                                          gchar           **header,
274                                          gchar           **key,
275                                          PrefsFilterType   type);
276
277 void    procmsg_empty_trash             (FolderItem     *trash);
278 void    procmsg_empty_all_trash         (void);
279
280 gint    procmsg_send_queue              (FolderItem     *queue,
281                                          gboolean        save_msgs);
282 gboolean procmsg_queue_is_empty (FolderItem *queue);
283 gint    procmsg_save_to_outbox          (FolderItem     *outbox,
284                                          const gchar    *file,
285                                          gboolean        is_queued);
286 void    procmsg_print_message           (MsgInfo        *msginfo,
287                                          const gchar    *cmdline);
288
289 MsgInfo *procmsg_msginfo_new            ();
290 MsgInfo *procmsg_msginfo_new_ref        (MsgInfo        *msginfo);
291 MsgInfo *procmsg_msginfo_copy           (MsgInfo        *msginfo);
292 MsgInfo *procmsg_msginfo_get_full_info  (MsgInfo        *msginfo);
293 void     procmsg_msginfo_free           (MsgInfo        *msginfo);
294 guint    procmsg_msginfo_memusage       (MsgInfo        *msginfo);
295
296 gint procmsg_cmp_msgnum_for_sort        (gconstpointer   a,
297                                          gconstpointer   b);
298 gint procmsg_send_message_queue         (const gchar *file);
299
300 void procmsg_msginfo_set_flags          (MsgInfo *msginfo,
301                                          MsgPermFlags perm_flags,
302                                          MsgTmpFlags tmp_flags);
303 void procmsg_msginfo_unset_flags        (MsgInfo *msginfo,
304                                          MsgPermFlags perm_flags,
305                                          MsgTmpFlags tmp_flags);
306 void procmsg_msginfo_change_flags       (MsgInfo *msginfo, 
307                                          MsgPermFlags add_perm_flags, 
308                                          MsgTmpFlags add_tmp_flags,
309                                          MsgPermFlags rem_perm_flags, 
310                                          MsgTmpFlags rem_tmp_flags);
311 gint procmsg_remove_special_headers     (const gchar    *in, 
312                                          const gchar    *out);
313
314 gboolean procmsg_msg_has_flagged_parent (MsgInfo        *info,
315                                          MsgPermFlags    perm_flags);
316 gboolean procmsg_msg_has_marked_parent  (MsgInfo        *info);
317 GSList *procmsg_find_children           (MsgInfo        *info);
318 void procmsg_update_unread_children     (MsgInfo        *info,
319                                          gboolean        newly_marked);
320 void procmsg_msginfo_set_to_folder      (MsgInfo        *msginfo,
321                                          FolderItem     *to_folder);
322 gboolean procmsg_msginfo_filter         (MsgInfo        *msginfo);
323 MsgInfo *procmsg_msginfo_new_from_mimeinfo
324                                         (MsgInfo        *src_msginfo, 
325                                          MimeInfo       *mimeinfo);
326
327 #endif /* __PROCMSG_H__ */