remove selective download
[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         RECV_TIME_NONE     = 0,
64         RECV_TIME_RECEIVED = 1,
65         RECV_TIME_KEEP     = 2
66 } RecvTime;
67
68 struct _Pop3MsgInfo
69 {
70         gint size;
71         gchar *uidl;
72         time_t recv_time;
73         guint received : 1;
74         guint deleted  : 1;
75 };
76
77 struct _Pop3Session
78 {
79         Session session;
80
81         Pop3State state;
82         gchar *prev_folder;
83
84         PrefsAccount *ac_prefs;
85
86         gchar *greeting;
87         gchar *user;
88         gchar *pass;
89         gint count;
90         gint total_bytes;
91         gint cur_msg;
92         gint cur_total_num;
93         gint cur_total_bytes;
94         gint cur_total_recv_bytes;
95
96         Pop3MsgInfo *msg;
97
98         GHashTable *uidl_table;
99
100         gboolean new_msg_exist;
101         gboolean uidl_is_valid;
102
103         time_t current_time;
104
105         gint error_val;
106
107         gpointer data;
108 };
109
110 #define POPBUFSIZE      512
111 #define IDLEN           128
112
113 /* exit code values */
114 #define         PS_SUCCESS      0       /* successful receipt of messages */
115 #define         PS_NOMAIL       1       /* no mail available */
116 #define         PS_SOCKET       2       /* socket I/O woes */
117 #define         PS_AUTHFAIL     3       /* user authorization failed */
118 #define         PS_PROTOCOL     4       /* protocol violation */
119 #define         PS_SYNTAX       5       /* command-line syntax error */
120 #define         PS_IOERR        6       /* bad permissions on rc file */
121 #define         PS_ERROR        7       /* protocol error */
122 #define         PS_EXCLUDE      8       /* client-side exclusion error */
123 #define         PS_LOCKBUSY     9       /* server responded lock busy */
124 #define         PS_SMTP         10      /* SMTP error */
125 #define         PS_DNS          11      /* fatal DNS error */
126 #define         PS_BSMTP        12      /* output batch could not be opened */
127 #define         PS_MAXFETCH     13      /* poll ended by fetch limit */
128 /* leave space for more codes */
129 #define         PS_UNDEFINED    23      /* something I hadn't thought of */
130 #define         PS_TRANSIENT    24      /* transient failure (internal use) */
131 #define         PS_REFUSED      25      /* mail refused (internal use) */
132 #define         PS_RETAINED     26      /* message retained (internal use) */
133 #define         PS_TRUNCATED    27      /* headers incomplete (internal use) */
134
135 #define         PS_CONTINUE     128
136
137 Session *pop3_session_new       (PrefsAccount   *account);
138 GHashTable *pop3_get_uidl_table (PrefsAccount   *account);
139 gint pop3_write_uidl_list       (Pop3Session    *session);
140
141 #endif /* __POP_H__ */