Diffstat (limited to 'libetpan/src/driver/implementation/pop3/pop3driver_types.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libetpan/src/driver/implementation/pop3/pop3driver_types.h | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/libetpan/src/driver/implementation/pop3/pop3driver_types.h b/libetpan/src/driver/implementation/pop3/pop3driver_types.h new file mode 100644 index 0000000..4bb872c --- a/dev/null +++ b/libetpan/src/driver/implementation/pop3/pop3driver_types.h | |||
@@ -0,0 +1,153 @@ | |||
1 | /* | ||
2 | * libEtPan! -- a mail stuff library | ||
3 | * | ||
4 | * Copyright (C) 2001, 2005 - DINH Viet Hoa | ||
5 | * All rights reserved. | ||
6 | * | ||
7 | * Redistribution and use in source and binary forms, with or without | ||
8 | * modification, are permitted provided that the following conditions | ||
9 | * are met: | ||
10 | * 1. Redistributions of source code must retain the above copyright | ||
11 | * notice, this list of conditions and the following disclaimer. | ||
12 | * 2. Redistributions in binary form must reproduce the above copyright | ||
13 | * notice, this list of conditions and the following disclaimer in the | ||
14 | * documentation and/or other materials provided with the distribution. | ||
15 | * 3. Neither the name of the libEtPan! project nor the names of its | ||
16 | * contributors may be used to endorse or promote products derived | ||
17 | * from this software without specific prior written permission. | ||
18 | * | ||
19 | * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND | ||
20 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
21 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
22 | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE | ||
23 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
24 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
25 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
26 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
27 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
28 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
29 | * SUCH DAMAGE. | ||
30 | */ | ||
31 | |||
32 | /* | ||
33 | * $Id$ | ||
34 | */ | ||
35 | |||
36 | #ifndef POP3DRIVER_TYPES_H | ||
37 | |||
38 | #define POP3DRIVER_TYPES_H | ||
39 | |||
40 | #include <libetpan/libetpan-config.h> | ||
41 | |||
42 | #include <libetpan/maildriver_types.h> | ||
43 | #include <libetpan/mailpop3.h> | ||
44 | #include <libetpan/maildriver_types.h> | ||
45 | #include <libetpan/chash.h> | ||
46 | #include <libetpan/mailstorage_types.h> | ||
47 | |||
48 | #ifdef __cplusplus | ||
49 | extern "C" { | ||
50 | #endif | ||
51 | |||
52 | /* POP3 driver for session */ | ||
53 | |||
54 | enum { | ||
55 | POP3DRIVER_SET_AUTH_TYPE = 1, | ||
56 | }; | ||
57 | |||
58 | enum { | ||
59 | POP3DRIVER_AUTH_TYPE_PLAIN = 0, | ||
60 | POP3DRIVER_AUTH_TYPE_APOP, | ||
61 | POP3DRIVER_AUTH_TYPE_TRY_APOP, | ||
62 | }; | ||
63 | |||
64 | struct pop3_session_state_data { | ||
65 | int pop3_auth_type; | ||
66 | mailpop3 * pop3_session; | ||
67 | }; | ||
68 | |||
69 | /* cached POP3 driver for session */ | ||
70 | |||
71 | enum { | ||
72 | /* the mapping of the parameters should be the same as for pop3 */ | ||
73 | POP3DRIVER_CACHED_SET_AUTH_TYPE = 1, | ||
74 | /* cache specific */ | ||
75 | POP3DRIVER_CACHED_SET_CACHE_DIRECTORY, | ||
76 | POP3DRIVER_CACHED_SET_FLAGS_DIRECTORY, | ||
77 | }; | ||
78 | |||
79 | struct pop3_cached_session_state_data { | ||
80 | mailsession * pop3_ancestor; | ||
81 | char pop3_cache_directory[PATH_MAX]; | ||
82 | char pop3_flags_directory[PATH_MAX]; | ||
83 | chash * pop3_flags_hash; | ||
84 | carray * pop3_flags_array; | ||
85 | struct mail_flags_store * pop3_flags_store; | ||
86 | }; | ||
87 | |||
88 | /* pop3 storage */ | ||
89 | |||
90 | /* | ||
91 | pop3_mailstorage is the state data specific to the POP3 storage. | ||
92 | |||
93 | - servername this is the name of the POP3 server | ||
94 | |||
95 | - port is the port to connect to, on the server. | ||
96 | you give 0 to use the default port. | ||
97 | |||
98 | - connection_type is the type of socket layer to use. | ||
99 | The value can be CONNECTION_TYPE_PLAIN, CONNECTION_TYPE_STARTTLS, | ||
100 | CONNECTION_TYPE_TRY_STARTTLS or CONNECTION_TYPE_TLS. | ||
101 | |||
102 | - auth_type is the authenticate mechanism to use. | ||
103 | The value can be POP3_AUTH_TYPE_PLAIN, POP3_AUTH_TYPE_APOP | ||
104 | or POP3_AUTH_TYPE_TRY_APOP. Other values are not yet implemented. | ||
105 | |||
106 | - login is the login of the POP3 account. | ||
107 | |||
108 | - password is the password of the POP3 account. | ||
109 | |||
110 | - cached if this value is != 0, a persistant cache will be | ||
111 | stored on local system. | ||
112 | |||
113 | - cache_directory is the location of the cache. | ||
114 | |||
115 | - flags_directory is the location of the flags. | ||
116 | */ | ||
117 | |||
118 | struct pop3_mailstorage { | ||
119 | char * pop3_servername; | ||
120 | uint16_t pop3_port; | ||
121 | char * pop3_command; | ||
122 | int pop3_connection_type; | ||
123 | |||
124 | int pop3_auth_type; | ||
125 | char * pop3_login; | ||
126 | char * pop3_password; | ||
127 | |||
128 | int pop3_cached; | ||
129 | char * pop3_cache_directory; | ||
130 | char * pop3_flags_directory; | ||
131 | }; | ||
132 | |||
133 | /* this is the type of POP3 authentication */ | ||
134 | |||
135 | enum { | ||
136 | POP3_AUTH_TYPE_PLAIN, /* plain text authentication */ | ||
137 | POP3_AUTH_TYPE_APOP, /* APOP authentication */ | ||
138 | POP3_AUTH_TYPE_TRY_APOP, /* first, try APOP, if it fails, | ||
139 | try plain text */ | ||
140 | POP3_AUTH_TYPE_SASL_ANONYMOUS, /* SASL anonymous */ | ||
141 | POP3_AUTH_TYPE_SASL_CRAM_MD5, /* SASL CRAM MD5 */ | ||
142 | POP3_AUTH_TYPE_SASL_KERBEROS_V4, /* SASL KERBEROS V4 */ | ||
143 | POP3_AUTH_TYPE_SASL_PLAIN, /* SASL plain */ | ||
144 | POP3_AUTH_TYPE_SASL_SCRAM_MD5, /* SASL SCRAM MD5 */ | ||
145 | POP3_AUTH_TYPE_SASL_GSSAPI, /* SASL GSSAPI */ | ||
146 | POP3_AUTH_TYPE_SASL_DIGEST_MD5, /* SASL digest MD5 */ | ||
147 | }; | ||
148 | |||
149 | #ifdef __cplusplus | ||
150 | } | ||
151 | #endif | ||
152 | |||
153 | #endif | ||