git.maemo.org Git - modest/blob - src/modest-proto.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
  31 /* modest-proto.h */
  32
  33 #ifndef __MODEST_PROTO_H__
  34 #define __MODEST_PROTO_H__
  35
  36 #include <glib.h>
  37
  38
  39 #define MODEST_PROTO_SENDMAIL "sendmail"
  40 #define MODEST_PROTO_SMTP     "smtp"
  41
  42 #define MODEST_PROTO_NONE     "none"
  43 #define MODEST_PROTO_POP      "pop"
  44 #define MODEST_PROTO_IMAP     "imap"
  45 #define MODEST_PROTO_MAILDIR  "maildir"
  46 #define MODEST_PROTO_MBOX     "mbox"
  47
  48
  49 #define MODEST_SECURITY_PROTO_NONE "none"
  50 #define MODEST_SECURITY_PROTO_SSL  "ssl"
  51 #define MODEST_SECURITY_PROTO_TLS  "tls"
  52
  53
  54 #define MODEST_AUTH_PROTO_PASSWORD "password"
  55
  56
  57
  58 enum {
  59         MODEST_PROTO_TYPE_ANY       = 0,
  60         MODEST_PROTO_TYPE_TRANSPORT = 1,
  61         MODEST_PROTO_TYPE_STORE     = 2,
  62 };
  63 typedef gint ModestProtoType;
  64
  65 /**
  66  * modest_proto_is_valid:
  67  * @proto: a string describing the protocol
  68  * @store_proto: is this a store proto?
  69  *
  70  * checks if proto is a valid protocol of the given type
  71  *
  72  * Returns: TRUE if proto is valid, FALSE otherwise
  73  */
  74 gboolean         modest_proto_is_valid     (const gchar *proto, gboolean store_proto);
  75
  76 /**
  77  * modest_proto_type:
  78  * @proto: a string describing the protocol
  79  *
  80  * converts the string proto into a ModestProtoType
  81  *
  82  * Returns: a valid ModestProtoType corresponding to proto
  83  */
  84 ModestProtoType  modest_proto_type         (const gchar *proto);
  85
  86 /**
  87  * modest_proto_store_protos:
  88  *
  89  * return a list of all available store protos
  90  *
  91  * Returns: a newly allocated, NULL-terminated list of of store protocols
  92  */
  93 const gchar**     modest_proto_store_protos       (void);
  94
  95
  96 /**
  97  * modest_proto_transport_protos:
  98  *
  99  * return a list of all available store protos
 100  *
 101  * Returns: a newly allocated, NULL-terminated list of of store protocols
 102  */
 103 const gchar**     modest_proto_transport_protos   (void);
 104
 105
 106 /**
 107  * modest_proto_security_protos:
 108  *
 109  * return a list of all available security (connection) protocols
 110  *
 111  * Returns: a newly allocated, NULL-terminated list of of store protocols
 112  */
 113 const gchar**     modest_proto_security_protos   (void);
 114
 115
 116 /**
 117  * modest_proto_auth_protos:
 118  *
 119  * return a list of all available authentication protocols
 120  *
 121  * Returns: a newly allocated, NULL-terminated list of of store protocols
 122  */
 123 const gchar**     modest_proto_auth_protos   (void);
 124
 125
 126
 127
 128 #endif /*__MODEST_SERVER_PROTO_H__*/
 129