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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-service.h : Abstract class for an email service */
/*
*
* 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_SERVICE_H
#define CAMEL_SERVICE_H 1
#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/
#include <camel/camel-object.h>
#include <camel/camel-url.h>
#include <camel/camel-provider.h>
#include <netdb.h>
#define CAMEL_SERVICE_TYPE (camel_service_get_type ())
#define CAMEL_SERVICE(obj) (CAMEL_CHECK_CAST((obj), CAMEL_SERVICE_TYPE, CamelService))
#define CAMEL_SERVICE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_SERVICE_TYPE, CamelServiceClass))
#define CAMEL_IS_SERVICE(o) (CAMEL_CHECK_TYPE((o), CAMEL_SERVICE_TYPE))
struct _CamelService {
CamelObject parent_object;
CamelSession *session;
CamelProvider *provider;
gboolean connected;
CamelURL *url;
int url_flags;
};
typedef struct {
CamelObjectClass parent_class;
gboolean (*connect) (CamelService *service,
CamelException *ex);
gboolean (*disconnect) (CamelService *service,
CamelException *ex);
/*gboolean (*is_connected) (CamelService *service);*/
GList * (*query_auth_types_connected) (CamelService *service,
CamelException *ex);
GList * (*query_auth_types_generic) (CamelService *service,
CamelException *ex);
void (*free_auth_types) (CamelService *service,
GList *authtypes);
char * (*get_name) (CamelService *service,
gboolean brief);
} CamelServiceClass;
/* Flags for url_flags. "ALLOW" means the config dialog will let
* the user configure it. "NEED" implies "ALLOW" but means the user
* must configure it. Service code can assume that any url part
* for which it has set the NEED flag will be set when the service
* is created.
*/
#define CAMEL_SERVICE_URL_ALLOW_USER (1 << 0)
#define CAMEL_SERVICE_URL_ALLOW_AUTH (1 << 1)
#define CAMEL_SERVICE_URL_ALLOW_PASSWORD (1 << 2)
#define CAMEL_SERVICE_URL_ALLOW_HOST (1 << 3)
#define CAMEL_SERVICE_URL_ALLOW_PORT (1 << 4)
#define CAMEL_SERVICE_URL_ALLOW_PATH (1 << 5)
#define CAMEL_SERVICE_URL_NEED_USER (1 << 6 | 1 << 0)
#define CAMEL_SERVICE_URL_NEED_AUTH (1 << 7 | 1 << 1)
#define CAMEL_SERVICE_URL_NEED_PASSWORD (1 << 8 | 1 << 2)
#define CAMEL_SERVICE_URL_NEED_HOST (1 << 9 | 1 << 3)
#define CAMEL_SERVICE_URL_NEED_PORT (1 << 10 | 1 << 4)
#define CAMEL_SERVICE_URL_NEED_PATH (1 << 11 | 1 << 5)
/* query_auth_types returns a GList of these */
typedef struct {
char *name, *description, *authproto;
gboolean need_password;
} CamelServiceAuthType;
/* public methods */
CamelService * camel_service_new (CamelType type,
CamelSession *session,
CamelProvider *provider,
CamelURL *url,
CamelException *ex);
gboolean camel_service_connect (CamelService *service,
CamelException *ex);
gboolean camel_service_disconnect (CamelService *service,
CamelException *ex);
char * camel_service_get_url (CamelService *service);
char * camel_service_get_name (CamelService *service,
gboolean brief);
CamelSession * camel_service_get_session (CamelService *service);
CamelProvider * camel_service_get_provider (CamelService *service);
GList * camel_service_query_auth_types (CamelService *service,
CamelException *ex);
void camel_service_free_auth_types (CamelService *service,
GList *authtypes);
/* convenience functions */
struct hostent * camel_service_gethost (CamelService *service,
CamelException *ex);
/* Standard Camel function */
CamelType camel_service_get_type (void);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_SERVICE_H */
|
