* added GTKdoc compliant documentation
[modest] / src / modest-proto.h
1 /* modest-proto.h */
2
3 #ifndef __MODEST_PROTO_H__
4 #define __MODEST_PROTO_H__
5
6 #include <glib.h>
7
8 #define MODEST_PROTO_SENDMAIL "sendmail"
9 #define MODEST_PROTO_SMTP     "smtp"
10 #define MODEST_PROTO_POP      "pop"
11 #define MODEST_PROTO_IMAP     "imap"
12
13 enum {
14         MODEST_PROTO_TYPE_ANY       = 0,        
15         MODEST_PROTO_TYPE_TRANSPORT = 1,
16         MODEST_PROTO_TYPE_STORE     = 2,
17 };
18 typedef gint ModestProtoType;
19
20 /**
21  * modest_proto_is_valid:
22  * @proto: a string describing the protocol
23  *
24  * checks if proto is a valid protocol
25  *
26  * Returns: TRUE if proto is valid, FALSE otherwise
27  */
28 gboolean         modest_proto_is_valid     (const gchar *proto);
29
30 /**
31  * modest_proto_type:
32  * @proto: a string describing the protocol
33  *
34  * converts the string proto into a ModestProtoType
35  *
36  * Returns: a valid ModestProtoType corresponding to proto
37  */
38 ModestProtoType  modest_proto_type         (const gchar *proto);
39
40 #endif /*__MODEST_SERVER_PROTO_H__*/
41