2006-08-27 [colin] 2.4.0cvs98
[claws.git] / src / procmsg.h
index 68e4e29736a80f64529c25635c29205a5fa7f34e..ed364125e9a77d425369ca2b929b683c5bc632e4 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2004 Hiroyuki Yamamoto
+ * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -14,7 +14,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef __PROCMSG_H__
@@ -36,6 +36,8 @@ typedef struct _MsgFileInfo           MsgFileInfo;
 typedef struct _MsgInfoUpdate          MsgInfoUpdate;
 typedef struct _MailFilteringData      MailFilteringData;
 
+typedef struct _MsgInfoExtraData       MsgInfoExtraData;
+
 typedef GSList MsgInfoList;
 typedef GSList MsgNumberList;
 
@@ -45,9 +47,7 @@ typedef GSList MsgNumberList;
 #define MSG_DELETED            (1U << 3)
 #define MSG_REPLIED            (1U << 4)
 #define MSG_FORWARDED          (1U << 5)
-#if 0
-#define MSG_REALLY_DELETED     (1U << 6)               /* mbox stuff */
-#endif
+#define MSG_POSTFILTERED       (1U << 14)
 
 #define MSG_CLABEL_SBIT        (7)             /* start bit of color label */
 #define MAKE_MSG_CLABEL(h, m, l)       (((h) << (MSG_CLABEL_SBIT + 2)) | \
@@ -74,6 +74,7 @@ typedef GSList MsgNumberList;
 #define MSG_IGNORE_THREAD      (1U << 10)   /* ignore threads */
 #define MSG_LOCKED             (1U << 11)   /* msg is locked  */
 #define MSG_RETRCPT_SENT       (1U << 12)   /* new one */ 
+#define MSG_SPAM               (1U << 13)   /* new one */ 
                                                
 /* RESERVED */
 #define        MSG_RESERVED_CLAWS      (1U << 30)   /* for sylpheed-claws */
@@ -85,6 +86,7 @@ typedef guint32 MsgPermFlags;
 
 #define MSG_MOVE               (1U << 0)
 #define MSG_COPY               (1U << 1)
+#define MSG_MOVE_DONE          (1U << 15)              
 #define MSG_QUEUED             (1U << 16)
 #define MSG_DRAFT              (1U << 17)
 #define MSG_ENCRYPTED          (1U << 18)
@@ -117,6 +119,7 @@ typedef guint32 MsgTmpFlags;
 #define MSG_IS_REPLIED(msg)            (((msg).perm_flags & MSG_REPLIED) != 0)
 #define MSG_IS_LOCKED(msg)             (((msg).perm_flags & MSG_LOCKED) != 0)
 #define MSG_IS_FORWARDED(msg)          (((msg).perm_flags & MSG_FORWARDED) != 0)
+#define MSG_IS_POSTFILTERED(msg)       (((msg).perm_flags & MSG_POSTFILTERED) != 0)
 
 #define MSG_GET_COLORLABEL(msg)                (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
 #define MSG_GET_COLORLABEL_VALUE(msg)  (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
@@ -128,6 +131,7 @@ typedef guint32 MsgTmpFlags;
 
 #define MSG_IS_MOVE(msg)               (((msg).tmp_flags & MSG_MOVE) != 0)
 #define MSG_IS_COPY(msg)               (((msg).tmp_flags & MSG_COPY) != 0)
+#define MSG_IS_MOVE_DONE(msg)          (((msg).tmp_flags & MSG_MOVE_DONE) != 0)
 
 #define MSG_IS_QUEUED(msg)             (((msg).tmp_flags & MSG_QUEUED) != 0)
 #define MSG_IS_DRAFT(msg)              (((msg).tmp_flags & MSG_DRAFT) != 0)
@@ -144,6 +148,7 @@ typedef guint32 MsgTmpFlags;
 #define MSG_IS_IGNORE_THREAD(msg)      (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
 #define MSG_IS_RETRCPT_PENDING(msg)    (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
 #define MSG_IS_RETRCPT_SENT(msg)       (((msg).perm_flags & MSG_RETRCPT_SENT) != 0)
+#define MSG_IS_SPAM(msg)               (((msg).perm_flags & MSG_SPAM) != 0)
 
 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
@@ -151,7 +156,7 @@ typedef guint32 MsgTmpFlags;
 
 typedef enum {
        MSGINFO_UPDATE_FLAGS = 1 << 0,
-       MSGINFO_UPDATE_DELETED = 1 << 1,
+       MSGINFO_UPDATE_DELETED = 1 << 1
 } MsgInfoUpdateFlags;
 
 #include "procmime.h"
@@ -164,7 +169,13 @@ struct _MsgFlags
        MsgTmpFlags  tmp_flags;
 };
 
