camel/camel-service.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /* camel-service.h : Abstract class for an email service */
   3
   4 /*
   5  *
   6  * Author :
   7  *  Bertrand Guiheneuf <bertrand@helixcode.com>
   8  *
   9  * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of the
  14  * License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24  * USA
  25  */
  26
  27
  28 #ifndef CAMEL_SERVICE_H
  29 #define CAMEL_SERVICE_H 1
  30
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #pragma }
  35 #endif /* __cplusplus }*/
  36
  37 #include <camel/camel-object.h>
  38 #include <camel/camel-url.h>
  39 #include <netdb.h>
  40
  41 #define CAMEL_SERVICE_TYPE     (camel_service_get_type ())
  42 #define CAMEL_SERVICE(obj)     (GTK_CHECK_CAST((obj), CAMEL_SERVICE_TYPE, CamelService))
  43 #define CAMEL_SERVICE_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), CAMEL_SERVICE_TYPE, CamelServiceClass))
  44 #define CAMEL_IS_SERVICE(o)    (GTK_CHECK_TYPE((o), CAMEL_SERVICE_TYPE))
  45
  46
  47 struct _CamelService {
  48         CamelObject parent_object;
  49
  50         CamelSession *session;
  51         gboolean connected;
  52         CamelURL *url;
  53         int url_flags;
  54 };
  55
  56
  57 typedef struct {
  58         CamelObjectClass parent_class;
  59
  60         gboolean  (*connect)           (CamelService *service,
  61                                         CamelException *ex);
  62         gboolean  (*connect_with_url)  (CamelService *service,
  63                                         CamelURL *url,
  64                                         CamelException *ex);
  65         gboolean  (*disconnect)        (CamelService *service,
  66                                         CamelException *ex);
  67
  68         gboolean  (*is_connected)      (CamelService *service);
  69
  70         GList *   (*query_auth_types)  (CamelService *service,
  71                                         CamelException *ex);
  72         void      (*free_auth_types)   (CamelService *service,
  73                                         GList *authtypes);
  74
  75 } CamelServiceClass;
  76
  77
  78
  79 /* flags for url_flags. (others can be added if needed) */
  80 #define CAMEL_SERVICE_URL_NEED_USER     (1 << 1)
  81 #define CAMEL_SERVICE_URL_NEED_AUTH     (1 << 2)
  82 #define CAMEL_SERVICE_URL_NEED_HOST     (1 << 4)
  83 #define CAMEL_SERVICE_URL_NEED_PATH     (1 << 6)
  84
  85
  86 /* query_auth_types returns a GList of these */
  87 typedef struct {
  88         char *name, *description, *authproto;
  89         gboolean need_password;
  90 } CamelServiceAuthType;
  91
  92
  93 /* public methods */
  94 CamelService *      camel_service_new                (GtkType type,
  95                                                       CamelSession *session,
  96                                                       CamelURL *url,
  97                                                       CamelException *ex);
  98
  99 gboolean            camel_service_connect            (CamelService *service,
 100                                                       CamelException *ex);
 101 gboolean            camel_service_connect_with_url   (CamelService *service,
 102                                                       char *url,
 103                                                       CamelException *ex);
 104 gboolean            camel_service_disconnect         (CamelService *service,
 105                                                       CamelException *ex);
 106 gboolean            camel_service_is_connected       (CamelService *service);
 107
 108 char *              camel_service_get_url            (CamelService *service);
 109 CamelSession *      camel_service_get_session        (CamelService *service);
 110
 111 GList *             camel_service_query_auth_types   (CamelService *service,
 112                                                       CamelException *ex);
 113 void                camel_service_free_auth_types    (CamelService *service,
 114                                                       GList *authtypes);
 115
 116 /* convenience functions */
 117 struct hostent *    camel_service_gethost            (CamelService *service,
 118                                                       CamelException *ex);
 119
 120
 121 /* Standard Gtk function */
 122 GtkType camel_service_get_type (void);
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif /* __cplusplus */
 127
 128 #endif /* CAMEL_SERVICE_H */
 129