Diffstat (limited to 'kmicromail/libetpan/include/libetpan/pop3storage.h') (more/less context) (show whitespace changes)
-rw-r--r-- | kmicromail/libetpan/include/libetpan/pop3storage.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/kmicromail/libetpan/include/libetpan/pop3storage.h b/kmicromail/libetpan/include/libetpan/pop3storage.h new file mode 100644 index 0000000..c2118b6 --- a/dev/null +++ b/kmicromail/libetpan/include/libetpan/pop3storage.h | |||
@@ -0,0 +1,95 @@ | |||
1 | /* | ||
2 | * libEtPan! -- a mail stuff library | ||
3 | * | ||
4 | * Copyright (C) 2001, 2002 - 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 REGENTS 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 REGENTS 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 POP3STORAGE_H | ||
37 | |||
38 | #define POP3STORAGE_H | ||
39 | |||
40 | #ifdef __cplusplus | ||
41 | extern "C" { | ||
42 | #endif | ||
43 | |||
44 | #include <libetpan/pop3driver_types.h> | ||
45 | #include <libetpan/pop3driver.h> | ||
46 | #include <libetpan/pop3driver_cached.h> | ||
47 | |||
48 | /* | ||
49 | pop3_mailstorage_init is the constructor for a POP3 storage | ||
50 | |||
51 | @param storage this is the storage to initialize. | ||
52 | |||
53 | @param servername this is the name of the POP3 server | ||
54 | |||
55 | @param port is the port to connect to, on the server. | ||
56 | you give 0 to use the default port. | ||
57 | |||
58 | @param command the command used to connect to the server instead of | ||
59 | allowing normal TCP connections to be used. | ||
60 | |||
61 | @param connection_type is the type of socket layer to use. | ||
62 | The value can be CONNECTION_TYPE_PLAIN, CONNECTION_TYPE_STARTTLS, | ||
63 | CONNECTION_TYPE_TRY_STARTTLS, CONNECTION_TYPE_TLS, | ||
64 | CONNECTION_TYPE_COMMAND, CONNECTION_TYPE_COMMAND_STARTTLS, | ||
65 | CONNECTION_TYPE_COMMAND_TRY_STARTTLS, CONNECTION_TYPE_COMMAND_TLS,. | ||
66 | |||
67 | @param auth_type is the authenticate mechanism to use. | ||
68 | The value can be POP3_AUTH_TYPE_PLAIN, POP3_AUTH_TYPE_APOP | ||
69 | or POP3_AUTH_TYPE_TRY_APOP. Other values are not yet implemented. | ||
70 | |||
71 | @param login is the login of the POP3 account. | ||
72 | |||
73 | @param password is the password of the POP3 account. | ||
74 | |||
75 | @param cached if this value is != 0, a persistant cache will be | ||
76 | stored on local system. | ||
77 | |||
78 | @param cache_directory is the location of the cache | ||
79 | |||
80 | @param flags_directory is the location of the flags | ||
81 | */ | ||
82 | |||
83 | int pop3_mailstorage_init(struct mailstorage * storage, | ||
84 | char * pop3_servername, uint16_t pop3_port, | ||
85 | char * pop3_command, | ||
86 | int pop3_connection_type, int pop3_auth_type, | ||
87 | char * pop3_login, char * pop3_password, | ||
88 | int pop3_cached, char * pop3_cache_directory, | ||
89 | char * pop3_flags_directory); | ||
90 | |||
91 | #ifdef __cplusplus | ||
92 | } | ||
93 | #endif | ||
94 | |||
95 | #endif | ||