aboutsummaryrefslogtreecommitdiffstats
path: root/camel/providers/imap/camel-imap-store.h
blob: 36e6e3c032a718df39a299679bc4b5a1e542179f (plain) (blame)
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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-imap-store.h : class for an imap store */

/* 
 * Authors: Jeffrey Stedfast <fejj@ximian.com>
 *
 * Copyright (C) 2000 Ximian, Inc.
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of version 2 of the GNU General Public 
 * License as published by the Free Software Foundation.
 *
 * 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-1307
 * USA
 */


#ifndef CAMEL_IMAP_STORE_H
#define CAMEL_IMAP_STORE_H 1


#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus */

#include "camel-imap-types.h"
#include <camel/camel-disco-store.h>

#ifdef ENABLE_THREADS
#include <e-util/e-msgport.h>

typedef struct _CamelImapMsg CamelImapMsg;

struct _CamelImapMsg {
    EMsg msg;

    void (*receive)(CamelImapStore *store, struct _CamelImapMsg *m);
    void (*free)(CamelImapStore *store, struct _CamelImapMsg *m);
};

CamelImapMsg *camel_imap_msg_new(void (*receive)(CamelImapStore *store, struct _CamelImapMsg *m),
                 void (*free)(CamelImapStore *store, struct _CamelImapMsg *m),
                 size_t size);
void camel_imap_msg_queue(CamelImapStore *store, CamelImapMsg *msg);

#endif

#define CAMEL_IMAP_STORE_TYPE     (camel_imap_store_get_type ())
#define CAMEL_IMAP_STORE(obj)     (CAMEL_CHECK_CAST((obj), CAMEL_IMAP_STORE_TYPE, CamelImapStore))
#define CAMEL_IMAP_STORE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_IMAP_STORE_TYPE, CamelImapStoreClass))
#define CAMEL_IS_IMAP_STORE(o)    (CAMEL_CHECK_TYPE((o), CAMEL_IMAP_STORE_TYPE))

enum {
    CAMEL_IMAP_STORE_ARG_FIRST  = CAMEL_DISCO_STORE_ARG_FIRST + 100,
    CAMEL_IMAP_STORE_ARG_NAMESPACE,
    CAMEL_IMAP_STORE_ARG_OVERRIDE_NAMESPACE,
    CAMEL_IMAP_STORE_ARG_CHECK_ALL,
    CAMEL_IMAP_STORE_ARG_FILTER_INBOX
};

#define CAMEL_IMAP_STORE_NAMESPACE           (CAMEL_IMAP_STORE_ARG_NAMESPACE | CAMEL_ARG_STR)
#define CAMEL_IMAP_STORE_OVERRIDE_NAMESPACE  (CAMEL_IMAP_STORE_ARG_OVERRIDE_NAMESPACE | CAMEL_ARG_INT)
#define CAMEL_IMAP_STORE_CHECK_ALL           (CAMEL_IMAP_STORE_ARG_CHECK_ALL | CAMEL_ARG_INT)
#define CAMEL_IMAP_STORE_FILTER_INBOX        (CAMEL_IMAP_STORE_ARG_FILTER_INBOX | CAMEL_ARG_INT)


typedef enum {
    IMAP_LEVEL_UNKNOWN,
    IMAP_LEVEL_IMAP4,
    IMAP_LEVEL_IMAP4REV1
} CamelImapServerLevel;

#define IMAP_CAPABILITY_IMAP4           (1 << 0)
#define IMAP_CAPABILITY_IMAP4REV1       (1 << 1)
#define IMAP_CAPABILITY_STATUS          (1 << 2)
#define IMAP_CAPABILITY_NAMESPACE       (1 << 3)
#define IMAP_CAPABILITY_UIDPLUS         (1 << 4)
#define IMAP_CAPABILITY_LITERALPLUS     (1 << 5)
#define IMAP_CAPABILITY_STARTTLS                (1 << 6)
#define IMAP_CAPABILITY_useful_lsub     (1 << 7)
#define IMAP_CAPABILITY_utf8_search     (1 << 8)

#define IMAP_PARAM_OVERRIDE_NAMESPACE       (1 << 0)
#define IMAP_PARAM_CHECK_ALL            (1 << 1)
#define IMAP_PARAM_FILTER_INBOX         (1 << 2)

struct _CamelImapStore {
    CamelDiscoStore parent_object;  
    struct _CamelImapStorePrivate *priv;
    
    CamelStream *istream;
    CamelStream *ostream;
    
    /* Information about the command channel / connection status */
    gboolean connected;
    char tag_prefix;
    guint32 command;
    CamelFolder *current_folder;
    
    /* Information about the server */
    CamelImapServerLevel server_level;
    guint32 capabilities, parameters;
    char *namespace, dir_sep, *base_url, *storage_path;
    GHashTable *authtypes, *subscribed_folders;
    
    gboolean renaming;
    
#ifdef ENABLE_THREADS
    EThread *async_thread;
#endif
};


typedef struct {
    CamelDiscoStoreClass parent_class;

} CamelImapStoreClass;


/* Standard Camel function */
CamelType camel_imap_store_get_type (void);


gboolean camel_imap_store_connected (CamelImapStore *store, CamelException *ex);

int camel_imap_store_recv_line (CamelImapStore *store, char **dest, CamelException *ex);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CAMEL_IMAP_STORE_H */