git.maemo.org Git - modest/blob - src/modest-protocol-info.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_INFO_H__
  31 #define __MODEST_PROTOCOL_INFO_H__
  32
  33 #include <modest-pair.h>
  34 #include <glib.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /** Transport and Store protocols. */
  39 typedef enum {
  40         MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN,
  41         MODEST_PROTOCOL_TRANSPORT_SENDMAIL,
  42         MODEST_PROTOCOL_TRANSPORT_SMTP,
  43
  44         MODEST_PROTOCOL_STORE_POP,
  45         MODEST_PROTOCOL_STORE_IMAP,
  46         MODEST_PROTOCOL_STORE_MAILDIR,
  47         MODEST_PROTOCOL_STORE_MBOX
  48 } ModestTransportStoreProtocol;
  49
  50 /** Secure connection methods. */
  51 typedef enum {
  52         MODEST_PROTOCOL_CONNECTION_NORMAL,
  53         MODEST_PROTOCOL_CONNECTION_SSL,
  54         MODEST_PROTOCOL_CONNECTION_TLS,
  55         MODEST_PROTOCOL_CONNECTION_TLS_OP
  56 } ModestConnectionProtocol;
  57
  58 /** Secure authentication methods. */
  59 typedef enum {
  60         MODEST_PROTOCOL_AUTH_NONE,
  61         MODEST_PROTOCOL_AUTH_PASSWORD,
  62         MODEST_PROTOCOL_AUTH_CRAMMD5
  63 } ModestAuthProtocol;
  64
  65
  66
  67
  68 /**
  69  * modest_protocol_info_get_transport_store_protocol_pair_list:
  70  *
  71  * return the list of <protocol,display-name>-tupels of protocols.
  72  * The elements of the returned list are ModestPairs
  73  * This is a convenience function for use with ModestComboBox
  74  *
  75  * Returns: a list of protocols. After use, it should be freed
  76  * with modest_pair_list_free
  77  */
  78 ModestPairList*
  79 modest_protocol_info_get_transport_store_protocol_pair_list ();
  80
  81 /**
  82  * modest_protocol_info_get_auth_protocol_pair_list:
  83  *
  84  * return the list of <protocol,display-name>-tupels of protocols.
  85  * The elements of the returned list are ModestPairs
  86  * This is a convenience function for use with ModestComboBox
  87  *
  88  * Returns: a list of protocols. After use, it should be freed
  89  * with modest_pair_list_free
  90  */
  91 ModestPairList* modest_protocol_info_get_auth_protocol_pair_list (void);
  92
  93
  94 /**
  95  * modest_protocol_info_get_connection_protocol_pair_list:
  96  *
  97  * return the list of <protocol,display-name>-tupels of protocols.
  98  * The elements of the returned list are ModestPairs
  99  * This is a convenience function for use with ModestComboBox
 100  *
 101  * Returns: a list of protocols. After use, it should be freed
 102  * with modest_pair_list_free
 103  */
 104 ModestPairList* modest_protocol_info_get_connection_protocol_pair_list (void);
 105
 106
 107 /**
 108  * modest_protocol_info_get_transport_store_protocol:
 109  * @name: the name of the  #ModestTransportStoreProtocol
 110  *
 111  * return the id of the protocol with the given name
 112  *
 113  * Returns: the id of the protocol or MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN
 114  */
 115 ModestTransportStoreProtocol modest_protocol_info_get_transport_store_protocol (const gchar* name);
 116
 117 /**
 118  * modest_protocol_info_get_auth_protocol:
 119  * @name: The name of the #ModestAuthProtocol
 120  *
 121  * Returns the ID of the protocol with the given name
 122  *
 123  * Returns: The ID of the protocol or MODEST_PROTOCOL_AUTH_NONE
 124  */
 125 ModestAuthProtocol modest_protocol_info_get_auth_protocol (const gchar* name);
 126
 127 /**
 128  * modest_protocol_info_get_connection_protocol:
 129  * @name: The name of the #ModestConnectionProtocol
 130  *
 131  * Returns the ID of the protocol with the given name
 132  *
 133  * Returns: The ID of the protocol or MODEST_CONNECTION_PROTOCOL_NORMAL
 134  */
 135 ModestConnectionProtocol modest_protocol_info_get_connection_protocol (const gchar* name);
 136
 137 /**
 138  * modest_protocol_info_get_transport_store_protocol_name:
 139  * @proto: the protocol you are looking for
 140  *
 141  * return the string id of the proto (such as "imap", or "smtp")
 142  *
 143  * Returns: string id of the proto as a constant string, that should NOT be modified or freed
 144  */
 145 const gchar* modest_protocol_info_get_transport_store_protocol_name (ModestTransportStoreProtocol proto);
 146
 147 /**
 148  * modest_protocol_info_get_auth_protocol_name:
 149  * @proto: the protocol you are looking for
 150  *
 151  * return the string id of the proto (such as "password", or "cram-md5")
 152  *
 153  * Returns: string id of the proto as a constant string, that should NOT be modified or freed
 154  */
 155 const gchar* modest_protocol_info_get_auth_protocol_name (ModestAuthProtocol proto);
 156
 157 /*
 158  * modest_protocol_get_auth_protocol_pair_list:
 159  *
 160  * Get the list of support authentication methods supported by modest including
 161  * the display names of those.
 162  *
 163  * Returns: List of method/display name pairs
 164  */
 165 ModestPairList* modest_protocol_info_get_auth_protocol_pair_list (void);
 166
 167 /**
 168  * modest_protocol_info_get_auth_protocol_name:
 169  * @proto: the protocol you are looking for
 170  *
 171  * return the string id of the proto (such as "ssl", or "tls")
 172  *
 173  * Returns: string id of the proto as a constant string, that should NOT be modified or freed
 174  */
 175 const gchar*
 176 modest_protocol_info_get_connection_protocol_name (ModestAuthProtocol proto);
 177
 178
 179 /**
 180  * modest_protocol_info_protocol_is_local_store:
 181  * @proto: the protocol
 182  *
 183  * is this protocol a store protocol?
 184  *
 185  * Returns: TRUE if it is a local store, FALSE otherwise
 186  *
 187  */
 188 gboolean modest_protocol_info_protocol_is_store (ModestTransportStoreProtocol proto);
 189
 190
 191 /**
 192  * modest_protocol_info_protocol_is_local_store:
 193  * @proto: the protocol
 194  *
 195  * is this protocol a local store protocol?
 196  *
 197  * Returns: TRUE if it is a local store, FALSE otherwise
 198  *
 199  */
 200 gboolean modest_protocol_info_protocol_is_local_store (ModestTransportStoreProtocol proto);
 201
 202
 203 /**
 204  * modest_protocol_info_is_secure:
 205  * @protocol
 206  *
 207  * is the protocol connection secure (e.g encrypted)?
 208  *
 209  * Returns: TRUE if it is secure, FALSE otherwise
 210  *
 211  */
 212 gboolean modest_protocol_info_is_secure(ModestConnectionProtocol protocol);
 213
 214 /**
 215  * modest_protocol_info_auth_is_secure:
 216  * @protocol
 217  *
 218  * is the protocol authentication secure (e.g encrypted)?
 219  *
 220  * Returns: TRUE if it is secure, FALSE otherwise
 221  *
 222  */
 223 gboolean modest_protocol_info_auth_is_secure(ModestAuthProtocol protocol);
 224
 225
 226 G_END_DECLS
 227 #endif /* __MODEST_PROTOCOL_INFO_H__ */
 228