d09d8de870
Evolution consists of entirely too many small utility libraries, which increases linking and loading time, places a burden on higher layers of the application (e.g. modules) which has to remember to link to all the small in-tree utility libraries, and makes it difficult to generate API documentation for these utility libraries in one Gtk-Doc module. Merge the following utility libraries under the umbrella of libeutil, and enforce a single-include policy on libeutil so we can reorganize the files as desired without disrupting its pseudo-public API. libemail-utils/libemail-utils.la libevolution-utils/libevolution-utils.la filter/libfilter.la widgets/e-timezone-dialog/libetimezonedialog.la widgets/menus/libmenus.la widgets/misc/libemiscwidgets.la widgets/table/libetable.la widgets/text/libetext.la This also merges libedataserverui from the Evolution-Data-Server module, since Evolution is its only consumer nowadays, and I'd like to make some improvements to those APIs without concern for backward-compatibility. And finally, start a Gtk-Doc module for libeutil. It's going to be a project just getting all the symbols _listed_ much less _documented_. But the skeletal structure is in place and I'm off to a good start.
168 lines
5.4 KiB
C
168 lines
5.4 KiB
C
/*
|
|
* e-mail-session.h
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) version 3.
|
|
*
|
|
* 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with the program; if not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*
|
|
* Authors:
|
|
* Jeffrey Stedfast <fejj@ximian.com>
|
|
*
|
|
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
|
|
*
|
|
*/
|
|
|
|
#ifndef E_MAIL_SESSION_H
|
|
#define E_MAIL_SESSION_H
|
|
|
|
#include <camel/camel.h>
|
|
#include <libedataserver/libedataserver.h>
|
|
#include <libemail-engine/e-mail-enums.h>
|
|
#include <libemail-engine/em-vfolder-context.h>
|
|
#include <libemail-engine/mail-folder-cache.h>
|
|
|
|
/* Standard GObject macros */
|
|
#define E_TYPE_MAIL_SESSION \
|
|
(e_mail_session_get_type ())
|
|
#define E_MAIL_SESSION(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_CAST \
|
|
((obj), E_TYPE_MAIL_SESSION, EMailSession))
|
|
#define E_MAIL_SESSION_CLASS(cls) \
|
|
(G_TYPE_CHECK_CLASS_CAST \
|
|
((cls), E_TYPE_MAIL_SESSION, EMailSessionClass))
|
|
#define E_IS_MAIL_SESSION(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_TYPE \
|
|
((obj), E_TYPE_MAIL_SESSION))
|
|
#define E_IS_MAIL_SESSION_CLASS(cls) \
|
|
(G_TYPE_CHECK_CLASS_TYPE \
|
|
((cls), E_TYPE_MAIL_SESSION))
|
|
#define E_MAIL_SESSION_GET_CLASS(obj) \
|
|
(G_TYPE_INSTANCE_GET_CLASS \
|
|
((obj), E_TYPE_MAIL_SESSION, EMailSessionClass))
|
|
|
|
/* Built-in CamelServices */
|
|
#define E_MAIL_SESSION_LOCAL_UID "local" /* "On This Computer" */
|
|
#define E_MAIL_SESSION_VFOLDER_UID "vfolder" /* "Search Folders" */
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
typedef struct _EMailSession EMailSession;
|
|
typedef struct _EMailSessionClass EMailSessionClass;
|
|
typedef struct _EMailSessionPrivate EMailSessionPrivate;
|
|
|
|
struct _EMailSession {
|
|
CamelSession parent;
|
|
EMailSessionPrivate *priv;
|
|
};
|
|
|
|
struct _EMailSessionClass {
|
|
CamelSessionClass parent_class;
|
|
|
|
EMVFolderContext *
|
|
(*create_vfolder_context)
|
|
(EMailSession *session);
|
|
void (*flush_outbox) (EMailSession *session);
|
|
void (*refresh_service) (EMailSession *session,
|
|
CamelService *service);
|
|
void (*store_added) (EMailSession *session,
|
|
CamelStore *store);
|
|
void (*store_removed) (EMailSession *session,
|
|
CamelStore *store);
|
|
};
|
|
|
|
GType e_mail_session_get_type (void);
|
|
EMailSession * e_mail_session_new (ESourceRegistry *registry);
|
|
ESourceRegistry *
|
|
e_mail_session_get_registry (EMailSession *session);
|
|
MailFolderCache *
|
|
e_mail_session_get_folder_cache (EMailSession *session);
|
|
CamelStore * e_mail_session_get_local_store (EMailSession *session);
|
|
CamelStore * e_mail_session_get_vfolder_store
|
|
(EMailSession *session);
|
|
CamelFolder * e_mail_session_get_local_folder (EMailSession *session,
|
|
EMailLocalFolder type);
|
|
const gchar * e_mail_session_get_local_folder_uri
|
|
(EMailSession *session,
|
|
EMailLocalFolder type);
|
|
GList * e_mail_session_get_available_junk_filters
|
|
(EMailSession *session);
|
|
CamelFolder * e_mail_session_get_inbox_sync (EMailSession *session,
|
|
const gchar *service_uid,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void e_mail_session_get_inbox (EMailSession *session,
|
|
const gchar *service_uid,
|
|
gint io_priority,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
CamelFolder * e_mail_session_get_inbox_finish (EMailSession *session,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
CamelFolder * e_mail_session_get_trash_sync (EMailSession *session,
|
|
const gchar *service_uid,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void e_mail_session_get_trash (EMailSession *session,
|
|
const gchar *service_uid,
|
|
gint io_priority,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
CamelFolder * e_mail_session_get_trash_finish (EMailSession *session,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
CamelFolder * e_mail_session_uri_to_folder_sync
|
|
(EMailSession *session,
|
|
const gchar *folder_uri,
|
|
CamelStoreGetFolderFlags flags,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void e_mail_session_uri_to_folder (EMailSession *session,
|
|
const gchar *folder_uri,
|
|
CamelStoreGetFolderFlags flags,
|
|
gint io_priority,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
CamelFolder * e_mail_session_uri_to_folder_finish
|
|
(EMailSession *session,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
EMVFolderContext *
|
|
e_mail_session_create_vfolder_context
|
|
(EMailSession *session);
|
|
|
|
/* Useful GBinding transform functions */
|
|
gboolean e_binding_transform_service_to_source
|
|
(GBinding *binding,
|
|
const GValue *source_value,
|
|
GValue *target_value,
|
|
gpointer session);
|
|
gboolean e_binding_transform_source_to_service
|
|
(GBinding *binding,
|
|
const GValue *source_value,
|
|
GValue *target_value,
|
|
gpointer session);
|
|
|
|
/*** Legacy API ***/
|
|
|
|
void mail_session_flush_filter_log (EMailSession *session);
|
|
const gchar * mail_session_get_data_dir (void);
|
|
const gchar * mail_session_get_cache_dir (void);
|
|
const gchar * mail_session_get_config_dir (void);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* E_MAIL_SESSION_H */
|