aboutsummaryrefslogtreecommitdiffstats
path: root/libemail-engine/e-mail-session.h
blob: d2981de28b6018de33afce4f355c461e15e6dfae (plain) (blame)
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
166
167
168
169
170
171
172
173
174
175
176
/*
 * 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)
 *
 */

#if !defined (__LIBEMAIL_ENGINE_H_INSIDE__) && !defined (LIBEMAIL_ENGINE_COMPILATION)
#error "Only <libemail-engine/libemail-engine.h> should be included directly."
#endif

#ifndef E_MAIL_SESSION_H
#define E_MAIL_SESSION_H

#include <camel/camel.h>
#include <libedataserver/libedataserver.h>
#include <libemail-engine/e-mail-engine-enums.h>
#include <libemail-engine/e-mail-junk-filter.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);
EMailJunkFilter *
        e_mail_session_get_junk_filter_by_name
                        (EMailSession *session,
                         const gchar *filter_name);
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 */