git.maemo.org Git - modest/blob - src/modest-protocol-registry.h

   1 /* Copyright (c) 2007, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30
  31 /* modest-account-settings.h */
  32
  33 #ifndef __MODEST_PROTOCOL_REGISTRY_H__
  34 #define __MODEST_PROTOCOL_REGISTRY_H__
  35
  36 #include <glib-object.h>
  37 #include "modest-protocol.h"
  38 #include "modest-pair.h"
  39
  40 G_BEGIN_DECLS
  41
  42 #define MODEST_PROTOCOL_REGISTRY_CONNECTION_PROTOCOLS "connection"
  43 #define MODEST_PROTOCOL_REGISTRY_AUTH_PROTOCOLS "auth"
  44 #define MODEST_PROTOCOL_REGISTRY_TRANSPORT_STORE_PROTOCOLS "transport-store"
  45 #define MODEST_PROTOCOL_REGISTRY_STORE_PROTOCOLS "store"
  46 #define MODEST_PROTOCOL_REGISTRY_TRANSPORT_PROTOCOLS "transport"
  47 #define MODEST_PROTOCOL_REGISTRY_LOCAL_STORE_PROTOCOLS "local-store"
  48 #define MODEST_PROTOCOL_REGISTRY_REMOTE_STORE_PROTOCOLS "remote-store"
  49 #define MODEST_PROTOCOL_REGISTRY_SECURE_PROTOCOLS "secure"
  50 #define MODEST_PROTOCOL_REGISTRY_HAS_LEAVE_ON_SERVER_PROTOCOLS "leave-on-server-available"
  51 #define MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS "providers"
  52 #define MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS "singleton-providers"
  53 #define MODEST_PROTOCOL_REGISTRY_MULTI_MAILBOX_PROVIDER_PROTOCOLS "multi-mailbox-providers"
  54 #define MODEST_PROTOCOL_REGISTRY_USE_ALTERNATE_PORT "use-alternate-port"
  55 #define MODEST_PROTOCOL_REGISTRY_STORE_HAS_FOLDERS "store-has-folders"
  56 #define MODEST_PROTOCOL_REGISTRY_STORE_FORBID_MESSAGE_ADD "store-forbid-message-add"
  57 #define MODEST_PROTOCOL_REGISTRY_NO_AUTO_UPDATE_PROTOCOLS "no-auto-update"
  58
  59 /* convenience macros */
  60 #define MODEST_TYPE_PROTOCOL_REGISTRY             (modest_protocol_registry_get_type())
  61 #define MODEST_PROTOCOL_REGISTRY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PROTOCOL_REGISTRY,ModestProtocolRegistry))
  62 #define MODEST_PROTOCOL_REGISTRY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_PROTOCOL_REGISTRY,ModestProtocolRegistryClass))
  63 #define MODEST_IS_PROTOCOL_REGISTRY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PROTOCOL_REGISTRY))
  64 #define MODEST_IS_PROTOCOL_REGISTRY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_PROTOCOL_REGISTRY))
  65 #define MODEST_PROTOCOL_REGISTRY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_PROTOCOL_REGISTRY,ModestProtocolRegistryClass))
  66
  67 /* a special type, equivalent to a NULL protocol */
  68 #define MODEST_PROTOCOL_REGISTRY_TYPE_INVALID -1
  69
  70 /* The minimum priority custom protocols should take for their index */
  71 #define MODEST_PROTOCOL_REGISTRY_USER_PRIORITY 100
  72
  73 /* macros to access the default configured protocols */
  74 #define MODEST_PROTOCOLS_TRANSPORT_SMTP (modest_protocol_registry_get_smtp_type_id())
  75 #define MODEST_PROTOCOLS_TRANSPORT_SENDMAIL (modest_protocol_registry_get_sendmail_type_id())
  76 #define MODEST_PROTOCOLS_STORE_POP (modest_protocol_registry_get_pop_type_id())
  77 #define MODEST_PROTOCOLS_STORE_IMAP (modest_protocol_registry_get_imap_type_id())
  78 #define MODEST_PROTOCOLS_STORE_MAILDIR (modest_protocol_registry_get_maildir_type_id())
  79 #define MODEST_PROTOCOLS_STORE_MBOX (modest_protocol_registry_get_mbox_type_id())
  80 #define MODEST_PROTOCOLS_CONNECTION_NONE (modest_protocol_registry_get_none_connection_type_id ())
  81 #define MODEST_PROTOCOLS_CONNECTION_TLS (modest_protocol_registry_get_tls_connection_type_id ())
  82 #define MODEST_PROTOCOLS_CONNECTION_SSL (modest_protocol_registry_get_ssl_connection_type_id ())
  83 #define MODEST_PROTOCOLS_CONNECTION_TLSOP (modest_protocol_registry_get_tlsop_connection_type_id ())
  84 #define MODEST_PROTOCOLS_AUTH_NONE (modest_protocol_registry_get_none_auth_type_id ())
  85 #define MODEST_PROTOCOLS_AUTH_PASSWORD (modest_protocol_registry_get_password_auth_type_id ())
  86 #define MODEST_PROTOCOLS_AUTH_CRAMMD5 (modest_protocol_registry_get_crammd5_auth_type_id ())
  87
  88 /* properties available */
  89 #define MODEST_PROTOCOL_SECURITY_ACCOUNT_OPTION "modest-security-account-option"
  90 #define MODEST_PROTOCOL_AUTH_ACCOUNT_OPTION "modest-auth-account-option"
  91
  92 /* translations */
  93 #define MODEST_PROTOCOL_TRANSLATION_DELETE_MAILBOX "translation-delete-mailbox" /* title string */
  94 #define MODEST_PROTOCOL_TRANSLATION_CONNECT_ERROR "translation-connect-error" /* server name */
  95 #define MODEST_PROTOCOL_TRANSLATION_AUTH_ERROR "translation-auth-error" /* server name */
  96 #define MODEST_PROTOCOL_TRANSLATION_ACCOUNT_CONNECTION_ERROR "translation-account-connection-error" /* hostname */
  97 #define MODEST_PROTOCOL_TRANSLATION_MSG_NOT_AVAILABLE "translation-msg-not-available" /* subject */
  98 #define MODEST_PROTOCOL_TRANSLATION_SSL_PROTO_NAME "translation-ssl-proto-name"
  99
 100
 101 typedef struct _ModestProtocolRegistry      ModestProtocolRegistry;
 102 typedef struct _ModestProtocolRegistryClass ModestProtocolRegistryClass;
 103
 104 typedef guint ModestProtocolRegistryType;
 105
 106 struct _ModestProtocolRegistry {
 107         GObject parent;
 108 };
 109
 110 struct _ModestProtocolRegistryClass {
 111         GObjectClass parent_class;
 112 };
 113
 114 /**
 115  * modest_protocol_registry_get_type:
 116  *
 117  * Returns: GType of the account store
 118  */
 119 GType  modest_protocol_registry_get_type   (void) G_GNUC_CONST;
 120
 121 /**
 122  * modest_protocol_registry_new:
 123  *
 124  * creates a new instance of #ModestProtocolRegistry
 125  *
 126  * Returns: a #ModestProtocolRegistry
 127  */
 128 ModestProtocolRegistry*    modest_protocol_registry_new (void);
 129
 130 /**
 131  * modest_protocol_registry_add:
 132  * @self: a #ModestProtocolRegistry
 133  * @protocol: a #ModestProtocol
 134  * @priority: priority establishes the order the protocols will be shown on listings
 135  * @first_tag: a string
 136  * @...: a %NULL terminated list of strings with the tags for the protocol
 137  *
 138  * Add @protocol to the registry @self, setting the proper identifying tags
 139  */
 140 void modest_protocol_registry_add (ModestProtocolRegistry *self, ModestProtocol *protocol, gint priority, const gchar *first_tag, ...);
 141
 142 /**
 143  * modest_protocol_registry_get_all:
 144  * @self: a #ModestProtocolRegistry
 145  *
 146  * obtains a list of all protocols registered in @self
 147  *
 148  * Returns: a newly allocated GSList of the protocols. Don't unref the protocols, only the list.
 149  */
 150 GSList *modest_protocol_registry_get_all (ModestProtocolRegistry *self);
 151
 152 /**
 153  * modest_protocol_registry_get_by_tag:
 154  * @self: a #ModestProtocolRegistry
 155  * @tag: a string
 156  *
 157  * obtains a list of all protocols registered in @self tagged with @tag
 158  *
 159  * Returns: a newly allocated GSList of the protocols. Don't unref the protocol, only the list.
 160  */
 161 GSList *modest_protocol_registry_get_by_tag (ModestProtocolRegistry *self, const gchar *tag);
 162
 163 /**
 164  * modest_protocol_registry_get_pair_list_by_tag:
 165  * @self: a #ModestProtocolRegistry
 166  * @tag: a string
 167  *
 168  * obtains a pair list of all protocols registered in @self tagged with @tag
 169  *
 170  * Returns: a newly allocated #ModestPairList of the protocols. Should be freed using
 171  * modest_pair_list_free ()
 172  */
 173 ModestPairList *modest_protocol_registry_get_pair_list_by_tag (ModestProtocolRegistry *self, const gchar *tag);
 174
 175 /**
 176  * modest_protocol_registry_get_protocol_by_name:
 177  * @self: a #ModestProtocolRegistry
 178  * @tag: a string
 179  * @name: a string
 180  *
 181  * Obtains the protocol in registry @self, tagged with @tag and with @name
 182  *
 183  * Returns: the obtained #ModestProtocol, or %NULL if not found.
 184  */
 185 ModestProtocol *modest_protocol_registry_get_protocol_by_name (ModestProtocolRegistry *self, const gchar *tag, const gchar *name);
 186
 187 /**
 188  * modest_protocol_registry_get_protocol_by_type:
 189  * @self: a #ModestProtocolRegistry
 190  * @type_id: a #ModestProtocolType
 191  *
 192  * Obtains the protocol in registry @self, identified by @type_id
 193  *
 194  * Returns: the obtained #ModestProtocol, or %NULL if not found.
 195  */
 196 ModestProtocol *modest_protocol_registry_get_protocol_by_type (ModestProtocolRegistry *self, ModestProtocolType type_id);
 197
 198 /**
 199  * modest_protocol_registry_protocol_type_has_tag:
 200  * @self: a #ModestProtocolRegistry
 201  * @type_id: a #ModestProtocolType
 202  * @tag: a string
 203  *
 204  * Checks if a protocol identified with @type_id has a specific @tag.
 205  *
 206  * Returns: %TRUE if @type_id protocol has @tag in registry @self
 207  */
 208 gboolean modest_protocol_registry_protocol_type_has_tag (ModestProtocolRegistry *self, ModestProtocolType type_id, const gchar *tag);
 209
 210 #define modest_protocol_registry_protocol_type_is_secure(registry,protocol_type) \
 211         modest_protocol_registry_protocol_type_has_tag ((registry), (protocol_type), \
 212                                                         MODEST_PROTOCOL_REGISTRY_SECURE_PROTOCOLS)
 213
 214 #define modest_protocol_registry_protocol_type_is_provider(registry,protocol_type) \
 215         modest_protocol_registry_protocol_type_has_tag ((registry), (protocol_type), \
 216                                                         MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS)
 217
 218 #define modest_protocol_registry_protocol_type_is_singleton_provider(registry,protocol_type) \
 219         modest_protocol_registry_protocol_type_has_tag ((registry), (protocol_type), \
 220                                                         MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS)
 221
 222 #define modest_protocol_registry_protocol_type_has_leave_on_server(registry,protocol_type) \
 223         modest_protocol_registry_protocol_type_has_tag ((registry), (protocol_type), \
 224                                                         MODEST_PROTOCOL_REGISTRY_HAS_LEAVE_ON_SERVER_PROTOCOLS)
 225
 226 /**
 227  * @self: a #ModestProtocolRegistry
 228  *
 229  * Set default available protocols in Modest in @self
 230  */
 231 void modest_protocol_registry_set_to_default (ModestProtocolRegistry *self);
 232
 233 ModestProtocolType modest_protocol_registry_get_imap_type_id (void);
 234 ModestProtocolType modest_protocol_registry_get_pop_type_id (void);
 235 ModestProtocolType modest_protocol_registry_get_maildir_type_id (void);
 236 ModestProtocolType modest_protocol_registry_get_mbox_type_id (void);
 237 ModestProtocolType modest_protocol_registry_get_smtp_type_id (void);
 238 ModestProtocolType modest_protocol_registry_get_sendmail_type_id (void);
 239 ModestProtocolType modest_protocol_registry_get_none_connection_type_id (void);
 240 ModestProtocolType modest_protocol_registry_get_tls_connection_type_id (void);
 241 ModestProtocolType modest_protocol_registry_get_ssl_connection_type_id (void);
 242 ModestProtocolType modest_protocol_registry_get_tlsop_connection_type_id (void);
 243 ModestProtocolType modest_protocol_registry_get_none_auth_type_id (void);
 244 ModestProtocolType modest_protocol_registry_get_password_auth_type_id (void);
 245 ModestProtocolType modest_protocol_registry_get_crammd5_auth_type_id (void);
 246
 247 G_END_DECLS
 248
 249 #endif /* __MODEST_PROTOCOL_REGISTRY_H__ */