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