1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2 /* camel-service.h : Abstract class for an email service */
5 * Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
6 * Michael Zucchi <notzed@ximian.com>
8 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of version 2 of the GNU Lesser General Public
12 * License as published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
25 #if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
26 #error "Only <camel/camel.h> can be included directly."
29 #ifndef CAMEL_SERVICE_H
30 #define CAMEL_SERVICE_H
32 #include <camel/camel-object.h>
33 #include <camel/camel-url.h>
34 #include <camel/camel-provider.h>
35 #include <camel/camel-operation.h>
37 #define CAMEL_SERVICE_TYPE (camel_service_get_type ())
38 #define CAMEL_SERVICE(obj) (CAMEL_CHECK_CAST((obj), CAMEL_SERVICE_TYPE, CamelService))
39 #define CAMEL_SERVICE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_SERVICE_TYPE, CamelServiceClass))
40 #define CAMEL_IS_SERVICE(o) (CAMEL_CHECK_TYPE((o), CAMEL_SERVICE_TYPE))
41 #define CAMEL_SERVICE_GET_CLASS(obj) \
42 ((CamelServiceClass *) CAMEL_OBJECT_GET_CLASS (obj))
48 typedef struct _CamelService CamelService;
49 typedef struct _CamelServiceClass CamelServiceClass;
50 typedef struct _CamelServicePrivate CamelServicePrivate;
53 CAMEL_SERVICE_ARG_FIRST = CAMEL_ARG_FIRST + 100,
54 CAMEL_SERVICE_ARG_USERNAME,
55 CAMEL_SERVICE_ARG_AUTH,
56 CAMEL_SERVICE_ARG_HOSTNAME,
57 CAMEL_SERVICE_ARG_PORT,
58 CAMEL_SERVICE_ARG_PATH
61 #define CAMEL_SERVICE_USERNAME (CAMEL_SERVICE_ARG_USERNAME | CAMEL_ARG_STR)
62 #define CAMEL_SERVICE_AUTH (CAMEL_SERVICE_ARG_AUTH | CAMEL_ARG_STR)
63 #define CAMEL_SERVICE_HOSTNAME (CAMEL_SERVICE_ARG_HOSTNAME | CAMEL_ARG_STR)
64 #define CAMEL_SERVICE_PORT (CAMEL_SERVICE_ARG_PORT | CAMEL_ARG_INT)
65 #define CAMEL_SERVICE_PATH (CAMEL_SERVICE_ARG_PATH | CAMEL_ARG_STR)
68 CAMEL_SERVICE_DISCONNECTED,
69 CAMEL_SERVICE_CONNECTING,
70 CAMEL_SERVICE_CONNECTED,
71 CAMEL_SERVICE_DISCONNECTING
72 } CamelServiceConnectionStatus;
74 struct _CamelService {
76 CamelServicePrivate *priv;
78 struct _CamelSession *session;
79 CamelProvider *provider;
80 CamelServiceConnectionStatus status;
81 CamelOperation *connect_op;
85 struct _CamelServiceClass {
86 CamelObjectClass parent_class;
88 void (*construct) (CamelService *service,
89 struct _CamelSession *session,
90 CamelProvider *provider,
93 gboolean (*connect) (CamelService *service,
95 gboolean (*disconnect) (CamelService *service,
98 void (*cancel_connect) (CamelService *service);
99 GList * (*query_auth_types) (CamelService *service,
101 gchar * (*get_name) (CamelService *service,
103 gchar * (*get_path) (CamelService *service);
106 /* query_auth_types returns a GList of these */
108 const gchar *name; /* user-friendly name */
109 const gchar *description;
110 const gchar *authproto;
112 gboolean need_password; /* needs a password to authenticate */
113 } CamelServiceAuthType;
115 CamelType camel_service_get_type (void);
116 void camel_service_construct (CamelService *service,
117 struct _CamelSession *session,
118 CamelProvider *provider,
121 gboolean camel_service_connect (CamelService *service,
123 gboolean camel_service_disconnect (CamelService *service,
126 void camel_service_cancel_connect (CamelService *service);
127 gchar * camel_service_get_url (CamelService *service);
128 gchar * camel_service_get_name (CamelService *service,
130 gchar * camel_service_get_path (CamelService *service);
131 struct _CamelSession *
132 camel_service_get_session (CamelService *service);
133 CamelProvider * camel_service_get_provider (CamelService *service);
134 GList * camel_service_query_auth_types (CamelService *service,
139 #endif /* CAMEL_SERVICE_H */