59388c4bc737217b2a100701c316ab115f8a5916
[claws.git] / src / imap.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2002 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 __IMAP_H__
21 #define __IMAP_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <time.h>
29
30 #include "folder.h"
31 #include "session.h"
32 #include "procmsg.h"
33
34 typedef struct _IMAPFolder      IMAPFolder;
35 typedef struct _IMAPSession     IMAPSession;
36 typedef struct _IMAPNameSpace   IMAPNameSpace;
37
38 #include "prefs_account.h"
39
40 #define IMAP_FOLDER(obj)        ((IMAPFolder *)obj)
41 #define IMAP_SESSION(obj)       ((IMAPSession *)obj)
42
43 struct _IMAPFolder
44 {
45         RemoteFolder rfolder;
46
47         GList *namespace;       /* list of IMAPNameSpace */
48 };
49
50 struct _IMAPSession
51 {
52         Session session;
53
54         gchar *mbox;
55         time_t last_access_time;
56 };
57
58 struct _IMAPNameSpace
59 {
60         gchar *name;
61         gchar separator;
62 };
63
64 #define IMAP_SUCCESS    0
65 #define IMAP_SOCKET     2
66 #define IMAP_AUTHFAIL   3
67 #define IMAP_PROTOCOL   4
68 #define IMAP_SYNTAX     5
69 #define IMAP_IOERR      6
70 #define IMAP_ERROR      7
71
72 #define IMAPBUFSIZE     8192
73
74 typedef enum
75 {
76         IMAP_FLAG_SEEN          = 1 << 0,
77         IMAP_FLAG_ANSWERED      = 1 << 1,
78         IMAP_FLAG_FLAGGED       = 1 << 2,
79         IMAP_FLAG_DELETED       = 1 << 3,
80         IMAP_FLAG_DRAFT         = 1 << 4
81 } IMAPFlags;
82
83 #define IMAP_IS_SEEN(flags)     ((flags & IMAP_FLAG_SEEN) != 0)
84 #define IMAP_IS_ANSWERED(flags) ((flags & IMAP_FLAG_ANSWERED) != 0)
85 #define IMAP_IS_FLAGGED(flags)  ((flags & IMAP_FLAG_FLAGGED) != 0)
86 #define IMAP_IS_DELETED(flags)  ((flags & IMAP_FLAG_DELETED) != 0)
87 #define IMAP_IS_DRAFT(flags)    ((flags & IMAP_FLAG_DRAFT) != 0)
88
89 Folder  *imap_folder_new                (const gchar    *name,
90                                          const gchar    *path);
91 void     imap_folder_destroy            (IMAPFolder     *folder);
92
93 Session *imap_session_new               (const PrefsAccount *account);
94 void imap_session_destroy               (IMAPSession    *session);
95 void imap_session_destroy_all           (void);
96
97 GSList *imap_get_msg_list               (Folder         *folder,
98                                          FolderItem     *item,
99                                          gboolean        use_cache);
100 gchar *imap_fetch_msg                   (Folder         *folder,
101                                          FolderItem     *item,
102                                          gint            uid);
103 gint imap_add_msg                       (Folder         *folder,
104                                          FolderItem     *dest,
105                                          const gchar    *file,
106                                          gboolean        remove_source);
107
108 gint imap_move_msg                      (Folder         *folder,
109                                          FolderItem     *dest,
110                                          MsgInfo        *msginfo);
111 gint imap_move_msgs_with_dest           (Folder         *folder,
112                                          FolderItem     *dest,
113                                          GSList         *msglist);
114 gint imap_copy_msg                      (Folder         *folder,
115                                          FolderItem     *dest,
116                                          MsgInfo        *msginfo);
117 gint imap_copy_msgs_with_dest           (Folder         *folder,
118                                          FolderItem     *dest,
119                                          GSList         *msglist);
120
121 gint imap_remove_msg                    (Folder         *folder,
122                                          FolderItem     *item,
123                                          gint            uid);
124 gint imap_remove_all_msg                (Folder         *folder,
125                                          FolderItem     *item);
126
127 void imap_scan_folder                   (Folder         *folder,
128                                          FolderItem     *item);
129 void imap_scan_tree                     (Folder         *folder);
130
131 gint imap_create_tree                   (Folder         *folder);
132
133 FolderItem *imap_create_folder          (Folder         *folder,
134                                          FolderItem     *parent,
135                                          const gchar    *name);
136 gint imap_rename_folder                 (Folder         *folder,
137                                          FolderItem     *item,
138                                          const gchar    *name);
139 gint imap_remove_folder                 (Folder         *folder,
140                                          FolderItem     *item);
141
142 gint imap_msg_set_perm_flags            (MsgInfo        *msginfo,
143                                          MsgPermFlags    flags);
144 gint imap_msg_unset_perm_flags          (MsgInfo        *msginfo,
145                                          MsgPermFlags    flags);
146
147 #endif /* __IMAP_H__ */