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

   1 /* Copyright (c) 2006, 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 #ifndef __MODEST_PROTOCOL_MGR_H__
  31 #define __MODEST_PROTOCOL_MGR_H__
  32
  33 #include <glib-object.h>
  34 #include <modest-pair.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_PROTOCOL_MGR             (modest_protocol_mgr_get_type())
  40 #define MODEST_PROTOCOL_MGR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PROTOCOL_MGR,ModestProtocolMgr))
  41 #define MODEST_PROTOCOL_MGR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_PROTOCOL_MGR,GObject))
  42 #define MODEST_IS_PROTOCOL_MGR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PROTOCOL_MGR))
  43 #define MODEST_IS_PROTOCOL_MGR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_PROTOCOL_MGR))
  44 #define MODEST_PROTOCOL_MGR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_PROTOCOL_MGR,ModestProtocolMgrClass))
  45
  46 typedef struct _ModestProtocolMgr      ModestProtocolMgr;
  47 typedef struct _ModestProtocolMgrClass ModestProtocolMgrClass;
  48
  49 struct _ModestProtocolMgr {
  50          GObject parent;
  51         /* insert public members, if any */
  52 };
  53
  54 struct _ModestProtocolMgrClass {
  55         GObjectClass parent_class;
  56         /* insert signal callback declarations, eg. */
  57         /* void (* my_event) (ModestProtocolMgr* obj); */
  58 };
  59
  60 /* transport */
  61 #define MODEST_PROTOCOL_TRANSPORT_SENDMAIL "sendmail"
  62 #define MODEST_PROTOCOL_TRANSPORT_SMTP     "smtp"
  63
  64 /* store */
  65 #define MODEST_PROTOCOL_STORE_NONE     "none"
  66 #define MODEST_PROTOCOL_STORE_POP      "pop"
  67 #define MODEST_PROTOCOL_STORE_IMAP     "imap"
  68 #define MODEST_PROTOCOL_STORE_MAILDIR  "maildir"
  69 #define MODEST_PROTOCOL_STORE_MBOX     "mbox"
  70
  71 /* security */
  72 #define MODEST_PROTOCOL_SECURITY_NONE  "none"
  73 #define MODEST_PROTOCOL_SECURITY_SSL   "ssl"
  74 #define MODEST_PROTOCOL_SECURITY_TLS   "tls"
  75
  76 /* authentication */
  77 #define MODEST_PROTOCOL_AUTH_NONE      "none"
  78 #define MODEST_PROTOCOL_AUTH_PASSWORD  "password"
  79
  80 typedef enum _ModestProtocolType {
  81         MODEST_PROTOCOL_TYPE_TRANSPORT,
  82         MODEST_PROTOCOL_TYPE_STORE,
  83         MODEST_PROTOCOL_TYPE_SECURITY,
  84         MODEST_PROTOCOL_TYPE_AUTH,
  85         MODEST_PROTOCOL_TYPE_ANY,
  86         MODEST_PROTOCOL_TYPE_NUM
  87 } ModestProtocolType;
  88 /* typedef enum _ModestProtocolType ModestProtocolType; */
  89
  90 /* member functions */
  91 GType        modest_protocol_mgr_get_type    (void) G_GNUC_CONST;
  92
  93 ModestProtocolMgr*    modest_protocol_mgr_new         (void);
  94
  95 const GSList*   modest_protocol_mgr_get_transport_protocols (ModestProtocolMgr *self);
  96 const GSList*   modest_protocol_mgr_get_store_protocols     (ModestProtocolMgr *self);
  97 const GSList*   modest_protocol_mgr_get_security_protocols  (ModestProtocolMgr *self);
  98 const GSList*   modest_protocol_mgr_get_auth_protocols      (ModestProtocolMgr *self);
  99
 100 gboolean modest_protocol_mgr_protocol_is_valid (ModestProtocolMgr *self, const gchar* proto,
 101                                                 ModestProtocolType type);
 102
 103 G_END_DECLS
 104 #endif /* __MODEST_PROTOCOL_MGR_H__ */
 105