implementation of mbox folder with unique messages numbers
[claws.git] / src / mailmbox_types.h
1 /*
2  * libEtPan! -- a mail stuff library
3  *
4  * Copyright (C) 2001, 2002 - DINH Viet Hoa
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the libEtPan! project nor the names of its
16  *    contributors may be used to endorse or promote products derived
17  *    from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31
32 /*
33  * $Id$
34  */
35
36 #ifndef MAILMBOX_TYPES_H
37
38 #define MAILMBOX_TYPES_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #include <sys/types.h>
45 #include <limits.h>
46
47 #include "carray.h"
48 #include "chash.h"
49
50 enum {
51   MAILMBOX_NO_ERROR = 0,
52   MAILMBOX_ERROR_PARSE,
53   MAILMBOX_ERROR_INVAL,
54   MAILMBOX_ERROR_FILE_NOT_FOUND,
55   MAILMBOX_ERROR_MEMORY,
56   MAILMBOX_ERROR_TEMPORARY_FILE,
57   MAILMBOX_ERROR_FILE,
58   MAILMBOX_ERROR_MSG_NOT_FOUND,
59   MAILMBOX_ERROR_READONLY,
60 };
61
62
63 struct mailmbox_folder {
64   char filename[PATH_MAX];
65
66   time_t mtime;
67
68   int fd;
69   int read_only;
70   int no_uid;
71
72   int changed;
73   uint32_t deleted_count;
74   
75   char * mapping;
76   size_t mapping_size;
77
78   uint32_t written_uid;
79   uint32_t max_uid;
80
81   chash * hash;
82   carray * tab;
83 };
84
85 struct mailmbox_folder * mailmbox_folder_new(char * filename);
86 void mailmbox_folder_free(struct mailmbox_folder * folder);
87
88
89 struct mailmbox_msg_info {
90   uint32_t index;
91   uint32_t uid;
92   int written_uid;
93   int deleted;
94
95   size_t start;
96   size_t start_len;
97
98   size_t headers;
99   size_t headers_len;
100
101   size_t body;
102   size_t body_len;
103
104   size_t size;
105
106   size_t padding;
107 };
108
109
110 int mailmbox_msg_info_update(struct mailmbox_folder * folder,
111                              size_t start, size_t start_len,
112                              size_t headers, size_t headers_len,
113                              size_t body, size_t body_len,
114                              size_t size, size_t padding,
115                              uint32_t uid);
116
117 struct mailmbox_msg_info *
118 mailmbox_msg_info_new(size_t start, size_t start_len,
119                       size_t headers, size_t headers_len,
120                       size_t body, size_t body_len,
121                       size_t size, size_t padding,
122                       uint32_t uid);
123
124 void mailmbox_msg_info_free(struct mailmbox_msg_info * info);
125
126 #if 0
127 struct mailmbox_msg_env {
128   uint32_t index;
129   struct mailimf_fields * fields;
130 };
131
132 struct mailmbox_msg_env *
133 mailmbox_msg_env_new(uint32_t index, struct mailimf_fields * fields);
134
135 void mailmbox_msg_env_free(struct mailmbox_msg_env * msg_env);
136 #endif
137
138 struct mailmbox_append_info {
139   char * message;
140   size_t size;
141 };
142
143 struct mailmbox_append_info *
144 mailmbox_append_info_new(char * message, size_t size);
145
146 void mailmbox_append_info_free(struct mailmbox_append_info * info);
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif