1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_PROTOCOL_INFO_H__
31 #define __MODEST_PROTOCOL_INFO_H__
33 #include <modest-pair.h>
38 /** Transport and Store protocols. */
40 MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN,
41 MODEST_PROTOCOL_TRANSPORT_SENDMAIL,
42 MODEST_PROTOCOL_TRANSPORT_SMTP,
44 MODEST_PROTOCOL_STORE_POP,
45 MODEST_PROTOCOL_STORE_IMAP,
46 MODEST_PROTOCOL_STORE_MAILDIR,
47 MODEST_PROTOCOL_STORE_MBOX
48 } ModestTransportStoreProtocol;
50 /** Secure connection methods. */
52 MODEST_PROTOCOL_CONNECTION_NORMAL,
53 MODEST_PROTOCOL_CONNECTION_SSL,
54 MODEST_PROTOCOL_CONNECTION_TLS,
55 MODEST_PROTOCOL_CONNECTION_TLS_OP
56 } ModestConnectionProtocol;
58 /** Secure authentication methods. */
60 MODEST_PROTOCOL_AUTH_NONE,
61 MODEST_PROTOCOL_AUTH_PASSWORD,
62 MODEST_PROTOCOL_AUTH_CRAMMD5
69 * modest_protocol_info_get_transport_store_protocol_pair_list:
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
75 * Returns: a list of protocols. After use, it should be freed
76 * with modest_pair_list_free
79 modest_protocol_info_get_transport_store_protocol_pair_list ();
82 * modest_protocol_info_get_auth_protocol_pair_list:
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
88 * Returns: a list of protocols. After use, it should be freed
89 * with modest_pair_list_free
92 modest_protocol_info_get_auth_protocol_pair_list ();
96 * modest_protocol_info_get_connection_protocol_pair_list:
98 * return the list of <protocol,display-name>-tupels of protocols.
99 * The elements of the returned list are ModestPairs
100 * This is a convenience function for use with ModestComboBox
102 * Returns: a list of protocols. After use, it should be freed
103 * with modest_pair_list_free
106 modest_protocol_info_get_connection_protocol_pair_list ();
110 * modest_protocol_info_get_transport_store_protocol:
111 * @name: the name of the #ModestTransportStoreProtocol
113 * return the id of the protocol with the given name
115 * Returns: the id of the protocol or MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN
117 ModestTransportStoreProtocol
118 modest_protocol_info_get_transport_store_protocol (const gchar* name);
121 * modest_protocol_info_get_auth_protocol:
122 * @name: The name of the #ModestAuthProtocol
124 * Returns the ID of the protocol with the given name
126 * Returns: The ID of the protocol or MODEST_PROTOCOL_AUTH_NONE
129 modest_protocol_info_get_auth_protocol (const gchar* name);
132 * modest_protocol_info_get_transport_store_protocol_name:
133 * @proto: the protocol you are looking for
135 * return the string id of the proto (such as "imap", or "smtp")
137 * Returns: string id of the proto as a constant string, that should NOT be modified or freed
140 modest_protocol_info_get_transport_store_protocol_name (ModestTransportStoreProtocol proto);
143 * modest_protocol_info_get_auth_protocol_name:
144 * @proto: the protocol you are looking for
146 * return the string id of the proto (such as "password", or "cram-md5")
148 * Returns: string id of the proto as a constant string, that should NOT be modified or freed
151 modest_protocol_info_get_auth_protocol_name (ModestAuthProtocol proto);
154 * modest_protocol_get_auth_protocol_pair_list:
156 * Get the list of support authentication methods supported by modest including
157 * the display names of those.
159 * Returns: List of method/display name pairs
163 modest_protocol_info_get_auth_protocol_pair_list ();
166 * modest_protocol_info_get_auth_protocol_name:
167 * @proto: the protocol you are looking for
169 * return the string id of the proto (such as "ssl", or "tls")
171 * Returns: string id of the proto as a constant string, that should NOT be modified or freed
174 modest_protocol_info_get_connection_protocol_name (ModestAuthProtocol proto);
178 * modest_protocol_info_protocol_is_local_store:
179 * @proto: the protocol
181 * is this protocol a store protocol?
183 * Returns: TRUE if it is a local store, FALSE otherwise
186 gboolean modest_protocol_info_protocol_is_store (ModestTransportStoreProtocol proto);
190 * modest_protocol_info_protocol_is_local_store:
191 * @proto: the protocol
193 * is this protocol a local store protocol?
195 * Returns: TRUE if it is a local store, FALSE otherwise
198 gboolean modest_protocol_info_protocol_is_local_store (ModestTransportStoreProtocol proto);
202 * modest_protocol_info_is_secure:
205 * is the protocol connection secure (e.g encrypted)?
207 * Returns: TRUE if it is secure, FALSE otherwise
210 gboolean modest_protocol_info_is_secure(ModestConnectionProtocol protocol);
213 * modest_protocol_info_auth_is_secure:
216 * is the protocol authentication secure (e.g encrypted)?
218 * Returns: TRUE if it is secure, FALSE otherwise
221 gboolean modest_protocol_info_auth_is_secure(ModestAuthProtocol protocol);
225 #endif /* __MODEST_PROTOCOL_INFO_H__ */