1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelFolder.h : Abstract class for an email folder */
/*
*
* Copyright (C) 1999 Bertrand Guiheneuf <Bertrand.Guiheneuf@aful.org> .
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
#ifndef CAMEL_FOLDER_H
#define CAMEL_FOLDER_H 1
#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/
#include <gtk/gtk.h>
typedef struct _CamelFolder CamelFolder;
#include "camel-store.h"
#include "camel-mime-message.h"
#include "camel-folder-summary.h"
#define CAMEL_FOLDER_TYPE (camel_folder_get_type ())
#define CAMEL_FOLDER(obj) (GTK_CHECK_CAST((obj), CAMEL_FOLDER_TYPE, CamelFolder))
#define CAMEL_FOLDER_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), CAMEL_FOLDER_TYPE, CamelFolderClass))
#define IS_CAMEL_FOLDER(o) (GTK_CHECK_TYPE((o), CAMEL_FOLDER_TYPE))
typedef enum {
FOLDER_OPEN,
FOLDER_CLOSE
} CamelFolderState;
typedef enum {
FOLDER_OPEN_UNKNOWN = 0, /* folder open mode is unknown */
FOLDER_OPEN_READ = 1, /* folder is read only */
FOLDER_OPEN_WRITE = 2, /* folder is write only */
FOLDER_OPEN_RW = 3 /* folder is read/write */
} CamelFolderOpenMode;
struct _CamelFolder
{
GtkObject parent_object;
gboolean can_hold_folders;
gboolean can_hold_messages;
CamelFolderOpenMode open_mode;
CamelFolderState open_state;
gchar *name;
gchar *full_name;
CamelStore *parent_store;
CamelFolder *parent_folder;
GList *permanent_flags;
gboolean has_summary_capability;
CamelFolderSummary *summary;
gboolean has_uid_capability;
GList *message_list;
};
typedef struct {
GtkObjectClass parent_class;
/* Virtual methods */
void (*init_with_store) (CamelFolder *folder, CamelStore *parent_store);
void (*open) (CamelFolder *object, CamelFolderOpenMode mode);
void (*close) (CamelFolder *folder, gboolean expunge);
void (*set_name) (CamelFolder *folder, const gchar *name);
/* void (*set_full_name) (CamelFolder *folder, const gchar *name); */
const gchar * (*get_name) (CamelFolder *folder);
const gchar * (*get_full_name) (CamelFolder *folder);
gboolean (*can_hold_folders) (CamelFolder *folder);
gboolean (*can_hold_messages) (CamelFolder *folder);
gboolean (*exists) (CamelFolder *folder);
gboolean (*is_open) (CamelFolder *folder);
CamelFolder * (*get_folder) (CamelFolder *folder, const gchar *folder_name);
gboolean (*create) (CamelFolder *folder);
gboolean (*delete) (CamelFolder *folder, gboolean recurse);
gboolean (*delete_messages) (CamelFolder *folder);
CamelFolder * (*get_parent_folder) (CamelFolder *folder);
CamelStore * (*get_parent_store) (CamelFolder *folder);
CamelFolderOpenMode (*get_mode) (CamelFolder *folder);
GList * (*list_subfolders) (CamelFolder *folder);
void (*expunge) (CamelFolder *folder);
CamelMimeMessage * (*get_message) (CamelFolder *folder, gint number);
gint (*get_message_count) (CamelFolder *folder);
gint (*append_message) (CamelFolder *folder, CamelMimeMessage *message);
const GList * (*list_permanent_flags) (CamelFolder *folder);
void (*copy_message_to) (CamelFolder *folder, CamelMimeMessage *message, CamelFolder *dest_folder);
const gchar * (*get_message_uid) (CamelFolder *folder, CamelMimeMessage *message);
CamelMimeMessage * (*get_message_by_uid) (CamelFolder *folder, const gchar *uid);
GList * (*get_uid_list) (CamelFolder *folder);
} CamelFolderClass;
/* Standard Gtk function */
GtkType camel_folder_get_type (void);
/* public methods */
CamelFolder *camel_folder_get_folder (CamelFolder *folder, gchar *folder_name);
void camel_folder_open (CamelFolder *folder, CamelFolderOpenMode mode);
void camel_folder_close (CamelFolder *folder, gboolean expunge);
gboolean camel_folder_create (CamelFolder *folder);
gboolean camel_folder_delete (CamelFolder *folder, gboolean recurse);
gboolean camel_folder_delete_messages (CamelFolder *folder);
CamelFolder *camel_folder_get_parent_folder (CamelFolder *folder);
CamelStore *camel_folder_get_parent_store (CamelFolder *folder);
CamelFolderOpenMode camel_folder_get_mode (CamelFolder *folder);
GList *camel_folder_list_subfolders (CamelFolder *folder);
GList *camel_folder_expunge (CamelFolder *folder, gboolean want_list);
void camel_folder_set_name (CamelFolder *folder, const gchar *name);
const gchar *camel_folder_get_name (CamelFolder *folder);
/* void camel_folder_set_full_name (CamelFolder *folder, const gchar *name); */
const gchar *camel_folder_get_full_name (CamelFolder *folder);
CamelMimeMessage *camel_folder_get_message (CamelFolder *folder, gint number);
gboolean camel_folder_exists (CamelFolder *folder);
gint camel_folder_get_message_count (CamelFolder *folder);
gint camel_folder_append_message (CamelFolder *folder, CamelMimeMessage *message);
const GList *camel_folder_list_permanent_flags (CamelFolder *folder);
void camel_folder_copy_message_to (CamelFolder *folder, CamelMimeMessage *message, CamelFolder *dest_folder);
gboolean camel_folder_has_summary_capability (CamelFolder *folder);
CamelFolderSummary *camel_folder_get_summary (CamelFolder *folder);
gboolean camel_folder_has_uid_capability (CamelFolder *folder);
const gchar * camel_folder_get_message_uid (CamelFolder *folder, CamelMimeMessage *message);
CamelMimeMessage *camel_folder_get_message_by_uid (CamelFolder *folder, const gchar *uid);
GList *camel_folder_get_uid_list (CamelFolder *folder);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_FOLDER_H */
|
