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 #define MODEST_PROTO_SENDMAIL "sendmail"
  39 #define MODEST_PROTO_SMTP     "smtp"
  40 #define MODEST_PROTO_POP      "pop"
  41 #define MODEST_PROTO_IMAP     "imap"
  42
  43 enum {
  44         MODEST_PROTO_TYPE_ANY       = 0,
  45         MODEST_PROTO_TYPE_TRANSPORT = 1,
  46         MODEST_PROTO_TYPE_STORE     = 2,
  47 };
  48 typedef gint ModestProtoType;
  49
  50 /**
  51  * modest_proto_is_valid:
  52  * @proto: a string describing the protocol
  53  *
  54  * checks if proto is a valid protocol
  55  *
  56  * Returns: TRUE if proto is valid, FALSE otherwise
  57  */
  58 gboolean         modest_proto_is_valid     (const gchar *proto);
  59
  60 /**
  61  * modest_proto_type:
  62  * @proto: a string describing the protocol
  63  *
  64  * converts the string proto into a ModestProtoType
  65  *
  66  * Returns: a valid ModestProtoType corresponding to proto
  67  */
  68 ModestProtoType  modest_proto_type         (const gchar *proto);
  69
  70 #endif /*__MODEST_SERVER_PROTO_H__*/
  71