1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*
* Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
* Copyright (C) 1999-2001 Brendan Cully <brendan@kublai.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*/
#ifndef _IMAP_PRIVATE_H
#define _IMAP_PRIVATE_H 1
#include "imap.h"
#include "mutt_socket.h"
/* -- symbols -- */
#define IMAP_PORT 143
#define IMAP_SSL_PORT 993
/* logging levels */
#define IMAP_LOG_CMD 2
#define IMAP_LOG_LTRL 4
#define IMAP_LOG_PASS 5
/* IMAP command responses. Used in IMAP_COMMAND.state too */
/* <tag> OK ... */
#define IMAP_CMD_OK (0)
/* <tag> BAD ... */
#define IMAP_CMD_BAD (-1)
/* <tag> NO ... */
#define IMAP_CMD_NO (-2)
/* * ... */
#define IMAP_CMD_CONTINUE (1)
/* + */
#define IMAP_CMD_RESPOND (2)
/* number of entries in the hash table */
#define IMAP_CACHE_LEN 10
#define SEQLEN 5
#define IMAP_REOPEN_ALLOW (1<<0)
#define IMAP_EXPUNGE_EXPECTED (1<<1)
#define IMAP_EXPUNGE_PENDING (1<<2)
#define IMAP_NEWMAIL_PENDING (1<<3)
#define IMAP_FLAGS_PENDING (1<<4)
/* imap_exec flags (see imap_exec) */
#define IMAP_CMD_FAIL_OK (1<<0)
#define IMAP_CMD_PASS (1<<1)
enum
{
IMAP_FATAL = 1,
IMAP_BYE,
IMAP_REOPENED
};
enum
{
/* States */
IMAP_DISCONNECTED = 0,
IMAP_CONNECTED,
IMAP_AUTHENTICATED,
IMAP_SELECTED
};
enum
{
/* Namespace types */
IMAP_NS_PERSONAL = 0,
IMAP_NS_OTHER,
IMAP_NS_SHARED
};
/* ACL Rights */
enum
{
IMAP_ACL_LOOKUP = 0,
IMAP_ACL_READ,
IMAP_ACL_SEEN,
IMAP_ACL_WRITE,
IMAP_ACL_INSERT,
IMAP_ACL_POST,
IMAP_ACL_CREATE,
IMAP_ACL_DELETE,
IMAP_ACL_ADMIN,
RIGHTSMAX
};
/* Capabilities we are interested in */
enum
{
IMAP4 = 0,
IMAP4REV1,
STATUS,
ACL, /* RFC 2086: IMAP4 ACL extension */
NAMESPACE, /* RFC 2342: IMAP4 Namespace */
ACRAM_MD5, /* RFC 2195: CRAM-MD5 authentication */
AGSSAPI, /* RFC 1731: GSSAPI authentication */
AUTH_ANON, /* AUTH=ANONYMOUS */
STARTTLS, /* RFC 2595: STARTTLS */
LOGINDISABLED, /* LOGINDISABLED */
CAPMAX
};
/* imap_conn_find flags */
#define M_IMAP_CONN_NONEW (1<<0)
#define M_IMAP_CONN_NOSELECT (1<<1)
/* -- data structures -- */
typedef struct
{
unsigned int uid;
char* path;
} IMAP_CACHE;
typedef struct
{
int type;
int listable;
char *prefix;
char delim;
int home_namespace;
/* We get these when we check if namespace exists - cache them */
int noselect;
int noinferiors;
} IMAP_NAMESPACE_INFO;
/* IMAP command structure */
typedef struct
{
char seq[SEQLEN+1];
char* buf;
unsigned int blen;
int state;
} IMAP_COMMAND;
typedef struct
{
/* This data is specific to a CONNECTION to an IMAP server */
CONNECTION *conn;
unsigned char state;
unsigned char status;
/* let me explain capstr: SASL needs the capability string (not bits).
* we have 3 options:
* 1. rerun CAPABILITY inside SASL function.
* 2. build appropriate CAPABILITY string by reverse-engineering from bits.
* 3. keep a copy until after authentication.
* I've chosen (3) for now. (2) might not be too bad, but it involves
* tracking all possible capabilities. bah. (1) I don't like because
* it's just no fun to get the same information twice */
char* capstr;
unsigned char capabilities[(CAPMAX + 7)/8];
unsigned int seqno;
/* who knows, one day we may run multiple commands in parallel */
IMAP_COMMAND cmd;
/* The following data is all specific to the currently SELECTED mbox */
char delim;
CONTEXT *ctx;
char *mailbox;
unsigned short check_status;
unsigned char reopen;
unsigned char rights[(RIGHTSMAX + 7)/8];
unsigned int newMailCount;
IMAP_CACHE cache[IMAP_CACHE_LEN];
int noclose : 1;
/* all folder flags - system flags AND keywords */
LIST *flags;
} IMAP_DATA;
/* I wish that were called IMAP_CONTEXT :( */
/* -- macros -- */
#define CTX_DATA ((IMAP_DATA *) ctx->data)
/* -- private IMAP functions -- */
/* imap.c */
int imap_create_mailbox (IMAP_DATA* idata, char* mailbox);
int imap_make_msg_set (IMAP_DATA* idata, BUFFER* buf, int flag, int changed);
int imap_open_connection (IMAP_DATA* idata);
IMAP_DATA* imap_conn_find (const ACCOUNT* account, int flags);
int imap_parse_list_response(IMAP_DATA* idata, char** name, int* noselect,
int* noinferiors, char* delim);
int imap_read_literal (FILE* fp, IMAP_DATA* idata, long bytes);
void imap_expunge_mailbox (IMAP_DATA* idata);
void imap_logout (IMAP_DATA* idata);
/* auth.c */
int imap_authenticate (IMAP_DATA* idata);
/* command.c */
int imap_cmd_start (IMAP_DATA* idata, const char* cmd);
int imap_cmd_step (IMAP_DATA* idata);
void imap_cmd_finish (IMAP_DATA* idata);
int imap_code (const char* s);
int imap_exec (IMAP_DATA* idata, const char* cmd, int flags);
/* message.c */
void imap_add_keywords (char* s, HEADER* keywords, LIST* mailbox_flags, size_t slen);
void imap_free_header_data (void** data);
int imap_read_headers (IMAP_DATA* idata, int msgbegin, int msgend);
char* imap_set_flags (IMAP_DATA* idata, HEADER* h, char* s);
/* util.c */
int imap_continue (const char* msg, const char* resp);
void imap_error (const char* where, const char* msg);
IMAP_DATA* imap_new_idata (void);
void imap_free_idata (IMAP_DATA** idata);
char* imap_fix_path (IMAP_DATA* idata, char* mailbox, char* path,
size_t plen);
int imap_get_literal_count (const char* buf, long* bytes);
char* imap_get_qualifier (char* buf);
char* imap_next_word (char* s);
time_t imap_parse_date (char* s);
void imap_qualify_path (char *dest, size_t len, IMAP_MBOX *mx, char* path);
void imap_quote_string (char* dest, size_t slen, const char* src);
void imap_unquote_string (char* s);
void imap_munge_mbox_name (char *dest, size_t dlen, const char *src);
void imap_unmunge_mbox_name (char *s);
int imap_wordcasecmp(const char *a, const char *b);
/* utf7.c */
void imap_utf7_encode (char **s);
void imap_utf7_decode (char **s);
#endif
|
