diff options
Diffstat (limited to 'camel/camel-folder.h')
| -rw-r--r-- | camel/camel-folder.h | 289 |
1 files changed, 0 insertions, 289 deletions
diff --git a/camel/camel-folder.h b/camel/camel-folder.h deleted file mode 100644 index c90802c6c2..0000000000 --- a/camel/camel-folder.h +++ /dev/null @@ -1,289 +0,0 @@ -/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ -/* camel-folder.h: Abstract class for an email folder */ - -/* - * Author: - * Bertrand Guiheneuf <bertrand@helixcode.com> - * - * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com) - * - * 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 <camel/camel-object.h> -#include <camel/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 CAMEL_IS_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 -{ - CamelObject parent_object; - - CamelFolderOpenMode open_mode; - CamelFolderState open_state; - gchar *name; - gchar *full_name; - gchar separator; - CamelStore *parent_store; - CamelFolder *parent_folder; - guint32 permanent_flags; - - gboolean can_hold_folders:1; - gboolean can_hold_messages:1; - gboolean has_summary_capability:1; - gboolean has_search_capability:1; -}; - -typedef struct { - CamelObjectClass parent_class; - - /* signals */ - void (*folder_changed) (CamelFolder *, int type); - - /* Virtual methods */ - void (*init) (CamelFolder *folder, CamelStore *parent_store, - CamelFolder *parent_folder, const gchar *name, - gchar separator, CamelException *ex); - - void (*open) (CamelFolder *folder, - CamelFolderOpenMode mode, - CamelException *ex); - - void (*close) (CamelFolder *folder, - gboolean expunge, - CamelException *ex); - - 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, - CamelException *ex); - - gboolean (*is_open) (CamelFolder *folder); - - CamelFolder * (*get_subfolder) (CamelFolder *folder, - const gchar *folder_name, - CamelException *ex); - - gboolean (*create) (CamelFolder *folder, - CamelException *ex); - - gboolean (*delete) (CamelFolder *folder, - gboolean recurse, - CamelException *ex); - - gboolean (*delete_messages) (CamelFolder *folder, - CamelException *ex); - - CamelFolder * (*get_parent_folder) (CamelFolder *folder, - CamelException *ex); - - CamelStore * (*get_parent_store) (CamelFolder *folder, - CamelException *ex); - - CamelFolderOpenMode (*get_mode) (CamelFolder *folder, - CamelException *ex); - - void (*expunge) (CamelFolder *folder, - CamelException *ex); - - gint (*get_message_count) (CamelFolder *folder, - CamelException *ex); - - void (*append_message) (CamelFolder *folder, - CamelMimeMessage *message, - CamelException *ex); - - guint32 (*get_permanent_flags) (CamelFolder *folder, - CamelException *ex); - - const gchar * (*get_message_uid) (CamelFolder *folder, - CamelMimeMessage *message, - CamelException *ex); - - CamelMimeMessage * (*get_message_by_uid) (CamelFolder *folder, - const gchar *uid, - CamelException *ex); - - void (*delete_message_by_uid) (CamelFolder *folder, - const gchar *uid, - CamelException *ex); - - GPtrArray * (*get_uids) (CamelFolder *folder, - CamelException *ex); - void (*free_uids) (CamelFolder *folder, - GPtrArray *array); - - GPtrArray * (*get_summary) (CamelFolder *folder, - CamelException *ex); - void (*free_summary) (CamelFolder *folder, - GPtrArray *summary); - - GPtrArray * (*get_subfolder_names) (CamelFolder *folder, - CamelException *ex); - void (*free_subfolder_names) (CamelFolder *folder, - GPtrArray *subfolders); - - gboolean (*has_search_capability) (CamelFolder *folder); - - GList * (*search_by_expression) (CamelFolder *folder, const char *expression, CamelException *ex); - - const CamelMessageInfo * (*summary_get_by_uid) (CamelFolder *, const char *uid); -} CamelFolderClass; - - - -/* Standard Gtk function */ -GtkType camel_folder_get_type (void); - - -/* public methods */ - - - -CamelFolder * camel_folder_get_subfolder (CamelFolder *folder, - const gchar *folder_name, - CamelException *ex); - -void camel_folder_open (CamelFolder *folder, - CamelFolderOpenMode mode, - CamelException *ex); - - -void camel_folder_close (CamelFolder *folder, - gboolean expunge, - CamelException *ex); - -gboolean camel_folder_create (CamelFolder *folder, - CamelException *ex); -CamelFolder * camel_folder_get_parent_folder (CamelFolder *folder, - CamelException *ex); -CamelStore * camel_folder_get_parent_store (CamelFolder *folder, - CamelException *ex); -GList * camel_folder_list_subfolders (CamelFolder *folder, - CamelException *ex); - - -/* delete operations */ -gboolean camel_folder_delete (CamelFolder *folder, - gboolean recurse, - CamelException *ex); -gboolean camel_folder_delete_messages (CamelFolder *folder, - CamelException *ex); -void camel_folder_expunge (CamelFolder *folder, - CamelException *ex); - - -/* folder name operations */ -const gchar * camel_folder_get_name (CamelFolder *folder); -const gchar * camel_folder_get_full_name (CamelFolder *folder); - - -/* various properties accessors */ -gboolean camel_folder_exists (CamelFolder *folder, - CamelException *ex); -guint32 camel_folder_get_permanent_flags (CamelFolder *folder, - CamelException *ex); - -CamelFolderOpenMode camel_folder_get_mode (CamelFolder *folder, - CamelException *ex); -gboolean camel_folder_is_open (CamelFolder *folder); - - - -/* message manipulation */ -void camel_folder_append_message (CamelFolder *folder, - CamelMimeMessage *message, - CamelException *ex); - - -/* summary related operations */ -gboolean camel_folder_has_summary_capability (CamelFolder *folder); - - -gint camel_folder_get_message_count (CamelFolder *folder, - CamelException *ex); - -GPtrArray * camel_folder_get_summary (CamelFolder *folder, - CamelException *ex); -void camel_folder_free_summary (CamelFolder *folder, - GPtrArray *array); - -GPtrArray * camel_folder_get_subfolder_names (CamelFolder *folder, - CamelException *ex); -void camel_folder_free_subfolder_names (CamelFolder *folder, - GPtrArray *array); - - -/* uid based access operations */ -const gchar * camel_folder_get_message_uid (CamelFolder *folder, - CamelMimeMessage *message, - CamelException *ex); -CamelMimeMessage * camel_folder_get_message_by_uid (CamelFolder *folder, - const gchar *uid, - CamelException *ex); -void camel_folder_delete_message_by_uid (CamelFolder *folder, - const gchar *uid, - CamelException *ex); -GPtrArray * camel_folder_get_uids (CamelFolder *folder, - CamelException *ex); -void camel_folder_free_uids (CamelFolder *folder, - GPtrArray *array); - -/* search api */ -gboolean camel_folder_has_search_capability (CamelFolder *folder); -GList * camel_folder_search_by_expression(CamelFolder *folder, const char *expression, CamelException *ex); - -/* summary info. FIXME: rename this slightly? */ -const CamelMessageInfo *camel_folder_summary_get_by_uid (CamelFolder *summary, - const char *uid); - -#ifdef __cplusplus -} -#endif /* __cplusplus */ - -#endif /* CAMEL_FOLDER_H */ - |