2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail 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 struct _MsgInfoExtraData MsgInfoExtraData;
41 typedef GSList MsgInfoList;
42 typedef GSList MsgNumberList;
44 #define MSG_NEW (1U << 0)
45 #define MSG_UNREAD (1U << 1)
46 #define MSG_MARKED (1U << 2)
47 #define MSG_DELETED (1U << 3)
48 #define MSG_REPLIED (1U << 4)
49 #define MSG_FORWARDED (1U << 5)
50 #define MSG_POSTFILTERED (1U << 14)
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)))
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)
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
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 #define MSG_SPAM (1U << 13) /* new one */
80 #define MSG_RESERVED_CLAWS (1U << 30) /* for claws-mail */
81 #define MSG_RESERVED (1U << 31)
83 typedef guint32 MsgPermFlags;
85 #define MSG_CLABEL_FLAG_MASK (MSG_CLABEL_7)
87 #define MSG_MOVE (1U << 0)
88 #define MSG_COPY (1U << 1)
89 #define MSG_MOVE_DONE (1U << 15)
90 #define MSG_QUEUED (1U << 16)
91 #define MSG_DRAFT (1U << 17)
92 #define MSG_ENCRYPTED (1U << 18)
93 #define MSG_IMAP (1U << 19)
94 #define MSG_NEWS (1U << 20)
95 #define MSG_SIGNED (1U << 21)
96 #define MSG_MULTIPART (1U << 29)
97 #define MSG_HAS_ATTACHMENT (1U << 30)
98 #define MSG_SCANNED (1U << 31)
100 typedef guint32 MsgTmpFlags;
102 #define MSG_CACHED_FLAG_MASK (MSG_MULTIPART | MSG_ENCRYPTED | MSG_SIGNED | MSG_HAS_ATTACHMENT | MSG_SCANNED)
104 #define MSG_SET_FLAGS(msg, flags) { (msg) |= (flags); }
105 #define MSG_UNSET_FLAGS(msg, flags) { (msg) &= ~(flags); }
106 #define MSG_SET_PERM_FLAGS(msg, flags) \
107 MSG_SET_FLAGS((msg).perm_flags, flags)
108 #define MSG_SET_TMP_FLAGS(msg, flags) \
109 MSG_SET_FLAGS((msg).tmp_flags, flags)
110 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
111 MSG_UNSET_FLAGS((msg).perm_flags, flags)
112 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
113 MSG_UNSET_FLAGS((msg).tmp_flags, flags)
115 #define MSG_IS_NEW(msg) (((msg).perm_flags & MSG_NEW) != 0)
116 #define MSG_IS_UNREAD(msg) (((msg).perm_flags & MSG_UNREAD) != 0)
117 #define MSG_IS_MARKED(msg) (((msg).perm_flags & MSG_MARKED) != 0)
118 #define MSG_IS_DELETED(msg) (((msg).perm_flags & MSG_DELETED) != 0)
119 #define MSG_IS_REPLIED(msg) (((msg).perm_flags & MSG_REPLIED) != 0)
120 #define MSG_IS_LOCKED(msg) (((msg).perm_flags & MSG_LOCKED) != 0)
121 #define MSG_IS_FORWARDED(msg) (((msg).perm_flags & MSG_FORWARDED) != 0)
122 #define MSG_IS_POSTFILTERED(msg) (((msg).perm_flags & MSG_POSTFILTERED) != 0)
124 #define MSG_GET_COLORLABEL(msg) (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
125 #define MSG_GET_COLORLABEL_VALUE(msg) (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
126 #define MSG_SET_COLORLABEL_VALUE(msg, val) \
127 MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
129 #define MSG_COLORLABEL_TO_FLAGS(val) ((((guint)(val)) & 7) << MSG_CLABEL_SBIT)
130 #define MSG_COLORLABEL_FROM_FLAGS(val) (val >> MSG_CLABEL_SBIT)
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)
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)
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_SPAM(msg) (((msg).perm_flags & MSG_SPAM) != 0)
153 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
154 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
155 #define MAIL_LISTFILTERING_HOOKLIST "mail_listfiltering_hooklist"
156 #define MAIL_POSTFILTERING_HOOKLIST "mail_postfiltering_hooklist"
159 MSGINFO_UPDATE_FLAGS = 1 << 0,
160 MSGINFO_UPDATE_DELETED = 1 << 1
161 } MsgInfoUpdateFlags;
163 #include "procmime.h"
164 #include "prefs_filtering.h"
169 MsgPermFlags perm_flags;
170 MsgTmpFlags tmp_flags;
173 /* *********************************************************** *
174 * WARNING: When adding or removing members to this structure, *
175 * be sure to update procmsg.c::procmsg_msginfo_memusage() to *
176 * avoid underestimating cache memory usage - especially since *
177 * this would cause an overflow and metadata loss when writing *
178 * the cache to disk. *
179 * *********************************************************** */
204 FolderItem *to_folder;
206 FolderItem *to_filter_folder;
215 /* used only for encrypted messages */
216 gchar *plaintext_file;
220 /* used only for partially received messages */
222 gint planned_download;
224 MsgInfoExtraData *extradata;
227 struct _MsgInfoExtraData
232 gchar *dispositionnotificationto;
233 gchar *returnreceiptto;
235 /* used only for partially received messages */
237 gchar *account_server;
238 gchar *account_login;
240 /* Mailing list support */
242 gchar *list_subscribe;
243 gchar *list_unsubscribe;
256 struct _MsgInfoUpdate {
258 MsgInfoUpdateFlags flags;
261 struct _MailFilteringData
267 PrefsAccount *account;
270 GSList *procmsg_read_cache (FolderItem *item,
272 void procmsg_msg_list_free (GSList *mlist);
273 void procmsg_get_mark_sum (const gchar *folder,
281 GNode *procmsg_get_thread_tree (GSList *mlist);
283 gint procmsg_move_messages (GSList *mlist);
284 void procmsg_copy_messages (GSList *mlist);
286 /* return path is locale charset */
287 gchar *procmsg_get_message_file_path (MsgInfo *msginfo);
288 gchar *procmsg_get_message_file (MsgInfo *msginfo);
289 gchar *procmsg_get_message_file_full (MsgInfo *msginfo,
290 gboolean get_headers,
292 GSList *procmsg_get_message_file_list (MsgInfoList *mlist);
293 void procmsg_message_file_list_free (MsgInfoList *file_list);
294 FILE *procmsg_open_message (MsgInfo *msginfo);
295 gboolean procmsg_msg_exist (MsgInfo *msginfo);
297 void procmsg_get_filter_keyword (MsgInfo *msginfo,
300 PrefsFilterType type);
302 void procmsg_empty_all_trash (void);
304 gint procmsg_send_queue (FolderItem *queue,
307 gboolean procmsg_queue_is_empty (FolderItem *queue);
308 void procmsg_print_message (MsgInfo *msginfo,
309 const gchar *cmdline);
311 MsgInfo *procmsg_msginfo_new ();
312 MsgInfo *procmsg_msginfo_new_ref (MsgInfo *msginfo);
313 MsgInfo *procmsg_msginfo_copy (MsgInfo *msginfo);
314 MsgInfo *procmsg_msginfo_get_full_info (MsgInfo *msginfo);
315 void procmsg_msginfo_free (MsgInfo *msginfo);
316 guint procmsg_msginfo_memusage (MsgInfo *msginfo);
318 gint procmsg_send_message_queue (const gchar *file,
322 gboolean *queued_removed);
324 void procmsg_msginfo_set_flags (MsgInfo *msginfo,
325 MsgPermFlags perm_flags,
326 MsgTmpFlags tmp_flags);
327 void procmsg_msginfo_unset_flags (MsgInfo *msginfo,
328 MsgPermFlags perm_flags,
329 MsgTmpFlags tmp_flags);
330 void procmsg_msginfo_change_flags (MsgInfo *msginfo,
331 MsgPermFlags add_perm_flags,
332 MsgTmpFlags add_tmp_flags,
333 MsgPermFlags rem_perm_flags,
334 MsgTmpFlags rem_tmp_flags);
335 gint procmsg_remove_special_headers (const gchar *in,
338 gboolean procmsg_msg_has_flagged_parent (MsgInfo *info,
339 MsgPermFlags perm_flags);
340 gboolean procmsg_msg_has_marked_parent (MsgInfo *info);
341 void procmsg_msginfo_set_to_folder (MsgInfo *msginfo,
342 FolderItem *to_folder);
343 void procmsg_msglist_filter (GSList *list,
349 MsgInfo *procmsg_msginfo_new_from_mimeinfo
350 (MsgInfo *src_msginfo,
353 void procmsg_register_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
354 void procmsg_unregister_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
355 gboolean procmsg_spam_can_learn (void);
356 void procmsg_spam_set_folder (const char *item_identifier);
357 FolderItem *procmsg_spam_get_folder (void);
358 int procmsg_spam_learner_learn (MsgInfo *msginfo, GSList *msglist, gboolean spam);
359 gboolean procmsg_have_queued_mails_fast (void);
360 gboolean procmsg_is_sending(void);
362 #endif /* __PROCMSG_H__ */