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  * Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
   6  *          Michael Zucchi <notzed@ximian.com>
   7  *
   8  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   9  *
  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.
  13  *
  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.
  18  *
  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
  22  * USA
  23  */
  24
  25 #if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
  26 #error "Only <camel/camel.h> can be included directly."
  27 #endif
  28
  29 #ifndef CAMEL_SERVICE_H
  30 #define CAMEL_SERVICE_H
  31
  32 #include <camel/camel-object.h>
  33 #include <camel/camel-url.h>
  34 #include <camel/camel-provider.h>
  35 #include <camel/camel-operation.h>
  36
  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))
  43
  44 G_BEGIN_DECLS
  45
  46 struct _CamelSession;
  47
  48 typedef struct _CamelService CamelService;
  49 typedef struct _CamelServiceClass CamelServiceClass;
  50 typedef struct _CamelServicePrivate CamelServicePrivate;
  51
  52 enum {
  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
  59 };
  60
  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)
  66
  67 typedef enum {
  68         CAMEL_SERVICE_DISCONNECTED,
  69         CAMEL_SERVICE_CONNECTING,
  70         CAMEL_SERVICE_CONNECTED,
  71         CAMEL_SERVICE_DISCONNECTING
  72 } CamelServiceConnectionStatus;
  73
  74 struct _CamelService {
  75         CamelObject parent;
  76         CamelServicePrivate *priv;
  77
  78         struct _CamelSession *session;
  79         CamelProvider *provider;
  80         CamelServiceConnectionStatus status;
  81         CamelOperation *connect_op;
  82         CamelURL *url;
  83 };
  84
  85 struct _CamelServiceClass {
  86         CamelObjectClass parent_class;
  87
  88         void            (*construct)            (CamelService *service,
  89                                                  struct _CamelSession *session,
  90                                                  CamelProvider *provider,
  91                                                  CamelURL *url,
  92                                                  CamelException *ex);
  93         gboolean        (*connect)              (CamelService *service,
  94                                                  CamelException *ex);
  95         gboolean        (*disconnect)           (CamelService *service,
  96                                                  gboolean clean,
  97                                                  CamelException *ex);
  98         void            (*cancel_connect)       (CamelService *service);
  99         GList *         (*query_auth_types)     (CamelService *service,
 100                                                  CamelException *ex);
 101         gchar *         (*get_name)             (CamelService *service,
 102                                                  gboolean brief);
 103         gchar *         (*get_path)             (CamelService *service);
 104 };
 105
 106 /* query_auth_types returns a GList of these */
 107 typedef struct {
 108         const gchar *name;               /* user-friendly name */
 109         const gchar *description;
 110         const gchar *authproto;
 111
 112         gboolean need_password;   /* needs a password to authenticate */
 113 } CamelServiceAuthType;
 114
 115 CamelType       camel_service_get_type          (void);
 116 void            camel_service_construct         (CamelService *service,
 117                                                  struct _CamelSession *session,
 118                                                  CamelProvider *provider,
 119                                                  CamelURL *url,
 120                                                  CamelException *ex);
 121 gboolean        camel_service_connect           (CamelService *service,
 122                                                  CamelException *ex);
 123 gboolean        camel_service_disconnect        (CamelService *service,
 124                                                  gboolean clean,
 125                                                  CamelException *ex);
 126 void            camel_service_cancel_connect    (CamelService *service);
 127 gchar *         camel_service_get_url           (CamelService *service);
 128 gchar *         camel_service_get_name          (CamelService *service,
 129                                                  gboolean brief);
 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,
 135                                                  CamelException *ex);
 136
 137 G_END_DECLS
 138
 139 #endif /* CAMEL_SERVICE_H */