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