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 3 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, see <http://www.gnu.org/licenses/>.
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)
51 #define MSG_CLABEL_SBIT (6) /* start bit of color label */
52 /* color labels use 4 bits: 6, 7, 8, 9; bit weight is 7<8<9<6,
53 IOW the color label value itself must be computed from MsgPermFlags
55 value = bit-7-value*2^0
60 /* color label permflags masks */
61 #define MAKE_MSG_CLABEL(x, h, m, l) (\
62 ((x) << (MSG_CLABEL_SBIT + 0)) | \
63 ((h) << (MSG_CLABEL_SBIT + 3)) | \
64 ((m) << (MSG_CLABEL_SBIT + 2)) | \
65 ((l) << (MSG_CLABEL_SBIT + 1)))
66 #define MSG_CLABEL_NONE MAKE_MSG_CLABEL(0U, 0U, 0U, 0U)
67 #define MSG_CLABEL_1 MAKE_MSG_CLABEL(0U, 0U, 0U, 1U)
68 #define MSG_CLABEL_2 MAKE_MSG_CLABEL(0U, 0U, 1U, 0U)
69 #define MSG_CLABEL_3 MAKE_MSG_CLABEL(0U, 0U, 1U, 1U)
70 #define MSG_CLABEL_4 MAKE_MSG_CLABEL(0U, 1U, 0U, 0U)
71 #define MSG_CLABEL_5 MAKE_MSG_CLABEL(0U, 1U, 0U, 1U)
72 #define MSG_CLABEL_6 MAKE_MSG_CLABEL(0U, 1U, 1U, 0U)
73 #define MSG_CLABEL_7 MAKE_MSG_CLABEL(0U, 1U, 1U, 1U)
74 #define MSG_CLABEL_8 MAKE_MSG_CLABEL(1U, 0U, 0U, 0U)
75 #define MSG_CLABEL_9 MAKE_MSG_CLABEL(1U, 0U, 0U, 1U)
76 #define MSG_CLABEL_10 MAKE_MSG_CLABEL(1U, 0U, 1U, 0U)
77 #define MSG_CLABEL_11 MAKE_MSG_CLABEL(1U, 0U, 1U, 1U)
78 #define MSG_CLABEL_12 MAKE_MSG_CLABEL(1U, 1U, 0U, 0U)
79 #define MSG_CLABEL_13 MAKE_MSG_CLABEL(1U, 1U, 0U, 1U)
80 #define MSG_CLABEL_14 MAKE_MSG_CLABEL(1U, 1U, 1U, 0U)
81 #define MSG_CLABEL_15 MAKE_MSG_CLABEL(1U, 1U, 1U, 1U)
82 #define MSG_CLABEL_FLAG_MASK (MSG_CLABEL_15)
84 #define MSG_IGNORE_THREAD (1U << 10) /* ignore threads */
85 #define MSG_LOCKED (1U << 11) /* msg is locked */
86 #define MSG_RETRCPT_SENT (1U << 12) /* new one */
87 #define MSG_SPAM (1U << 13) /* new one */
88 #define MSG_POSTFILTERED (1U << 14)
89 #define MSG_WATCH_THREAD (1U << 15) /* watch threads */
92 #define MSG_RESERVED_CLAWS (1U << 30) /* for claws-mail */
93 #define MSG_RESERVED (1U << 31)
95 typedef guint32 MsgPermFlags
;
97 #define MSG_MOVE (1U << 0)
98 #define MSG_COPY (1U << 1)
99 #define MSG_MOVE_DONE (1U << 15)
100 #define MSG_QUEUED (1U << 16)
101 #define MSG_DRAFT (1U << 17)
102 #define MSG_ENCRYPTED (1U << 18)
103 #define MSG_IMAP (1U << 19)
104 #define MSG_NEWS (1U << 20)
105 #define MSG_SIGNED (1U << 21)
106 #define MSG_MULTIPART (1U << 29)
107 #define MSG_HAS_ATTACHMENT (1U << 30)
108 #define MSG_SCANNED (1U << 31)
110 typedef guint32 MsgTmpFlags
;
112 #define MSG_CACHED_FLAG_MASK (MSG_MULTIPART | MSG_ENCRYPTED | MSG_SIGNED | MSG_HAS_ATTACHMENT | MSG_SCANNED)
114 #define MSG_SET_FLAGS(msg, flags) { (msg) |= (flags); }
115 #define MSG_UNSET_FLAGS(msg, flags) { (msg) &= ~(flags); }
116 #define MSG_SET_PERM_FLAGS(msg, flags) \
117 MSG_SET_FLAGS((msg).perm_flags, flags)
118 #define MSG_SET_TMP_FLAGS(msg, flags) \
119 MSG_SET_FLAGS((msg).tmp_flags, flags)
120 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
121 MSG_UNSET_FLAGS((msg).perm_flags, flags)
122 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
123 MSG_UNSET_FLAGS((msg).tmp_flags, flags)
125 #define MSG_IS_NEW(msg) (((msg).perm_flags & MSG_NEW) != 0)
126 #define MSG_IS_UNREAD(msg) (((msg).perm_flags & MSG_UNREAD) != 0)
127 #define MSG_IS_MARKED(msg) (((msg).perm_flags & MSG_MARKED) != 0)
128 #define MSG_IS_DELETED(msg) (((msg).perm_flags & MSG_DELETED) != 0)
129 #define MSG_IS_REPLIED(msg) (((msg).perm_flags & MSG_REPLIED) != 0)
130 #define MSG_IS_LOCKED(msg) (((msg).perm_flags & MSG_LOCKED) != 0)
131 #define MSG_IS_FORWARDED(msg) (((msg).perm_flags & MSG_FORWARDED) != 0)
132 #define MSG_IS_POSTFILTERED(msg) (((msg).perm_flags & MSG_POSTFILTERED) != 0)
134 /* color label decoding/encoding (permflag storage bits <-> color list index value)*/
135 #define MSG_COLORLABEL_TO_FLAGS(val) (((((guint)(val)) & 7) << (MSG_CLABEL_SBIT+1)) \
136 | (((guint)(val) & 8) << (MSG_CLABEL_SBIT-3)))
137 #define MSG_COLORLABEL_FROM_FLAGS(val) ((((guint)(val) >> (MSG_CLABEL_SBIT+1)) & 7 ) \
138 | (((guint)(val) >> (MSG_CLABEL_SBIT-3)) & 8))
139 #define MSG_GET_COLORLABEL(msg) (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
140 #define MSG_GET_COLORLABEL_VALUE(msg) (MSG_COLORLABEL_FROM_FLAGS(MSG_GET_COLORLABEL(msg)))
141 #define MSG_SET_COLORLABEL_VALUE(msg, val) MSG_SET_PERM_FLAGS(msg, MSG_COLORLABEL_TO_FLAGS(val))
143 #define MSG_IS_MOVE(msg) (((msg).tmp_flags & MSG_MOVE) != 0)
144 #define MSG_IS_COPY(msg) (((msg).tmp_flags & MSG_COPY) != 0)
145 #define MSG_IS_MOVE_DONE(msg) (((msg).tmp_flags & MSG_MOVE_DONE) != 0)
147 #define MSG_IS_QUEUED(msg) (((msg).tmp_flags & MSG_QUEUED) != 0)
148 #define MSG_IS_DRAFT(msg) (((msg).tmp_flags & MSG_DRAFT) != 0)
149 #define MSG_IS_ENCRYPTED(msg) (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
150 #define MSG_IS_SIGNED(msg) (((msg).tmp_flags & MSG_SIGNED) != 0)
151 #define MSG_IS_IMAP(msg) (((msg).tmp_flags & MSG_IMAP) != 0)
152 #define MSG_IS_NEWS(msg) (((msg).tmp_flags & MSG_NEWS) != 0)
153 #define MSG_IS_MULTIPART(msg) (((msg).tmp_flags & MSG_MULTIPART) != 0)
154 #define MSG_IS_WITH_ATTACHMENT(msg) (((msg).tmp_flags & MSG_HAS_ATTACHMENT) != 0)
155 #define MSG_IS_SCANNED(msg) (((msg).tmp_flags & MSG_SCANNED) != 0)
157 /* Claws related flags */
158 #define MSG_IS_REALLY_DELETED(msg) (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
159 #define MSG_IS_IGNORE_THREAD(msg) (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
160 #define MSG_IS_RETRCPT_PENDING(msg) (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
161 #define MSG_IS_RETRCPT_SENT(msg) (((msg).perm_flags & MSG_RETRCPT_SENT) != 0)
162 #define MSG_IS_SPAM(msg) (((msg).perm_flags & MSG_SPAM) != 0)
163 #define MSG_IS_WATCH_THREAD(msg) (((msg).perm_flags & MSG_WATCH_THREAD) != 0)
165 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
166 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
167 #define MAIL_LISTFILTERING_HOOKLIST "mail_listfiltering_hooklist"
168 #define MAIL_POSTFILTERING_HOOKLIST "mail_postfiltering_hooklist"
171 MSGINFO_UPDATE_FLAGS
= 1 << 0,
172 MSGINFO_UPDATE_DELETED
= 1 << 1
173 } MsgInfoUpdateFlags
;
175 #include "procmime.h"
176 #include "prefs_filtering.h"
181 MsgPermFlags perm_flags
;
182 MsgTmpFlags tmp_flags
;
185 /* *********************************************************** *
186 * WARNING: When adding or removing members to this structure, *
187 * be sure to update procmsg.c::procmsg_msginfo_memusage() to *
188 * avoid underestimating cache memory usage - especially since *
189 * this would cause an overflow and metadata loss when writing *
190 * the cache to disk. *
191 * *********************************************************** */
217 FolderItem
*to_folder
;
219 FolderItem
*to_filter_folder
;
228 /* used only for encrypted messages */
229 gchar
*plaintext_file
;
233 /* used only for partially received messages */
235 gint planned_download
;
239 MsgInfoExtraData
*extradata
;
242 struct _MsgInfoExtraData
247 gchar
*dispositionnotificationto
;
248 gchar
*returnreceiptto
;
250 /* used only for partially received messages */
252 gchar
*account_server
;
253 gchar
*account_login
;
255 /* Mailing list support */
257 gchar
*list_subscribe
;
258 gchar
*list_unsubscribe
;
271 struct _MsgInfoUpdate
{
273 MsgInfoUpdateFlags flags
;
276 struct _MailFilteringData
282 PrefsAccount
*account
;
285 GSList
*procmsg_read_cache (FolderItem
*item
,
287 void procmsg_msg_list_free (GSList
*mlist
);
288 void procmsg_get_mark_sum (const gchar
*folder
,
296 GNode
*procmsg_get_thread_tree (GSList
*mlist
);
298 gint
procmsg_move_messages (GSList
*mlist
);
299 void procmsg_copy_messages (GSList
*mlist
);
301 /* return path is locale charset */
302 gchar
*procmsg_get_message_file_path (MsgInfo
*msginfo
);
303 gchar
*procmsg_get_message_file (MsgInfo
*msginfo
);
304 gchar
*procmsg_get_message_file_full (MsgInfo
*msginfo
,
305 gboolean get_headers
,
307 GSList
*procmsg_get_message_file_list (MsgInfoList
*mlist
);
308 void procmsg_message_file_list_free (MsgInfoList
*file_list
);
309 FILE *procmsg_open_message (MsgInfo
*msginfo
);
310 gboolean
procmsg_msg_exist (MsgInfo
*msginfo
);
312 void procmsg_get_filter_keyword (MsgInfo
*msginfo
,
315 PrefsFilterType type
);
317 void procmsg_empty_all_trash (void);
319 gint
procmsg_send_queue (FolderItem
*queue
,
322 gboolean
procmsg_queue_is_empty (FolderItem
*queue
);
323 void procmsg_print_message (MsgInfo
*msginfo
,
324 const gchar
*cmdline
);
326 MsgInfo
*procmsg_msginfo_new ();
327 MsgInfo
*procmsg_msginfo_new_ref (MsgInfo
*msginfo
);
328 MsgInfo
*procmsg_msginfo_copy (MsgInfo
*msginfo
);
329 MsgInfo
*procmsg_msginfo_get_full_info (MsgInfo
*msginfo
);
330 void procmsg_msginfo_free (MsgInfo
*msginfo
);
331 guint
procmsg_msginfo_memusage (MsgInfo
*msginfo
);
333 gint
procmsg_send_message_queue (const gchar
*file
,
337 gboolean
*queued_removed
);
339 void procmsg_msginfo_set_flags (MsgInfo
*msginfo
,
340 MsgPermFlags perm_flags
,
341 MsgTmpFlags tmp_flags
);
342 void procmsg_msginfo_unset_flags (MsgInfo
*msginfo
,
343 MsgPermFlags perm_flags
,
344 MsgTmpFlags tmp_flags
);
345 void procmsg_msginfo_change_flags (MsgInfo
*msginfo
,
346 MsgPermFlags add_perm_flags
,
347 MsgTmpFlags add_tmp_flags
,
348 MsgPermFlags rem_perm_flags
,
349 MsgTmpFlags rem_tmp_flags
);
350 gint
procmsg_remove_special_headers (const gchar
*in
,
353 gboolean
procmsg_msg_has_flagged_parent (MsgInfo
*info
,
354 MsgPermFlags perm_flags
);
355 gboolean
procmsg_msg_has_marked_parent (MsgInfo
*info
);
356 void procmsg_msginfo_set_to_folder (MsgInfo
*msginfo
,
357 FolderItem
*to_folder
);
358 void procmsg_msglist_filter (GSList
*list
,
364 MsgInfo
*procmsg_msginfo_new_from_mimeinfo
365 (MsgInfo
*src_msginfo
,
368 void procmsg_register_spam_learner (int (*learn_func
)(MsgInfo
*info
, GSList
*list
, gboolean spam
));
369 void procmsg_unregister_spam_learner (int (*learn_func
)(MsgInfo
*info
, GSList
*list
, gboolean spam
));
370 gboolean
procmsg_spam_can_learn (void);
371 void procmsg_spam_set_folder (const char *item_identifier
, FolderItem
*(*spam_get_folder_func
)(MsgInfo
*info
));
372 FolderItem
*procmsg_spam_get_folder (MsgInfo
*msginfo
);
373 int procmsg_spam_learner_learn (MsgInfo
*msginfo
, GSList
*msglist
, gboolean spam
);
374 gboolean
procmsg_have_queued_mails_fast (void);
375 gboolean
procmsg_have_trashed_mails_fast (void);
376 gboolean
procmsg_is_sending(void);
377 gchar
*procmsg_msginfo_get_tags_str(MsgInfo
*msginfo
);
378 void procmsg_msginfo_update_tags(MsgInfo
*msginfo
, gboolean set
, gint id
);
379 void procmsg_msginfo_clear_tags(MsgInfo
*msginfo
);
380 #endif /* __PROCMSG_H__ */