src/folder.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999,2000 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 __FOLDER_H__
  21 #define __FOLDER_H__
  22
  23 #include <glib.h>
  24 #include <time.h>
  25
  26 typedef struct _Folder          Folder;
  27 typedef struct _LocalFolder     LocalFolder;
  28 typedef struct _RemoteFolder    RemoteFolder;
  29 typedef struct _MHFolder        MHFolder;
  30 typedef struct _MboxFolder      MboxFolder;
  31 typedef struct _MaildirFolder   MaildirFolder;
  32 typedef struct _IMAPFolder      IMAPFolder;
  33 typedef struct _NewsFolder      NewsFolder;
  34 typedef struct _FolderItem      FolderItem;
  35
  36 #include "prefs_account.h"
  37 #include "session.h"
  38 #include "procmsg.h"
  39 #include "prefs_folder_item.h"
  40
  41 #define FOLDER(obj)             ((Folder *)obj)
  42 #define FOLDER_TYPE(obj)        (FOLDER(obj)->type)
  43
  44 #define LOCAL_FOLDER(obj)       ((LocalFolder *)obj)
  45 #define REMOTE_FOLDER(obj)      ((RemoteFolder *)obj)
  46
  47 #define MH_FOLDER(obj)          ((MHFolder *)obj)
  48 #define MBOX_FOLDER(obj)        ((MboxFolder *)obj)
  49 #define MAILDIR_FOLDER(obj)     ((MaildirFolder *)obj)
  50 #define IMAP_FOLDER(obj)        ((IMAPFolder *)obj)
  51 #define NEWS_FOLDER(obj)        ((NewsFolder *)obj)
  52
  53 #define FOLDER_ITEM(obj)        ((FolderItem *)obj)
  54
  55 typedef enum
  56 {
  57         F_MH,
  58         F_MBOX,
  59         F_MAILDIR,
  60         F_IMAP,
  61         F_NEWS,
  62         F_UNKNOWN
  63 } FolderType;
  64
  65 typedef enum
  66 {
  67         F_NORMAL,
  68         F_INBOX,
  69         F_OUTBOX,
  70         F_DRAFT,
  71         F_QUEUE,
  72         F_TRASH
  73 } SpecialFolderItemType;
  74
  75 typedef void (*FolderUIFunc)            (Folder         *folder,
  76                                          FolderItem     *item,
  77                                          gpointer        data);
  78 typedef void (*FolderDestroyNotify)     (Folder         *folder,
  79                                          FolderItem     *item,
  80                                          gpointer        data);
  81
  82 struct _Folder
  83 {
  84         FolderType type;
  85
  86         gchar *name;
  87         PrefsAccount *account;
  88
  89         FolderItem *inbox;
  90         FolderItem *outbox;
  91         FolderItem *draft;
  92         FolderItem *queue;
  93         FolderItem *trash;
  94
  95         FolderUIFunc ui_func;
  96         gpointer     ui_func_data;
  97
  98         GNode *node;
  99
 100         gpointer data;
 101
 102         /* virtual functions */
 103         GSList * (*get_msg_list)        (Folder         *folder,
 104                                          FolderItem     *item,
 105                                          gboolean        use_cache);
 106         gchar *  (*fetch_msg)           (Folder         *folder,
 107                                          FolderItem     *item,
 108                                          gint            num);
 109         gint     (*add_msg)             (Folder         *folder,
 110                                          FolderItem     *dest,
 111                                          const gchar    *file,
 112                                          gboolean        remove_source);
 113         gint     (*move_msg)            (Folder         *folder,
 114                                          FolderItem     *dest,
 115                                          MsgInfo        *msginfo);
 116         gint     (*move_msgs_with_dest) (Folder         *folder,
 117                                          FolderItem     *dest,
 118                                          GSList         *msglist);
 119         gint     (*copy_msg)            (Folder         *folder,
 120                                          FolderItem     *dest,
 121                                          MsgInfo        *msginfo);
 122         gint     (*copy_msgs_with_dest) (Folder         *folder,
 123                                          FolderItem     *dest,
 124                                          GSList         *msglist);
 125         gint     (*remove_msg)          (Folder         *folder,
 126                                          FolderItem     *item,
 127                                          gint            num);
 128         gint     (*remove_all_msg)      (Folder         *folder,
 129                                          FolderItem     *item);
 130         gboolean (*is_msg_changed)      (Folder         *folder,
 131                                          FolderItem     *item,
 132                                          MsgInfo        *msginfo);
 133         void     (*scan)                (Folder         *folder,
 134                                          FolderItem     *item);
 135         void     (*scan_tree)           (Folder         *folder);
 136
 137         gint     (*create_tree)         (Folder         *folder);
 138         FolderItem * (*create_folder)   (Folder         *folder,
 139                                          FolderItem     *parent,
 140                                          const gchar    *name);
 141         gint     (*rename_folder)       (Folder         *folder,
 142                                          FolderItem     *item,
 143                                          const gchar    *name);
 144         gint     (*remove_folder)       (Folder         *folder,
 145                                          FolderItem     *item);
 146         void     (*update_mark)         (Folder         *folder,
 147                                          FolderItem     *item);
 148         void     (*change_flags)        (Folder         *folder,
 149                                          FolderItem     *item,
 150                                          MsgInfo        *info);
 151         void     (*finished_copy)       (Folder * folder, FolderItem * item);
 152         void     (*finished_remove)       (Folder * folder, FolderItem * item);
 153 };
 154
 155 struct _LocalFolder
 156 {
 157         Folder folder;
 158
 159         gchar *rootpath;
 160 };
 161
 162 struct _RemoteFolder
 163 {
 164         Folder folder;
 165
 166         Session *session;
 167 };
 168
 169 struct _MHFolder
 170 {
 171         LocalFolder lfolder;
 172 };
 173
 174 struct _MboxFolder
 175 {
 176         LocalFolder lfolder;
 177 };
 178
 179 struct _MaildirFolder
 180 {
 181         LocalFolder lfolder;
 182 };
 183
 184 struct _IMAPFolder
 185 {
 186         RemoteFolder rfolder;
 187 };
 188
 189 struct _NewsFolder
 190 {
 191         RemoteFolder rfolder;
 192
 193         gboolean use_auth;
 194 };
 195
 196 struct _FolderItem
 197 {
 198         SpecialFolderItemType stype;
 199
 200         gchar *name;
 201         gchar *path;
 202         PrefsAccount *account;
 203
 204         time_t mtime;
 205
 206         gint new;
 207         gint unread;
 208         gint total;
 209
 210         gint last_num;
 211
 212         FolderItem *parent;
 213
 214         Folder *folder;
 215
 216         gpointer data;
 217
 218         PrefsFolderItem * prefs;
 219 };
 220
 221 Folder     *folder_new          (FolderType      type,
 222                                  const gchar    *name,
 223                                  const gchar    *path);
 224 Folder     *mh_folder_new       (const gchar    *name,
 225                                  const gchar    *path);
 226 Folder     *mbox_folder_new     (const gchar    *name,
 227                                  const gchar    *path);
 228 Folder     *maildir_folder_new  (const gchar    *name,
 229                                  const gchar    *path);
 230 Folder     *imap_folder_new     (const gchar    *name,
 231                                  const gchar    *path);
 232 Folder     *news_folder_new     (const gchar    *name,
 233                                  const gchar    *path);
 234 FolderItem *folder_item_new     (const gchar    *name,
 235                                  const gchar    *path);
 236 void        folder_item_append  (FolderItem     *parent,
 237                                  FolderItem     *item);
 238 void        folder_item_remove  (FolderItem     *item);
 239 void        folder_set_ui_func  (Folder         *folder,
 240                                  FolderUIFunc    func,
 241                                  gpointer        data);
 242 void        folder_set_name     (Folder         *folder,
 243                                  const gchar    *name);
 244 void        folder_destroy      (Folder         *folder);
 245 void        folder_tree_destroy (Folder         *folder);
 246
 247 void   folder_add               (Folder         *folder);
 248
 249 GList *folder_get_list          (void);
 250 gint   folder_read_list         (void);
 251 void   folder_write_list        (void);
 252
 253 Folder     *folder_find_from_path       (const gchar    *path);
 254 FolderItem *folder_find_item_from_path  (const gchar    *path);
 255 Folder     *folder_get_default_folder   (void);
 256 FolderItem *folder_get_default_inbox    (void);
 257 FolderItem *folder_get_default_outbox   (void);
 258 FolderItem *folder_get_default_draft    (void);
 259 FolderItem *folder_get_default_queue    (void);
 260 FolderItem *folder_get_default_trash    (void);
 261
 262 gchar *folder_item_get_path             (FolderItem     *item);
 263 void   folder_item_scan                 (FolderItem     *item);
 264 void   folder_item_scan_foreach         (GHashTable     *table);
 265 gchar *folder_item_fetch_msg            (FolderItem     *item,
 266                                          gint            num);
 267 gint   folder_item_add_msg              (FolderItem     *dest,
 268                                          const gchar    *file,
 269                                          gboolean        remove_source);
 270 gint   folder_item_move_msg             (FolderItem     *dest,
 271                                          MsgInfo        *msginfo);
 272 gint   folder_item_move_msgs_with_dest  (FolderItem     *dest,
 273                                          GSList         *msglist);
 274 gint   folder_item_copy_msg             (FolderItem     *dest,
 275                                          MsgInfo        *msginfo);
 276 gint   folder_item_copy_msgs_with_dest  (FolderItem     *dest,
 277                                          GSList         *msglist);
 278 gint   folder_item_remove_msg           (FolderItem     *item,
 279                                          gint            num);
 280 gint   folder_item_remove_all_msg       (FolderItem     *item);
 281 gboolean folder_item_is_msg_changed     (FolderItem     *item,
 282                                          MsgInfo        *msginfo);
 283 gchar *folder_item_get_cache_file       (FolderItem     *item);
 284 gchar *folder_item_get_mark_file        (FolderItem     *item);
 285 gchar * folder_item_get_identifier(FolderItem * item);
 286 FolderItem * folder_find_item_from_identifier(const gchar *identifier);
 287
 288 #endif /* __FOLDER_H__ */