-
+/* *********************************************************** *
+ * WARNING: When adding or removing members to this structure, *
+ * be sure to update procmsg.c::procmsg_msginfo_memusage()  to *
+ * avoid underestimating cache memory usage - especially since *
+ * this would cause an overflow and metadata loss when writing *
+ * the cache to disk.                                          *
+ * *********************************************************** */
 struct _MsgInfo
 {
        guint refcnt;
@@ -191,28 +202,47 @@ struct _MsgInfo
        FolderItem *folder;
        FolderItem *to_folder;
 
-       gchar *xface;
-
-       gchar *dispositionnotificationto;
-       gchar *returnreceiptto;
+       FolderItem *to_filter_folder;   
+       gboolean is_move;
+       gboolean is_copy;
 
        GSList *references;
        gchar *fromspace;
 
        gint score;
-       gint threadscore;
 
        /* used only for encrypted messages */
        gchar *plaintext_file;
         
         gint hidden;
-       
+
        /* used only for partially received messages */
-       gchar *partial_recv;
        gint total_size;
+       gint planned_download;
+
+       MsgInfoExtraData *extradata;
+};
+
+struct _MsgInfoExtraData
+{
+       gchar *xface;
+       gchar *face;
+
+       gchar *dispositionnotificationto;
+       gchar *returnreceiptto;
+
+       /* used only for partially received messages */
+       gchar *partial_recv;
        gchar *account_server;
        gchar *account_login;
-       gint planned_download;
+
+       /* Mailing list support */
+       gchar *list_post;
+       gchar *list_subscribe;
+       gchar *list_unsubscribe;
+       gchar *list_help;
+       gchar *list_archive;
+       gchar *list_owner;
 };
 
 struct _MsgFileInfo
@@ -251,7 +281,7 @@ void        procmsg_get_mark_sum            (const gchar    *folder,
 
 GNode  *procmsg_get_thread_tree                (GSList         *mlist);
 
-void   procmsg_move_messages           (GSList         *mlist);
+gint   procmsg_move_messages           (GSList         *mlist);
 void   procmsg_copy_messages           (GSList         *mlist);
 
 /* return path is locale charset */
@@ -274,7 +304,8 @@ void        procmsg_empty_trash             (FolderItem     *trash);
 void   procmsg_empty_all_trash         (void);
 
 gint   procmsg_send_queue              (FolderItem     *queue,
-                                        gboolean        save_msgs);
+                                        gboolean        save_msgs,
+                                        gchar          **errstr);
 gboolean procmsg_queue_is_empty        (FolderItem *queue);
 gint   procmsg_save_to_outbox          (FolderItem     *outbox,
                                         const gchar    *file,
@@ -291,7 +322,10 @@ guint       procmsg_msginfo_memusage       (MsgInfo        *msginfo);
 
 gint procmsg_cmp_msgnum_for_sort       (gconstpointer   a,
                                         gconstpointer   b);
-gint procmsg_send_message_queue                (const gchar *file);
+gint procmsg_send_message_queue                (const gchar *file,
+                                        gchar **errstr,
+                                        FolderItem *queue, 
+                                        gint msgnum);
 
 void procmsg_msginfo_set_flags         (MsgInfo *msginfo,
                                         MsgPermFlags perm_flags,
@@ -299,6 +333,11 @@ void procmsg_msginfo_set_flags             (MsgInfo *msginfo,
 void procmsg_msginfo_unset_flags       (MsgInfo *msginfo,
                                         MsgPermFlags perm_flags,
                                         MsgTmpFlags tmp_flags);
+void procmsg_msginfo_change_flags      (MsgInfo *msginfo, 
+                                        MsgPermFlags add_perm_flags, 
+                                        MsgTmpFlags add_tmp_flags,
+                                        MsgPermFlags rem_perm_flags, 
+                                        MsgTmpFlags rem_tmp_flags);
 gint procmsg_remove_special_headers    (const gchar    *in, 
                                         const gchar    *out);
 
@@ -310,9 +349,19 @@ void procmsg_update_unread_children        (MsgInfo        *info,
                                         gboolean        newly_marked);
 void procmsg_msginfo_set_to_folder     (MsgInfo        *msginfo,
                                         FolderItem     *to_folder);
-gboolean procmsg_msginfo_filter                (MsgInfo        *msginfo);
+gboolean procmsg_msginfo_filter                (MsgInfo                *msginfo,
+                                                                        PrefsAccount   *ac_prefs);
 MsgInfo *procmsg_msginfo_new_from_mimeinfo
                                        (MsgInfo        *src_msginfo, 
                                         MimeInfo       *mimeinfo);
 
+void procmsg_register_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
+void procmsg_unregister_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
+gboolean procmsg_spam_can_learn                (void);
+void procmsg_spam_set_folder           (const char *item_identifier);
+FolderItem *procmsg_spam_get_folder    (void);
+int procmsg_spam_learner_learn         (MsgInfo *msginfo, GSList *msglist, gboolean spam);
+gboolean procmsg_have_queued_mails_fast (void);
+gboolean procmsg_is_sending(void);
+
 #endif /* __PROCMSG_H__ */