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
|
/*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
* This library 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.
*
* This library 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 this library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors: Michael Zucchi <notzed@ximian.com>
* Jeffrey Stedfast <fejj@ximian.com>
*/
#if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
#error "Only <camel/camel.h> can be included directly."
#endif
#ifndef CAMEL_FILTER_DRIVER_H
#define CAMEL_FILTER_DRIVER_H
#include <camel/camel-folder.h>
#include <camel/camel-uid-cache.h>
/* Standard GObject macros */
#define CAMEL_TYPE_FILTER_DRIVER \
(camel_filter_driver_get_type ())
#define CAMEL_FILTER_DRIVER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), CAMEL_TYPE_FILTER_DRIVER, CamelFilterDriver))
#define CAMEL_FILTER_DRIVER_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), CAMEL_TYPE_FILTER_DRIVER, CamelFilterDriverClass)
#define CAMEL_IS_FILTER_DRIVER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), CAMEL_TYPE_FILTER_DRIVER))
#define CAMEL_IS_FILTER_DRIVER_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), CAMEL_TYPE_FILTER_DRIVER))
#define CAMEL_FILTER_DRIVER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), CAMEL_TYPE_FILTER_DRIVER, CamelFilterDriverClass))
G_BEGIN_DECLS
struct _CamelSession;
typedef struct _CamelFilterDriver CamelFilterDriver;
typedef struct _CamelFilterDriverClass CamelFilterDriverClass;
typedef struct _CamelFilterDriverPrivate CamelFilterDriverPrivate;
struct _CamelFilterDriver {
GObject parent;
CamelFilterDriverPrivate *priv;
};
struct _CamelFilterDriverClass {
GObjectClass parent_class;
};
/* FIXME: this maybe should change... */
/* type of status for a status report */
enum camel_filter_status_t {
CAMEL_FILTER_STATUS_NONE,
CAMEL_FILTER_STATUS_START, /* start of new message processed */
CAMEL_FILTER_STATUS_ACTION, /* an action performed */
CAMEL_FILTER_STATUS_PROGRESS, /* (an) extra update (s), if its taking longer to process */
CAMEL_FILTER_STATUS_END /* end of message */
};
typedef CamelFolder * (*CamelFilterGetFolderFunc) (CamelFilterDriver *driver, const gchar *uri,
gpointer data, GError **error);
/* report status */
typedef void (CamelFilterStatusFunc) (CamelFilterDriver *driver, enum camel_filter_status_t status,
gint pc, const gchar *desc, gpointer data);
typedef void (CamelFilterShellFunc) (CamelFilterDriver *driver, gint argc, gchar **argv, gpointer data);
typedef void (CamelFilterPlaySoundFunc) (CamelFilterDriver *driver, const gchar *filename, gpointer data);
typedef void (CamelFilterSystemBeepFunc) (CamelFilterDriver *driver, gpointer data);
GType camel_filter_driver_get_type (void);
CamelFilterDriver *camel_filter_driver_new (struct _CamelSession *);
/* modifiers */
void camel_filter_driver_set_logfile (CamelFilterDriver *d, FILE *logfile);
void camel_filter_driver_set_status_func (CamelFilterDriver *d, CamelFilterStatusFunc *func, gpointer data);
void camel_filter_driver_set_shell_func (CamelFilterDriver *d, CamelFilterShellFunc *func, gpointer data);
void camel_filter_driver_set_play_sound_func (CamelFilterDriver *d, CamelFilterPlaySoundFunc *func, gpointer data);
void camel_filter_driver_set_system_beep_func (CamelFilterDriver *d, CamelFilterSystemBeepFunc *func, gpointer data);
void camel_filter_driver_set_folder_func (CamelFilterDriver *d, CamelFilterGetFolderFunc fetcher, gpointer data);
void camel_filter_driver_set_default_folder (CamelFilterDriver *d, CamelFolder *def);
void camel_filter_driver_add_rule (CamelFilterDriver *d, const gchar *name, const gchar *match,
const gchar *action);
gint camel_filter_driver_remove_rule_by_name (CamelFilterDriver *d, const gchar *name);
/*void camel_filter_driver_set_global(CamelFilterDriver *, const gchar *name, const gchar *value);*/
void camel_filter_driver_flush (CamelFilterDriver *driver, GError **error);
gint camel_filter_driver_filter_message
(CamelFilterDriver *driver,
CamelMimeMessage *message,
CamelMessageInfo *info,
const gchar *uid,
CamelFolder *source,
const gchar *store_uid,
const gchar *original_store_uid,
GCancellable *cancellable,
GError **error);
gint camel_filter_driver_filter_mbox (CamelFilterDriver *driver,
const gchar *mbox,
const gchar *original_source_url,
GCancellable *cancellable,
GError **error);
gint camel_filter_driver_filter_folder
(CamelFilterDriver *driver,
CamelFolder *folder,
CamelUIDCache *cache,
GPtrArray *uids,
gboolean remove,
GCancellable *cancellable,
GError **error);
G_END_DECLS
#endif /* CAMEL_FILTER_DRIVER_H */
|
