2012-10-10 [colin] 3.8.1cvs91
[claws.git] / src / procmsg.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2012 Hiroyuki Yamamoto and the Claws Mail 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 3 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, see <http://www.gnu.org/licenses/>.
17  * 
18  */
19
20 #ifndef __PROCMSG_H__
21 #define __PROCMSG_H__
22
23 #ifdef HAVE_CONFIG_H
24 #include "claws-features.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 #include "utils.h"
33 #include "proctypes.h"
34
35 #define MSG_NEW                 (1U << 0)
36 #define MSG_UNREAD              (1U << 1)
37 #define MSG_MARKED              (1U << 2)
38 #define MSG_DELETED             (1U << 3)
39 #define MSG_REPLIED             (1U << 4)
40 #define MSG_FORWARDED           (1U << 5)
41
42 #define MSG_CLABEL_SBIT (6)             /* start bit of color label */
43 /* color labels use 4 bits: 6, 7, 8, 9; bit weight is 7<8<9<6,
44   IOW the color label value itself must be computed from MsgPermFlags
45   bits like this:
46   value =   bit-7-value*2^0
47           + bit-8-value*2^1
48           + bit-9-value*2^2
49           + bit-6-value*2^3 */
50
51 /* color label permflags masks */
52 #define MAKE_MSG_CLABEL(x, h, m, l)     (\
53                                          ((x) << (MSG_CLABEL_SBIT + 0)) | \
54                                          ((h) << (MSG_CLABEL_SBIT + 3)) | \
55                                          ((m) << (MSG_CLABEL_SBIT + 2)) | \
56                                          ((l) << (MSG_CLABEL_SBIT + 1)))
57 #define MSG_CLABEL_NONE         MAKE_MSG_CLABEL(0U, 0U, 0U, 0U)
58 #define MSG_CLABEL_1            MAKE_MSG_CLABEL(0U, 0U, 0U, 1U)
59 #define MSG_CLABEL_2            MAKE_MSG_CLABEL(0U, 0U, 1U, 0U)
60 #define MSG_CLABEL_3            MAKE_MSG_CLABEL(0U, 0U, 1U, 1U)
61 #define MSG_CLABEL_4            MAKE_MSG_CLABEL(0U, 1U, 0U, 0U)
62 #define MSG_CLABEL_5            MAKE_MSG_CLABEL(0U, 1U, 0U, 1U)
63 #define MSG_CLABEL_6            MAKE_MSG_CLABEL(0U, 1U, 1U, 0U)
64 #define MSG_CLABEL_7            MAKE_MSG_CLABEL(0U, 1U, 1U, 1U)
65 #define MSG_CLABEL_8            MAKE_MSG_CLABEL(1U, 0U, 0U, 0U)
66 #define MSG_CLABEL_9            MAKE_MSG_CLABEL(1U, 0U, 0U, 1U)
67 #define MSG_CLABEL_10           MAKE_MSG_CLABEL(1U, 0U, 1U, 0U)
68 #define MSG_CLABEL_11           MAKE_MSG_CLABEL(1U, 0U, 1U, 1U)
69 #define MSG_CLABEL_12           MAKE_MSG_CLABEL(1U, 1U, 0U, 0U)
70 #define MSG_CLABEL_13           MAKE_MSG_CLABEL(1U, 1U, 0U, 1U)
71 #define MSG_CLABEL_14           MAKE_MSG_CLABEL(1U, 1U, 1U, 0U)
72 #define MSG_CLABEL_15           MAKE_MSG_CLABEL(1U, 1U, 1U, 1U)
73 #define MSG_CLABEL_FLAG_MASK    (MSG_CLABEL_15)
74
75 #define MSG_IGNORE_THREAD       (1U << 10)   /* ignore threads */
76 #define MSG_LOCKED              (1U << 11)   /* msg is locked  */
77 #define MSG_RETRCPT_SENT        (1U << 12)   /* new one */ 
78 #define MSG_SPAM                (1U << 13)   /* new one */ 
79 #define MSG_POSTFILTERED        (1U << 14)
80 #define MSG_WATCH_THREAD        (1U << 15)   /* watch threads */
81 #define MSG_FULLY_CACHED        (1U << 16)   /* IMAP: fully cached */
82 #define MSG_RETRCPT_GOT         (1U << 17)   /* got return receipt */
83         
84 /* RESERVED */
85 #define MSG_RESERVED_CLAWS      (1U << 30)   /* for claws-mail */
86 #define MSG_RESERVED            (1U << 31)
87
88 #define MSG_MOVE                (1U << 0)
89 #define MSG_COPY                (1U << 1)
90 #define MSG_MOVE_DONE           (1U << 15)              
91 #define MSG_QUEUED              (1U << 16)
92 #define MSG_DRAFT               (1U << 17)
93 #define MSG_ENCRYPTED           (1U << 18)
94 #define MSG_IMAP                (1U << 19)
95 #define MSG_NEWS                (1U << 20)
96 #define MSG_SIGNED              (1U << 21)
97 #define MSG_MULTIPART           (1U << 29)
98 #define MSG_HAS_ATTACHMENT      (1U << 30)
99 #define MSG_SCANNED             (1U << 31)
100
101 #define MSG_CACHED_FLAG_MASK    (MSG_MULTIPART | MSG_ENCRYPTED | MSG_SIGNED | MSG_HAS_ATTACHMENT | MSG_SCANNED)
102
103 #define MSG_SET_FLAGS(msg, flags)       { (msg) |= (flags); }
104 #define MSG_UNSET_FLAGS(msg, flags)     { (msg) &= ~(flags); }
105 #define MSG_SET_PERM_FLAGS(msg, flags) \
106         MSG_SET_FLAGS((msg).perm_flags, flags)
107 #define MSG_SET_TMP_FLAGS(msg, flags) \
108         MSG_SET_FLAGS((msg).tmp_flags, flags)
109 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
110         MSG_UNSET_FLAGS((msg).perm_flags, flags)
111 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
112         MSG_UNSET_FLAGS((msg).tmp_flags, flags)
113
114 #define MSG_IS_NEW(msg)                 (((msg).perm_flags & MSG_NEW) != 0)
115 #define MSG_IS_UNREAD(msg)              (((msg).perm_flags & MSG_UNREAD) != 0)
116 #define MSG_IS_MARKED(msg)              (((msg).perm_flags & MSG_MARKED) != 0)
117 #define MSG_IS_DELETED(msg)             (((msg).perm_flags & MSG_DELETED) != 0)
118 #define MSG_IS_REPLIED(msg)             (((msg).perm_flags & MSG_REPLIED) != 0)
119 #define MSG_IS_LOCKED(msg)              (((msg).perm_flags & MSG_LOCKED) != 0)
120 #define MSG_IS_FORWARDED(msg)           (((msg).perm_flags & MSG_FORWARDED) != 0)
121 #define MSG_IS_POSTFILTERED(msg)        (((msg).perm_flags & MSG_POSTFILTERED) != 0)
122
123 /* color label decoding/encoding (permflag storage bits <-> color list index value)*/
124 #define MSG_COLORLABEL_TO_FLAGS(val) (((((guint)(val)) & 7) << (MSG_CLABEL_SBIT+1)) \
125                                                                           | (((guint)(val) & 8) << (MSG_CLABEL_SBIT-3)))
126 #define MSG_COLORLABEL_FROM_FLAGS(val) ((((guint)(val) >> (MSG_CLABEL_SBIT+1)) & 7 ) \
127                                                                                 | (((guint)(val) >> (MSG_CLABEL_SBIT-3)) & 8))
128 #define MSG_GET_COLORLABEL(msg)         (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
129 #define MSG_GET_COLORLABEL_VALUE(msg)   (MSG_COLORLABEL_FROM_FLAGS(MSG_GET_COLORLABEL(msg)))
130 #define MSG_SET_COLORLABEL_VALUE(msg, val)      MSG_SET_PERM_FLAGS(msg, MSG_COLORLABEL_TO_FLAGS(val))
131
132 #define MSG_IS_MOVE(msg)                (((msg).tmp_flags & MSG_MOVE) != 0)
133 #define MSG_IS_COPY(msg)                (((msg).tmp_flags & MSG_COPY) != 0)
134 #define MSG_IS_MOVE_DONE(msg)           (((msg).tmp_flags & MSG_MOVE_DONE) != 0)
135
136 #define MSG_IS_QUEUED(msg)              (((msg).tmp_flags & MSG_QUEUED) != 0)
137 #define MSG_IS_DRAFT(msg)               (((msg).tmp_flags & MSG_DRAFT) != 0)
138 #define MSG_IS_ENCRYPTED(msg)           (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
139 #define MSG_IS_SIGNED(msg)              (((msg).tmp_flags & MSG_SIGNED) != 0)
140 #define MSG_IS_IMAP(msg)                (((msg).tmp_flags & MSG_IMAP) != 0)
141 #define MSG_IS_NEWS(msg)                (((msg).tmp_flags & MSG_NEWS) != 0)
142 #define MSG_IS_MULTIPART(msg)           (((msg).tmp_flags & MSG_MULTIPART) != 0)
143 #define MSG_IS_WITH_ATTACHMENT(msg)     (((msg).tmp_flags & MSG_HAS_ATTACHMENT) != 0)
144 #define MSG_IS_SCANNED(msg)             (((msg).tmp_flags & MSG_SCANNED) != 0)
145
146 /* Claws related flags */
147 #define MSG_IS_REALLY_DELETED(msg)      (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
148 #define MSG_IS_IGNORE_THREAD(msg)       (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
149 #define MSG_IS_RETRCPT_PENDING(msg)     (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
150 #define MSG_IS_RETRCPT_SENT(msg)        (((msg).perm_flags & MSG_RETRCPT_SENT) != 0)
151 #define MSG_IS_RETRCPT_GOT(msg)         (((msg).perm_flags & MSG_RETRCPT_GOT) != 0)
152 #define MSG_IS_SPAM(msg)                (((msg).perm_flags & MSG_SPAM) != 0)
153 #define MSG_IS_WATCH_THREAD(msg)        (((msg).perm_flags & MSG_WATCH_THREAD) != 0)
154 #define MSG_IS_FULLY_CACHED(msg)        (((msg).perm_flags & MSG_FULLY_CACHED) != 0)
155
156 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
157 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
158 #define MAIL_LISTFILTERING_HOOKLIST "mail_listfiltering_hooklist"
159 #define MAIL_POSTFILTERING_HOOKLIST "mail_postfiltering_hooklist"
160
161 typedef enum {
162         MSGINFO_UPDATE_FLAGS = 1 << 0,
163         MSGINFO_UPDATE_DELETED = 1 << 1
164 } MsgInfoUpdateFlags;
165
166 #include "prefs_account.h"
167 #include "prefs_filtering.h"
168 #include "folder.h"
169
170 struct _MsgFlags
171 {
172         MsgPermFlags perm_flags;
173         MsgTmpFlags  tmp_flags;
174 };
175
176 typedef enum {
177         IS_NOTHING = 0,
178         IS_MOVE,
179         IS_COPY,
180         IS_DELE
181 } FiltOp;
182
183 /* *********************************************************** *
184  * WARNING: When adding or removing members to this structure, *
185  * be sure to update procmsg.c::procmsg_msginfo_memusage()  to *
186  * avoid underestimating cache memory usage - especially since *
187  * this would cause an overflow and metadata loss when writing *
188  * the cache to disk.                                          *
189  * *********************************************************** */
190 struct _MsgInfo
191 {
192         guint refcnt;
193
194         guint  msgnum;
195         goffset  size;
196         time_t mtime;
197         time_t date_t;
198         time_t thread_date;
199
200         MsgFlags flags;
201
202         gchar *fromname;
203
204         gchar *date;
205         gchar *from;
206         gchar *to;
207         gchar *cc;
208         gchar *newsgroups;
209         gchar *subject;
210         gchar *msgid;
211         gchar *inreplyto;
212         gchar *xref;
213
214         FolderItem *folder;
215         FolderItem *to_folder;
216
217         FolderItem *to_filter_folder;   
218         FiltOp filter_op;
219
220         GSList *references;
221         gchar *fromspace;
222
223         gint score;
224
225         /* used only for encrypted messages */
226         gchar *plaintext_file;
227         
228         gint hidden;
229
230         /* used only for partially received messages */
231         gint total_size;
232         gint planned_download;
233
234         /* list of tags ids */
235         GSList *tags;
236
237         MsgInfoExtraData *extradata;
238 };
239
240 struct _MsgInfoExtraData
241 {
242         gchar *xface;
243         gchar *face;
244
245         gchar *dispositionnotificationto;
246         gchar *returnreceiptto;
247
248         /* used only for partially received messages */
249         gchar *partial_recv;
250         gchar *account_server;
251         gchar *account_login;
252
253         /* Mailing list support */
254         gchar *list_post;
255         gchar *list_subscribe;
256         gchar *list_unsubscribe;
257         gchar *list_help;
258         gchar *list_archive;
259         gchar *list_owner;
260 };
261
262 struct _MsgFileInfo
263 {
264         MsgInfo *msginfo;
265         gchar *file;
266         MsgFlags *flags;
267 };
268
269 struct _MsgInfoUpdate {
270         MsgInfo *msginfo;
271         MsgInfoUpdateFlags flags;
272 };
273
274 struct _MailFilteringData
275 {
276         MsgInfo *msginfo;
277         GSList  *msglist;
278         GSList  *filtered;
279         GSList  *unfiltered;
280         PrefsAccount *account;
281 };
282
283 GSList *procmsg_read_cache              (FolderItem     *item,
284                                          gboolean        scan_file);
285 void    procmsg_msg_list_free           (MsgInfoList    *mlist);
286 MsgNumberList *procmsg_get_number_list_for_msgs(MsgInfoList *msglist);
287 void    procmsg_get_mark_sum            (const gchar    *folder,
288                                          gint           *new_msgs,
289                                          gint           *unread_msgs,
290                                          gint           *total_msgs,
291                                          gint           *min,
292                                          gint           *max,
293                                          gint            first);
294
295 GNode  *procmsg_get_thread_tree         (GSList         *mlist);
296
297 gint    procmsg_move_messages           (GSList         *mlist);
298 void    procmsg_copy_messages           (GSList         *mlist);
299
300 /* return path is locale charset */
301 gchar  *procmsg_get_message_file_path   (MsgInfo        *msginfo);
302 gchar  *procmsg_get_message_file        (MsgInfo        *msginfo);
303 gchar  *procmsg_get_message_file_full   (MsgInfo        *msginfo, 
304                                          gboolean        get_headers,
305                                          gboolean        get_body);
306 GSList *procmsg_get_message_file_list   (MsgInfoList    *mlist);
307 void    procmsg_message_file_list_free  (MsgInfoList    *file_list);
308 FILE   *procmsg_open_message            (MsgInfo        *msginfo);
309 gboolean procmsg_msg_exist              (MsgInfo        *msginfo);
310
311 void    procmsg_get_filter_keyword      (MsgInfo          *msginfo,
312                                          gchar           **header,
313                                          gchar           **key,
314                                          PrefsFilterType   type);
315
316 void    procmsg_empty_all_trash         (void);
317
318 gint    procmsg_send_queue              (FolderItem     *queue,
319                                          gboolean        save_msgs,
320                                          gchar          **errstr);
321 gboolean procmsg_queue_lock             (gchar          **errstr);
322 void     procmsg_queue_unlock           (void);
323 gboolean procmsg_queue_is_empty (FolderItem *queue);
324 void    procmsg_print_message           (MsgInfo        *msginfo,
325                                          const gchar    *cmdline);
326
327 MsgInfo *procmsg_msginfo_new            ();
328 MsgInfo *procmsg_msginfo_new_ref        (MsgInfo        *msginfo);
329 MsgInfo *procmsg_msginfo_copy           (MsgInfo        *msginfo);
330 MsgInfo *procmsg_msginfo_get_full_info  (MsgInfo        *msginfo);
331 MsgInfo *procmsg_msginfo_get_full_info_from_file
332                                         (MsgInfo *msginfo, 
333                                         const gchar *file);
334 void     procmsg_msginfo_free           (MsgInfo        *msginfo);
335 guint    procmsg_msginfo_memusage       (MsgInfo        *msginfo);
336
337 gint procmsg_send_message_queue_with_lock(const gchar *file,
338                                           gchar **errstr,
339                                           FolderItem *queue,
340                                           gint msgnum,
341                                           gboolean *queued_removed);
342
343 gint procmsg_send_message_queue         (const gchar *file,
344                                          gchar **errstr,
345                                          FolderItem *queue, 
346                                          gint msgnum,
347                                          gboolean *queued_removed);
348
349 void procmsg_msginfo_set_flags          (MsgInfo *msginfo,
350                                          MsgPermFlags perm_flags,
351                                          MsgTmpFlags tmp_flags);
352 void procmsg_msginfo_unset_flags        (MsgInfo *msginfo,
353                                          MsgPermFlags perm_flags,
354                                          MsgTmpFlags tmp_flags);
355 void procmsg_msginfo_change_flags       (MsgInfo *msginfo, 
356                                          MsgPermFlags add_perm_flags, 
357                                          MsgTmpFlags add_tmp_flags,
358                                          MsgPermFlags rem_perm_flags, 
359                                          MsgTmpFlags rem_tmp_flags);
360 gint procmsg_remove_special_headers     (const gchar    *in, 
361                                          const gchar    *out);
362
363 gboolean procmsg_msg_has_flagged_parent (MsgInfo        *info,
364                                          MsgPermFlags    perm_flags);
365 gboolean procmsg_msg_has_marked_parent  (MsgInfo        *info);
366 void procmsg_msginfo_set_to_folder      (MsgInfo        *msginfo,
367                                          FolderItem     *to_folder);
368 void procmsg_msglist_filter             (GSList         *list, 
369                                          PrefsAccount   *ac, 
370                                          GSList         **filtered,
371                                          GSList         **unfiltered,
372                                          gboolean        do_filter);
373
374 MsgInfo *procmsg_msginfo_new_from_mimeinfo
375                                         (MsgInfo        *src_msginfo, 
376                                          MimeInfo       *mimeinfo);
377
378 void procmsg_register_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
379 void procmsg_unregister_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
380 gboolean procmsg_spam_can_learn         (void);
381 void procmsg_spam_set_folder            (const char *item_identifier, FolderItem *(*spam_get_folder_func)(MsgInfo *info));
382 FolderItem *procmsg_spam_get_folder     (MsgInfo *msginfo);
383 int procmsg_spam_learner_learn  (MsgInfo *msginfo, GSList *msglist, gboolean spam);
384 gboolean procmsg_have_queued_mails_fast (void);
385 gboolean procmsg_have_trashed_mails_fast (void);
386 gboolean procmsg_is_sending(void);
387 gchar *procmsg_msginfo_get_tags_str(MsgInfo *msginfo);
388 void procmsg_msginfo_update_tags(MsgInfo *msginfo, gboolean set, gint id);
389 void procmsg_msginfo_clear_tags(MsgInfo *msginfo);
390 void procmsg_msginfo_commit_tags(GSList *msglist);
391 MsgInfo *procmsg_get_msginfo_from_identifier(const gchar *id);
392 gchar *procmsg_msginfo_get_identifier(MsgInfo *msginfo);
393 #endif /* __PROCMSG_H__ */