e9dc30dbf0
* camel-folder.[ch]: Remove
camel_folder_{get,free}_subfolder_info, as we want to be able to
scan the whole subfolder tree without having to open any folders,
so this needs to be in CamelStore. Remove can_hold_folders and
can_hold_messages flags; things that don't hold messages are no
longer considered CamelFolders.
* camel-folder-summary.[ch]: Remove CamelFolderInfo stuff.
* camel-store.[ch]: Add camel_store_{get,free}_folder_info, as
well as camel_store_free_folder_info_full and ..._nop for default
implementations, and camel_folder_info_free and
camel_folder_info_build as convenience functions. Turn
CamelFolderInfo into a tree structure and also add an "url"
member.
* providers/*/camel-*-folder.c: Remove subfolder_info and can_hold
stuff.
* providers/*/camel-*-store.c: Add folder_info stuff.
* providers/imap/camel-imap-folder.c (imap_summary_free): Free the
summary elements with camel_message_info_free, not
camel_folder_info_free. Oops.
* providers/imap/camel-imap-utils.c: const poison
svn path=/trunk/; revision=5663
273 lines
8.4 KiB
C
273 lines
8.4 KiB
C
/* -*- 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) (CAMEL_CHECK_CAST((obj), CAMEL_FOLDER_TYPE, CamelFolder))
|
|
#define CAMEL_FOLDER_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_FOLDER_TYPE, CamelFolderClass))
|
|
#define CAMEL_IS_FOLDER(o) (CAMEL_CHECK_TYPE((o), CAMEL_FOLDER_TYPE))
|
|
|
|
struct _CamelFolder
|
|
{
|
|
CamelObject parent_object;
|
|
|
|
int frozen;
|
|
gboolean folder_changed;
|
|
GList *messages_changed;
|
|
|
|
char *name;
|
|
char *full_name;
|
|
CamelStore *parent_store;
|
|
|
|
guint32 permanent_flags;
|
|
gboolean has_summary_capability:1;
|
|
gboolean has_search_capability:1;
|
|
};
|
|
|
|
typedef struct {
|
|
CamelObjectClass parent_class;
|
|
|
|
/* Virtual methods */
|
|
void (*refresh_info) (CamelFolder *folder, CamelException *ex);
|
|
|
|
void (*sync) (CamelFolder *folder, gboolean expunge,
|
|
CamelException *ex);
|
|
|
|
const char * (*get_name) (CamelFolder *folder);
|
|
const char * (*get_full_name) (CamelFolder *folder);
|
|
|
|
CamelStore * (*get_parent_store) (CamelFolder *folder);
|
|
|
|
void (*expunge) (CamelFolder *folder,
|
|
CamelException *ex);
|
|
|
|
int (*get_message_count) (CamelFolder *folder);
|
|
|
|
int (*get_unread_message_count) (CamelFolder *folder);
|
|
|
|
void (*append_message) (CamelFolder *folder,
|
|
CamelMimeMessage *message,
|
|
const CamelMessageInfo *info,
|
|
CamelException *ex);
|
|
|
|
guint32 (*get_permanent_flags) (CamelFolder *folder);
|
|
guint32 (*get_message_flags) (CamelFolder *folder,
|
|
const char *uid);
|
|
void (*set_message_flags) (CamelFolder *folder,
|
|
const char *uid,
|
|
guint32 flags, guint32 set);
|
|
|
|
gboolean (*get_message_user_flag) (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name);
|
|
void (*set_message_user_flag) (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name,
|
|
gboolean value);
|
|
|
|
const char * (*get_message_user_tag) (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name);
|
|
void (*set_message_user_tag) (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name,
|
|
const char *value);
|
|
|
|
CamelMimeMessage * (*get_message) (CamelFolder *folder,
|
|
const char *uid,
|
|
CamelException *ex);
|
|
|
|
GPtrArray * (*get_uids) (CamelFolder *folder);
|
|
void (*free_uids) (CamelFolder *folder,
|
|
GPtrArray *array);
|
|
|
|
GPtrArray * (*get_summary) (CamelFolder *folder);
|
|
void (*free_summary) (CamelFolder *folder,
|
|
GPtrArray *summary);
|
|
|
|
gboolean (*has_search_capability) (CamelFolder *folder);
|
|
|
|
GPtrArray * (*search_by_expression) (CamelFolder *folder,
|
|
const char *expression,
|
|
CamelException *ex);
|
|
|
|
void (*search_free) (CamelFolder *folder, GPtrArray *result);
|
|
|
|
const CamelMessageInfo * (*get_message_info) (CamelFolder *, const char *uid);
|
|
|
|
void (*copy_message_to) (CamelFolder *source,
|
|
const char *uid,
|
|
CamelFolder *destination,
|
|
CamelException *ex);
|
|
|
|
void (*move_message_to) (CamelFolder *source,
|
|
const char *uid,
|
|
CamelFolder *destination,
|
|
CamelException *ex);
|
|
|
|
void (*freeze) (CamelFolder *folder);
|
|
void (*thaw) (CamelFolder *folder);
|
|
} CamelFolderClass;
|
|
|
|
|
|
|
|
/* Standard Camel function */
|
|
CamelType camel_folder_get_type (void);
|
|
|
|
|
|
/* public methods */
|
|
void camel_folder_construct (CamelFolder *folder,
|
|
CamelStore *parent_store,
|
|
const char *full_name,
|
|
const char *name);
|
|
|
|
void camel_folder_refresh_info (CamelFolder * folder,
|
|
CamelException * ex);
|
|
void camel_folder_sync (CamelFolder *folder,
|
|
gboolean expunge,
|
|
CamelException *ex);
|
|
|
|
CamelStore * camel_folder_get_parent_store (CamelFolder *folder);
|
|
|
|
|
|
/* delete operations */
|
|
void camel_folder_expunge (CamelFolder *folder,
|
|
CamelException *ex);
|
|
|
|
|
|
/* folder name operations */
|
|
const char * camel_folder_get_name (CamelFolder *folder);
|
|
const char * camel_folder_get_full_name (CamelFolder *folder);
|
|
|
|
|
|
/* various properties accessors */
|
|
guint32 camel_folder_get_permanent_flags (CamelFolder *folder);
|
|
|
|
guint32 camel_folder_get_message_flags (CamelFolder *folder,
|
|
const char *uid);
|
|
|
|
void camel_folder_set_message_flags (CamelFolder *folder,
|
|
const char *uid,
|
|
guint32 flags,
|
|
guint32 set);
|
|
|
|
gboolean camel_folder_get_message_user_flag (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name);
|
|
|
|
void camel_folder_set_message_user_flag (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name,
|
|
gboolean value);
|
|
const char * camel_folder_get_message_user_tag (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name);
|
|
|
|
void camel_folder_set_message_user_tag (CamelFolder *folder,
|
|
const char *uid,
|
|
const char *name,
|
|
const char *value);
|
|
|
|
|
|
|
|
/* message manipulation */
|
|
void camel_folder_append_message (CamelFolder *folder,
|
|
CamelMimeMessage *message,
|
|
const CamelMessageInfo *info,
|
|
CamelException *ex);
|
|
|
|
|
|
/* summary related operations */
|
|
gboolean camel_folder_has_summary_capability (CamelFolder *folder);
|
|
|
|
|
|
int camel_folder_get_message_count (CamelFolder *folder);
|
|
|
|
int camel_folder_get_unread_message_count (CamelFolder *folder);
|
|
|
|
GPtrArray * camel_folder_get_summary (CamelFolder *folder);
|
|
void camel_folder_free_summary (CamelFolder *folder,
|
|
GPtrArray *array);
|
|
|
|
/* uid based access operations */
|
|
CamelMimeMessage * camel_folder_get_message (CamelFolder *folder,
|
|
const char *uid,
|
|
CamelException *ex);
|
|
#define camel_folder_delete_message(folder, uid) \
|
|
camel_folder_set_message_flags (folder, uid, CAMEL_MESSAGE_DELETED, CAMEL_MESSAGE_DELETED)
|
|
|
|
GPtrArray * camel_folder_get_uids (CamelFolder *folder);
|
|
void camel_folder_free_uids (CamelFolder *folder,
|
|
GPtrArray *array);
|
|
|
|
/* search api */
|
|
gboolean camel_folder_has_search_capability (CamelFolder *folder);
|
|
GPtrArray * camel_folder_search_by_expression (CamelFolder *folder,
|
|
const char *expression,
|
|
CamelException *ex);
|
|
void camel_folder_search_free (CamelFolder *folder, GPtrArray *);
|
|
|
|
/* summary info */
|
|
const CamelMessageInfo *camel_folder_get_message_info (CamelFolder *summary,
|
|
const char *uid);
|
|
|
|
void camel_folder_copy_message_to (CamelFolder *source,
|
|
const char *uid,
|
|
CamelFolder *dest,
|
|
CamelException *ex);
|
|
|
|
void camel_folder_move_message_to (CamelFolder *source,
|
|
const char *uid,
|
|
CamelFolder *dest,
|
|
CamelException *ex);
|
|
|
|
void camel_folder_freeze (CamelFolder *folder);
|
|
void camel_folder_thaw (CamelFolder *folder);
|
|
|
|
|
|
/* For use by subclasses (for free_{uids,summary,subfolder_names}) */
|
|
void camel_folder_free_nop (CamelFolder *folder, GPtrArray *array);
|
|
void camel_folder_free_shallow (CamelFolder *folder, GPtrArray *array);
|
|
void camel_folder_free_deep (CamelFolder *folder, GPtrArray *array);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* CAMEL_FOLDER_H */
|
|
|