sync with 0.8.11cvs15
[claws.git] / src / pop.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2003 Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __POP_H__
21 #define __POP_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <time.h>
29
30 #include "session.h"
31 #include "prefs_account.h"
32
33 typedef struct _Pop3MsgInfo     Pop3MsgInfo;
34 typedef struct _Pop3Session     Pop3Session;
35
36 #define POP3_SESSION(obj)       ((Pop3Session *)obj)
37
38 typedef enum {
39         POP3_READY,
40         POP3_GREETING,
41 #if USE_OPENSSL
42         POP3_STLS,
43 #endif
44         POP3_GETAUTH_USER,
45         POP3_GETAUTH_PASS,
46         POP3_GETAUTH_APOP,
47         POP3_GETRANGE_STAT,
48         POP3_GETRANGE_LAST,
49         POP3_GETRANGE_UIDL,
50         POP3_GETRANGE_UIDL_RECV,
51         POP3_GETSIZE_LIST,
52         POP3_GETSIZE_LIST_RECV,
53         POP3_RETR,
54         POP3_RETR_RECV,
55         POP3_DELETE,
56         POP3_LOGOUT,
57         POP3_ERROR,
58
59         N_POP3_STATE
60 } Pop3State;
61
62 typedef enum {
63         PS_SUCCESS      = 0,    /* command successful */
64         PS_NOMAIL       = 1,    /* no mail available */
65         PS_SOCKET       = 2,    /* socket I/O woes */
66         PS_AUTHFAIL     = 3,    /* user authorization failed */
67         PS_PROTOCOL     = 4,    /* protocol violation */
68         PS_SYNTAX       = 5,    /* command-line syntax error */
69         PS_IOERR        = 6,    /* file I/O error */
70         PS_ERROR        = 7,    /* protocol error */
71         PS_EXCLUDE      = 8,    /* client-side exclusion error */
72         PS_LOCKBUSY     = 9,    /* server responded lock busy */
73         PS_SMTP         = 10,   /* SMTP error */
74         PS_DNS          = 11,   /* fatal DNS error */
75         PS_BSMTP        = 12,   /* output batch could not be opened */
76         PS_MAXFETCH     = 13,   /* poll ended by fetch limit */
77
78         /* leave space for more codes */
79
80         PS_UNDEFINED    = 23,   /* something I hadn't thought of */
81         PS_TRANSIENT    = 24,   /* transient failure (internal use) */
82         PS_REFUSED      = 25,   /* mail refused (internal use) */
83         PS_RETAINED     = 26,   /* message retained (internal use) */
84         PS_TRUNCATED    = 27,   /* headers incomplete (internal use) */
85
86         PS_CONTINUE     = 128   /* more responses may follow */
87 } Pop3ErrorValue;
88
89 typedef enum {
90         RECV_TIME_NONE     = 0,
91         RECV_TIME_RECEIVED = 1,
92         RECV_TIME_KEEP     = 2
93 } RecvTime;
94
95 struct _Pop3MsgInfo
96 {
97         gint size;
98         gchar *uidl;
99         time_t recv_time;
100         guint received : 1;
101         guint deleted  : 1;
102 };
103
104 struct _Pop3Session
105 {
106         Session session;
107
108         Pop3State state;
109         gchar *prev_folder;
110
111         PrefsAccount *ac_prefs;
112
113         gchar *greeting;
114         gchar *user;
115         gchar *pass;
116         gint count;
117         gint total_bytes;
118         gint cur_msg;
119         gint cur_total_num;
120         gint cur_total_bytes;
121         gint cur_total_recv_bytes;
122
123         Pop3MsgInfo *msg;
124
125         GHashTable *uidl_table;
126
127         gboolean new_msg_exist;
128         gboolean uidl_is_valid;
129
130         time_t current_time;
131
132         Pop3ErrorValue error_val;
133
134         gpointer data;
135 };
136
137 #define POPBUFSIZE      512
138 #define IDLEN           128
139
140
141 Session *pop3_session_new       (PrefsAccount   *account);
142 GHashTable *pop3_get_uidl_table (PrefsAccount   *account);
143 gint pop3_write_uidl_list       (Pop3Session    *session);
144
145 #endif /* __POP_H__ */