2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws team
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.
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.
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.
30 #include <sys/types.h>
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;
39 typedef GSList MsgInfoList;
40 typedef GSList MsgNumberList;
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)
49 #define MSG_CLABEL_SBIT (7) /* start bit of color label */
50 #define MAKE_MSG_CLABEL(h, m, l) (((h) << (MSG_CLABEL_SBIT + 2)) | \
51 ((m) << (MSG_CLABEL_SBIT + 1)) | \
52 ((l) << (MSG_CLABEL_SBIT + 0)))
54 #define MSG_CLABEL_NONE MAKE_MSG_CLABEL(0U, 0U, 0U)
55 #define MSG_CLABEL_1 MAKE_MSG_CLABEL(0U, 0U, 1U)
56 #define MSG_CLABEL_2 MAKE_MSG_CLABEL(0U, 1U, 0U)
57 #define MSG_CLABEL_3 MAKE_MSG_CLABEL(0U, 1U, 1U)
58 #define MSG_CLABEL_4 MAKE_MSG_CLABEL(1U, 0U, 0U)
59 #define MSG_CLABEL_5 MAKE_MSG_CLABEL(1U, 0U, 1U)
60 #define MSG_CLABEL_6 MAKE_MSG_CLABEL(1U, 1U, 0U)
61 #define MSG_CLABEL_7 MAKE_MSG_CLABEL(1U, 1U, 1U)
63 #define MSG_CLABEL_ORANGE MSG_CLABEL_1
64 #define MSG_CLABEL_RED MSG_CLABEL_2
65 #define MSG_CLABEL_PINK MSG_CLABEL_3
66 #define MSG_CLABEL_SKYBLUE MSG_CLABEL_4
67 #define MSG_CLABEL_BLUE MSG_CLABEL_5
68 #define MSG_CLABEL_GREEN MSG_CLABEL_6
69 #define MSG_CLABEL_BROWN MSG_CLABEL_7
71 #define MSG_IGNORE_THREAD (1U << 10) /* ignore threads */
72 #define MSG_LOCKED (1U << 11) /* msg is locked */
73 #define MSG_RETRCPT_SENT (1U << 12) /* new one */
74 #define MSG_SPAM (1U << 13) /* new one */
77 #define MSG_RESERVED_CLAWS (1U << 30) /* for sylpheed-claws */
78 #define MSG_RESERVED (1U << 31)
80 typedef guint32 MsgPermFlags;
82 #define MSG_CLABEL_FLAG_MASK (MSG_CLABEL_7)
84 #define MSG_MOVE (1U << 0)
85 #define MSG_COPY (1U << 1)
86 #define MSG_QUEUED (1U << 16)
87 #define MSG_DRAFT (1U << 17)
88 #define MSG_ENCRYPTED (1U << 18)
89 #define MSG_IMAP (1U << 19)
90 #define MSG_NEWS (1U << 20)
91 #define MSG_SIGNED (1U << 21)
92 #define MSG_MULTIPART (1U << 29)
93 #define MSG_HAS_ATTACHMENT (1U << 30)
94 #define MSG_SCANNED (1U << 31)
96 typedef guint32 MsgTmpFlags;
98 #define MSG_CACHED_FLAG_MASK (MSG_MULTIPART | MSG_ENCRYPTED | MSG_SIGNED | MSG_HAS_ATTACHMENT | MSG_SCANNED)
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)
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)
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))
124 #define MSG_COLORLABEL_TO_FLAGS(val) ((((guint)(val)) & 7) << MSG_CLABEL_SBIT)
125 #define MSG_COLORLABEL_FROM_FLAGS(val) (val >> MSG_CLABEL_SBIT)
127 #define MSG_IS_MOVE(msg) (((msg).tmp_flags & MSG_MOVE) != 0)
128 #define MSG_IS_COPY(msg) (((msg).tmp_flags & MSG_COPY) != 0)
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_MULTIPART(msg) (((msg).tmp_flags & MSG_MULTIPART) != 0)
137 #define MSG_IS_WITH_ATTACHMENT(msg) (((msg).tmp_flags & MSG_HAS_ATTACHMENT) != 0)
138 #define MSG_IS_SCANNED(msg) (((msg).tmp_flags & MSG_SCANNED) != 0)
140 /* Claws related flags */
141 #define MSG_IS_REALLY_DELETED(msg) (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
142 #define MSG_IS_IGNORE_THREAD(msg) (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
143 #define MSG_IS_RETRCPT_PENDING(msg) (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
144 #define MSG_IS_RETRCPT_SENT(msg) (((msg).perm_flags & MSG_RETRCPT_SENT) != 0)
145 #define MSG_IS_SPAM(msg) (((msg).perm_flags & MSG_SPAM) != 0)
147 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
148 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
149 #define MAIL_POSTFILTERING_HOOKLIST "mail_postfiltering_hooklist"
152 MSGINFO_UPDATE_FLAGS = 1 << 0,
153 MSGINFO_UPDATE_DELETED = 1 << 1
154 } MsgInfoUpdateFlags;
156 #include "procmime.h"
157 #include "prefs_filtering.h"
162 MsgPermFlags perm_flags;
163 MsgTmpFlags tmp_flags;
191 FolderItem *to_folder;
193 FolderItem *to_filter_folder;
200 gchar *dispositionnotificationto;
201 gchar *returnreceiptto;
208 /* used only for encrypted messages */
209 gchar *plaintext_file;
213 /* used only for partially received messages */
216 gchar *account_server;
217 gchar *account_login;
218 gint planned_download;
228 struct _MsgInfoUpdate {
230 MsgInfoUpdateFlags flags;
233 struct _MailFilteringData
238 GHashTable *procmsg_msg_hash_table_create (GSList *mlist);
239 void procmsg_msg_hash_table_append (GHashTable *msg_table,
241 GHashTable *procmsg_to_folder_hash_table_create (GSList *mlist);
243 GSList *procmsg_read_cache (FolderItem *item,
245 gint procmsg_get_last_num_in_msg_list(GSList *mlist);
246 void procmsg_msg_list_free (GSList *mlist);
247 void procmsg_get_mark_sum (const gchar *folder,
255 GNode *procmsg_get_thread_tree (GSList *mlist);
257 gint procmsg_move_messages (GSList *mlist);
258 void procmsg_copy_messages (GSList *mlist);
260 /* return path is locale charset */
261 gchar *procmsg_get_message_file_path (MsgInfo *msginfo);
262 gchar *procmsg_get_message_file (MsgInfo *msginfo);
263 gchar *procmsg_get_message_file_full (MsgInfo *msginfo,
264 gboolean get_headers,
266 GSList *procmsg_get_message_file_list (MsgInfoList *mlist);
267 void procmsg_message_file_list_free (MsgInfoList *file_list);
268 FILE *procmsg_open_message (MsgInfo *msginfo);
269 gboolean procmsg_msg_exist (MsgInfo *msginfo);
271 void procmsg_get_filter_keyword (MsgInfo *msginfo,
274 PrefsFilterType type);
276 void procmsg_empty_trash (FolderItem *trash);
277 void procmsg_empty_all_trash (void);
279 gint procmsg_send_queue (FolderItem *queue,
281 gboolean procmsg_queue_is_empty (FolderItem *queue);
282 gint procmsg_save_to_outbox (FolderItem *outbox,
285 void procmsg_print_message (MsgInfo *msginfo,
286 const gchar *cmdline);
288 MsgInfo *procmsg_msginfo_new ();
289 MsgInfo *procmsg_msginfo_new_ref (MsgInfo *msginfo);
290 MsgInfo *procmsg_msginfo_copy (MsgInfo *msginfo);
291 MsgInfo *procmsg_msginfo_get_full_info (MsgInfo *msginfo);
292 void procmsg_msginfo_free (MsgInfo *msginfo);
293 guint procmsg_msginfo_memusage (MsgInfo *msginfo);
295 gint procmsg_cmp_msgnum_for_sort (gconstpointer a,
297 gint procmsg_send_message_queue (const gchar *file);
299 void procmsg_msginfo_set_flags (MsgInfo *msginfo,
300 MsgPermFlags perm_flags,
301 MsgTmpFlags tmp_flags);
302 void procmsg_msginfo_unset_flags (MsgInfo *msginfo,
303 MsgPermFlags perm_flags,
304 MsgTmpFlags tmp_flags);
305 void procmsg_msginfo_change_flags (MsgInfo *msginfo,
306 MsgPermFlags add_perm_flags,
307 MsgTmpFlags add_tmp_flags,
308 MsgPermFlags rem_perm_flags,
309 MsgTmpFlags rem_tmp_flags);
310 gint procmsg_remove_special_headers (const gchar *in,
313 gboolean procmsg_msg_has_flagged_parent (MsgInfo *info,
314 MsgPermFlags perm_flags);
315 gboolean procmsg_msg_has_marked_parent (MsgInfo *info);
316 GSList *procmsg_find_children (MsgInfo *info);
317 void procmsg_update_unread_children (MsgInfo *info,
318 gboolean newly_marked);
319 void procmsg_msginfo_set_to_folder (MsgInfo *msginfo,
320 FolderItem *to_folder);
321 gboolean procmsg_msginfo_filter (MsgInfo *msginfo);
322 MsgInfo *procmsg_msginfo_new_from_mimeinfo
323 (MsgInfo *src_msginfo,
326 void procmsg_register_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
327 void procmsg_unregister_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
328 gboolean procmsg_spam_can_learn (void);
329 void procmsg_spam_set_folder (const char *item_identifier);
330 FolderItem *procmsg_spam_get_folder (void);
331 int procmsg_spam_learner_learn (MsgInfo *msginfo, GSList *msglist, gboolean spam);
333 #endif /* __PROCMSG_H__ */