src/procmsg.h

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