* src/filter.c
[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 #if USE_SSL
31 #  include "ssl.h"
32 #endif
33 #include "folder.h"
34 #include "session.h"
35 #include "procmsg.h"
36
37 typedef struct _IMAPFolder      IMAPFolder;
38 typedef struct _IMAPSession     IMAPSession;
39 typedef struct _IMAPNameSpace   IMAPNameSpace;
40 typedef struct _IMAPFolderItem  IMAPFolderItem;
41
42 #include "prefs_account.h"
43
44 #define IMAP_FOLDER(obj)        ((IMAPFolder *)obj)
45 #define IMAP_SESSION(obj)       ((IMAPSession *)obj)
46
47 struct _IMAPFolder
48 {
49         RemoteFolder rfolder;
50
51         /* list of IMAPNameSpace */
52         GList *ns_personal;
53         GList *ns_others;
54         GList *ns_shared;
55 };
56
57 struct _IMAPSession
58 {
59         Session session;
60
61         gchar *mbox;
62         time_t last_access_time;
63 };
64
65 struct _IMAPNameSpace
66 {
67         gchar *name;
68         gchar separator;
69 };
70
71 struct _IMAPFolderItem
72 {
73         FolderItem item;
74
75         guint lastuid;
76         GSList *uid_list;
77 };
78
79 #define IMAP_SUCCESS    0
80 #define IMAP_SOCKET     2
81 #define IMAP_AUTHFAIL   3
82 #define IMAP_PROTOCOL   4
83 #define IMAP_SYNTAX     5
84 #define IMAP_IOERR      6
85 #define IMAP_ERROR      7
86
87 #define IMAPBUFSIZE     8192
88
89 typedef enum
90 {
91         IMAP_FLAG_SEEN          = 1 << 0,
92         IMAP_FLAG_ANSWERED      = 1 << 1,
93         IMAP_FLAG_FLAGGED       = 1 << 2,
94         IMAP_FLAG_DELETED       = 1 << 3,
95         IMAP_FLAG_DRAFT         = 1 << 4
96 } IMAPFlags;
97
98 #define IMAP_IS_SEEN(flags)     ((flags & IMAP_FLAG_SEEN) != 0)
99 #define IMAP_IS_ANSWERED(flags) ((flags & IMAP_FLAG_ANSWERED) != 0)
100 #define IMAP_IS_FLAGGED(flags)  ((flags & IMAP_FLAG_FLAGGED) != 0)
101 #define IMAP_IS_DELETED(flags)  ((flags & IMAP_FLAG_DELETED) != 0)
102 #define IMAP_IS_DRAFT(flags)    ((flags & IMAP_FLAG_DRAFT) != 0)
103
104 Folder  *imap_folder_new                (const gchar    *name,
105                                          const gchar    *path);
106 void     imap_folder_destroy            (IMAPFolder     *folder);
107
108 FolderItem *imap_folder_item_new        ();
109 void imap_folder_item_destroy           (FolderItem *item);
110
111 Session *imap_session_new               (const PrefsAccount *account);
112 void imap_session_destroy               (IMAPSession    *session);
113 void imap_session_destroy_all           (void);
114
115 GSList *imap_get_msg_list               (Folder         *folder,
116                                          FolderItem     *item,
117                                          gboolean        use_cache);
118 gchar *imap_fetch_msg                   (Folder         *folder,
119                                          FolderItem     *item,
120                                          gint            uid);
121 gint imap_add_msg                       (Folder         *folder,
122                                          FolderItem     *dest,
123                                          const gchar    *file,
124                                          gboolean        remove_source);
125
126 gint imap_move_msg                      (Folder         *folder,
127                                          FolderItem     *dest,
128                                          MsgInfo        *msginfo);
129 gint imap_move_msgs_with_dest           (Folder         *folder,
130                                          FolderItem     *dest,
131                                          GSList         *msglist);
132 gint imap_copy_msg                      (Folder         *folder,
133                                          FolderItem     *dest,
134                                          MsgInfo        *msginfo);
135 gint imap_copy_msgs_with_dest           (Folder         *folder,
136                                          FolderItem     *dest,
137                                          GSList         *msglist);
138
139 gint imap_remove_msg                    (Folder         *folder,
140                                          FolderItem     *item,
141                                          gint            uid);
142 gint imap_remove_all_msg                (Folder         *folder,
143                                          FolderItem     *item);
144 gboolean imap_is_msg_changed            (Folder         *folder,
145                                          FolderItem     *item,
146                                          MsgInfo        *msginfo);
147
148 gint imap_scan_folder                   (Folder         *folder,
149                                          FolderItem     *item);
150 void imap_scan_tree                     (Folder         *folder);
151
152 gint imap_create_tree                   (Folder         *folder);
153
154 FolderItem *imap_create_folder          (Folder         *folder,
155                                          FolderItem     *parent,
156                                          const gchar    *name);
157 gint imap_rename_folder                 (Folder         *folder,
158                                          FolderItem     *item,
159                                          const gchar    *name);
160 gint imap_remove_folder                 (Folder         *folder,
161                                          FolderItem     *item);
162
163 gint imap_msg_set_perm_flags            (MsgInfo        *msginfo,
164                                          MsgPermFlags    flags);
165 gint imap_msg_unset_perm_flags          (MsgInfo        *msginfo,
166                                          MsgPermFlags    flags);
167
168 #endif /* __IMAP_H__ */