8b4d9b1f596855566ed0d835c60f84d47f96b909
[claws.git] / src / pop.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2004 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 #define MAIL_RECEIVE_HOOKLIST   "mail_receive_hooklist"
39 struct _MailReceiveData
40 {
41         Pop3Session *session;
42         char *data;
43 };
44 typedef struct _MailReceiveData MailReceiveData;
45
46 typedef enum {
47         POP3_READY,
48         POP3_GREETING,
49 #if USE_OPENSSL
50         POP3_STLS,
51 #endif
52         POP3_GETAUTH_USER,
53         POP3_GETAUTH_PASS,
54         POP3_GETAUTH_APOP,
55         POP3_GETRANGE_STAT,
56         POP3_GETRANGE_LAST,
57         POP3_GETRANGE_UIDL,
58         POP3_GETRANGE_UIDL_RECV,
59         POP3_GETSIZE_LIST,
60         POP3_GETSIZE_LIST_RECV,
61         POP3_RETR,
62         POP3_RETR_RECV,
63         POP3_TOP,
64         POP3_TOP_RECV,
65         POP3_DELETE,
66         POP3_LOGOUT,
67         POP3_ERROR,
68
69         N_POP3_STATE
70 } Pop3State;
71
72 typedef enum {
73         PS_SUCCESS      = 0,    /* command successful */
74         PS_NOMAIL       = 1,    /* no mail available */
75         PS_SOCKET       = 2,    /* socket I/O woes */
76         PS_AUTHFAIL     = 3,    /* user authorization failed */
77         PS_PROTOCOL     = 4,    /* protocol violation */
78         PS_SYNTAX       = 5,    /* command-line syntax error */
79         PS_IOERR        = 6,    /* file I/O error */
80         PS_ERROR        = 7,    /* protocol error */
81         PS_EXCLUDE      = 8,    /* client-side exclusion error */
82         PS_LOCKBUSY     = 9,    /* server responded lock busy */
83         PS_SMTP         = 10,   /* SMTP error */
84         PS_DNS          = 11,   /* fatal DNS error */
85         PS_BSMTP        = 12,   /* output batch could not be opened */
86         PS_MAXFETCH     = 13,   /* poll ended by fetch limit */
87
88         PS_NOTSUPPORTED = 14,   /* command not supported */
89
90         /* leave space for more codes */
91
92         PS_CONTINUE     = 128   /* more responses may follow */
93 } Pop3ErrorValue;
94
95 typedef enum {
96         RECV_TIME_NONE     = 0,
97         RECV_TIME_RECEIVED = 1,
98         RECV_TIME_KEEP     = 2
99 } RecvTime;
100
101 struct _Pop3MsgInfo
102 {
103         gint size;
104         gchar *uidl;
105         time_t recv_time;
106         guint received     : 1;
107         guint deleted      : 1;
108         guint partial_recv : 2;
109 };
110
111 struct _Pop3Session
112 {
113         Session session;
114
115         Pop3State state;
116         gchar *prev_folder;
117
118         PrefsAccount *ac_prefs;
119         gboolean pop_before_smtp;
120
121         gchar *greeting;
122         gchar *user;
123         gchar *pass;
124         gint count;
125         gint total_bytes;
126         gint cur_msg;
127         gint cur_total_num;
128         gint cur_total_bytes;
129         gint cur_total_recv_bytes;
130
131         Pop3MsgInfo *msg;
132
133         GHashTable *uidl_table;
134         GHashTable *partial_recv_table;
135         
136         gboolean new_msg_exist;
137         gboolean uidl_is_valid;
138
139         time_t current_time;
140
141         Pop3ErrorValue error_val;
142         gchar *error_msg;
143
144         gpointer data;
145
146         /* virtual method to drop message */
147         gint (*drop_message)    (Pop3Session    *session,
148                                  const gchar    *file);
149 };
150
151 #define POPBUFSIZE      512
152 /* #define IDLEN        128 */
153 #define IDLEN           POPBUFSIZE
154
155 Session *pop3_session_new       (PrefsAccount   *account);
156 void pop3_get_uidl_table        (PrefsAccount   *account, Pop3Session *session);
157 gint pop3_write_uidl_list       (Pop3Session    *session);
158
159 #endif /* __POP_H__ */