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