98cefd569744b44aff2cf08a3f85470117c13fc6
[claws.git] / src / procmsg.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2002 Hiroyuki Yamamoto
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 _MsgInfoUpdate   MsgInfoUpdate;
36
37 typedef enum
38 {
39         MSG_NEW         = 1 << 0,
40         MSG_UNREAD      = 1 << 1,
41         MSG_MARKED      = 1 << 2,
42         MSG_DELETED     = 1 << 3,
43         MSG_REPLIED     = 1 << 4,
44         MSG_FORWARDED   = 1 << 5,
45         
46         MSG_REALLY_DELETED = 1 << 6,            /* mbox stuff */
47
48 #define MSG_CLABEL_SBIT (7)             /* start bit of color label */
49 #define MAKE_MSG_CLABEL(h, m, l)        (((h) << (MSG_CLABEL_SBIT + 2)) | \
50                                          ((m) << (MSG_CLABEL_SBIT + 1)) | \
51                                          ((l) << (MSG_CLABEL_SBIT + 0)))
52
53         MSG_CLABEL_NONE = MAKE_MSG_CLABEL(0, 0, 0),
54         MSG_CLABEL_1    = MAKE_MSG_CLABEL(0, 0, 1),
55         MSG_CLABEL_2    = MAKE_MSG_CLABEL(0, 1, 0),
56         MSG_CLABEL_3    = MAKE_MSG_CLABEL(0, 1, 1),
57         MSG_CLABEL_4    = MAKE_MSG_CLABEL(1, 0, 0),
58         MSG_CLABEL_5    = MAKE_MSG_CLABEL(1, 0, 1),
59         MSG_CLABEL_6    = MAKE_MSG_CLABEL(1, 1, 0),
60         MSG_CLABEL_7    = MAKE_MSG_CLABEL(1, 1, 1),
61
62 #define MSG_CLABEL_ORANGE       MSG_CLABEL_1
63 #define MSG_CLABEL_RED          MSG_CLABEL_2
64 #define MSG_CLABEL_PINK         MSG_CLABEL_3
65 #define MSG_CLABEL_SKYBLUE      MSG_CLABEL_4
66 #define MSG_CLABEL_BLUE         MSG_CLABEL_5
67 #define MSG_CLABEL_GREEN        MSG_CLABEL_6
68 #define MSG_CLABEL_BROWN        MSG_CLABEL_7
69
70         MSG_IGNORE_THREAD   = 1 << 10,   /* ignore threads */
71         MSG_LOCKED          = 1 << 11,   /* msg is locked  */
72         MSG_RETRCPT_PENDING = 1 << 12,   /* return receipt pending */
73
74         /* RESERVED */
75         MSG_RESERVED_CLAWS  = 1 << 30,  /* for sylpheed-claws */
76         MSG_RESERVED_MAIN   = 1 << 31   /* for sylpheed-main  */
77 } MsgPermFlags;
78
79 #define MSG_CLABEL_FLAG_MASK    (MSG_CLABEL_7)
80
81 typedef enum
82 {
83         MSG_MOVE        = 1 << 0,
84         MSG_COPY        = 1 << 1,
85
86         MSG_QUEUED      = 1 << 16,
87         MSG_DRAFT       = 1 << 17,
88         MSG_ENCRYPTED   = 1 << 18,
89         MSG_IMAP        = 1 << 19,
90         MSG_NEWS        = 1 << 20,
91         MSG_SIGNED      = 1 << 21,
92
93         MSG_MIME        = 1 << 29,
94
95         MSG_CACHED      = 1 << 31
96 } MsgTmpFlags;
97
98 #define MSG_CACHED_FLAG_MASK    (MSG_MIME | MSG_ENCRYPTED | MSG_SIGNED)
99
100 #define MSG_SET_FLAGS(msg, flags)       { (msg) |= (flags); }
101 #define MSG_UNSET_FLAGS(msg, flags)     { (msg) &= ~(flags); }
102 #define MSG_SET_PERM_FLAGS(msg, flags) \
103         MSG_SET_FLAGS((msg).perm_flags, flags)
104 #define MSG_SET_TMP_FLAGS(msg, flags) \
105         MSG_SET_FLAGS((msg).tmp_flags, flags)
106 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
107         MSG_UNSET_FLAGS((msg).perm_flags, flags)
108 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
109         MSG_UNSET_FLAGS((msg).tmp_flags, flags)
110
111 #define MSG_IS_NEW(msg)                 (((msg).perm_flags & MSG_NEW) != 0)
112 #define MSG_IS_UNREAD(msg)              (((msg).perm_flags & MSG_UNREAD) != 0)
113 #define MSG_IS_MARKED(msg)              (((msg).perm_flags & MSG_MARKED) != 0)
114 #define MSG_IS_DELETED(msg)             (((msg).perm_flags & MSG_DELETED) != 0)
115 #define MSG_IS_REPLIED(msg)             (((msg).perm_flags & MSG_REPLIED) != 0)
116 #define MSG_IS_LOCKED(msg)              (((msg).perm_flags & MSG_LOCKED) != 0)
117 #define MSG_IS_FORWARDED(msg)           (((msg).perm_flags & MSG_FORWARDED) != 0)
118
119 #define MSG_GET_COLORLABEL(msg)         (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
120 #define MSG_GET_COLORLABEL_VALUE(msg)   (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
121 #define MSG_SET_COLORLABEL_VALUE(msg, val) \
122         MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
123
124 #define MSG_COLORLABEL_TO_FLAGS(val) ((((guint)(val)) & 7) << MSG_CLABEL_SBIT)
125 #define MSG_COLORLABEL_FROM_FLAGS(val) (val >> MSG_CLABEL_SBIT)
126
127 #define MSG_IS_MOVE(msg)                (((msg).tmp_flags & MSG_MOVE) != 0)
128 #define MSG_IS_COPY(msg)                (((msg).tmp_flags & MSG_COPY) != 0)
129
130 #define MSG_IS_QUEUED(msg)              (((msg).tmp_flags & MSG_QUEUED) != 0)
131 #define MSG_IS_DRAFT(msg)               (((msg).tmp_flags & MSG_DRAFT) != 0)
132 #define MSG_IS_ENCRYPTED(msg)           (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
133 #define MSG_IS_SIGNED(msg)              (((msg).tmp_flags & MSG_SIGNED) != 0)
134 #define MSG_IS_IMAP(msg)                (((msg).tmp_flags & MSG_IMAP) != 0)
135 #define MSG_IS_NEWS(msg)                (((msg).tmp_flags & MSG_NEWS) != 0)
136 #define MSG_IS_MIME(msg)                (((msg).tmp_flags & MSG_MIME) != 0)
137 #define MSG_IS_CACHED(msg)              (((msg).tmp_flags & MSG_CACHED) != 0)
138
139 /* Claws related flags */
140 #define MSG_IS_REALLY_DELETED(msg)      (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
141 #define MSG_IS_IGNORE_THREAD(msg)       (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
142 #define MSG_IS_RETRCPT_PENDING(msg)     (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
143
144 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
145
146 #include "folder.h"
147 #include "procmime.h"
148
149 struct _MsgFlags
150 {
151         MsgPermFlags perm_flags;
152         MsgTmpFlags  tmp_flags;
153 };
154
155 struct _MsgInfo
156 {
157         guint refcnt;
158
159         guint  msgnum;
160         off_t  size;
161         time_t mtime;
162         time_t date_t;
163
164         MsgFlags flags;
165
166         gchar *fromname;
167
168         gchar *date;
169         gchar *from;
170         gchar *to;
171         gchar *cc;
172         gchar *newsgroups;
173         gchar *subject;
174         gchar *msgid;
175         gchar *inreplyto;
176         gchar *xref;
177
178         FolderItem *folder;
179         FolderItem *to_folder;
180
181         gchar *xface;
182
183         gchar *dispositionnotificationto;
184         gchar *returnreceiptto;
185
186         gchar *references;
187         gchar *fromspace;
188
189         gint score;
190         gint threadscore;
191
192         /* used only for encrypted messages */
193         gchar *plaintext_file;
194         guint decryption_failed : 1;
195 };
196
197 struct _MsgInfoUpdate {
198         MsgInfo *msginfo;
199 };
200
201 GHashTable *procmsg_msg_hash_table_create       (GSList         *mlist);
202 void procmsg_msg_hash_table_append              (GHashTable     *msg_table,
203                                                  GSList         *mlist);
204 GHashTable *procmsg_to_folder_hash_table_create (GSList         *mlist);
205
206 GSList *procmsg_read_cache              (FolderItem     *item,
207                                          gboolean        scan_file);
208 gint    procmsg_get_last_num_in_msg_list(GSList         *mlist);
209 void    procmsg_msg_list_free           (GSList         *mlist);
210 void    procmsg_get_mark_sum            (const gchar    *folder,
211                                          gint           *new,
212                                          gint           *unread,
213                                          gint           *total,
214                                          gint           *min,
215                                          gint           *max,
216                                          gint            first);
217
218 GNode  *procmsg_get_thread_tree         (GSList         *mlist);
219
220 void    procmsg_move_messages           (GSList         *mlist);
221 void    procmsg_copy_messages           (GSList         *mlist);
222
223 gchar  *procmsg_get_message_file_path   (MsgInfo        *msginfo);
224 gchar  *procmsg_get_message_file        (MsgInfo        *msginfo);
225 FILE   *procmsg_open_message            (MsgInfo        *msginfo);
226 #if USE_GPGME
227 FILE   *procmsg_open_message_decrypted  (MsgInfo        *msginfo,
228                                          MimeInfo      **mimeinfo);
229 #endif
230 gboolean procmsg_msg_exist              (MsgInfo        *msginfo);
231
232 void    procmsg_empty_trash             (void);
233 gint    procmsg_send_queue              (FolderItem     *queue,
234                                          gboolean        save_msgs);
235 gint    procmsg_save_to_outbox          (FolderItem     *outbox,
236                                          const gchar    *file,
237                                          gboolean        is_queued);
238 void    procmsg_print_message           (MsgInfo        *msginfo,
239                                          const gchar    *cmdline);
240
241 MsgInfo *procmsg_msginfo_new            ();
242 MsgInfo *procmsg_msginfo_new_ref        (MsgInfo        *msginfo);
243 MsgInfo *procmsg_msginfo_copy           (MsgInfo        *msginfo);
244 MsgInfo *procmsg_msginfo_get_full_info  (MsgInfo        *msginfo);
245 void     procmsg_msginfo_free           (MsgInfo        *msginfo);
246 guint    procmsg_msginfo_memusage       (MsgInfo        *msginfo);
247
248 gint procmsg_cmp_msgnum_for_sort        (gconstpointer   a,
249                                          gconstpointer   b);
250 gint procmsg_send_message_queue         (const gchar *file);
251
252 void procmsg_msginfo_set_flags          (MsgInfo *msginfo,
253                                          MsgPermFlags perm_flags,
254                                           MsgTmpFlags tmp_flags);
255 void procmsg_msginfo_unset_flags        (MsgInfo *msginfo,
256                                          MsgPermFlags perm_flags,
257                                           MsgTmpFlags tmp_flags);
258 gint procmsg_remove_special_headers     (const gchar    *in, 
259                                          const gchar    *out);
260
261 gboolean procmsg_msg_has_flagged_parent (MsgInfo        *info,
262                                          MsgPermFlags    perm_flags);
263 gboolean procmsg_msg_has_marked_parent  (MsgInfo        *info);
264 GSList *procmsg_find_children           (MsgInfo        *info);
265 void procmsg_update_unread_children     (MsgInfo        *info,
266                                          gboolean        newly_marked);
267 void procmsg_msginfo_set_to_folder      (MsgInfo        *msginfo,
268                                          FolderItem     *to_folder);
269 #endif /* __PROCMSG_H__ */