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
|
/***************************************************************************
mailfolder.h - the mail folder interface
-------------------
begin : Mon Mar 5 16:16:00 EET 2001
copyright : (C) 2001 by theKompany (www.thekompany.com>
author : Eugen Constantinescu
email : eug@thekompany.com
***************************************************************************/
#ifndef MAILFOLDER_H
#define MAILFOLDER_H
#include <qstring.h>
#include <qcstring.h>
#include <qdir.h>
#include <mailclasses.h>
#include <messageclass.h>
#include <qstringlist.h>
#include <qdict.h>
#include <qlist.h>
#include <qmap.h>
#include <qdatetime.h>
class MailFolder
{
/** The index class used for building the folder index.*/
friend class IndexClass;
public:
/** Mail folder place.*/
enum MESSAGES_PLACE {LOCAL=0, REMOTE};
/** Mail folder protocol types.*/
enum PROTOCOL {MBOX=0, POP3, IMAP4};
/** Local mail folder types.*/
enum TYPES {Normal=100, Deleted, Drafts, Inbox, Outbox, Sent, Templates};
/** Access rights.*/
enum ACCESS_RIGHTS {DENIED=0, WRITE_ONLY=1, READ_ONLY=2, ALL=4};
/** The protocol flags.*/
enum IMAP4_FLAGS {NO_FLAGS=0, Seen=1, Answered=2, Flagged=4, Draft=8, Recent=16, Delete=32, Other=64};
MailFolder(const QString &_storageDevice);
virtual ~MailFolder();
// Index management
/** Incremental index save.*/
void saveIndex(IndexClass *);
/** Save index file.*/
void saveIndex();
/** A fast and easy access way for getting the index.*/
QDict<IndexClass>& indexIDict();
/** Get the next index id.*/
static QString nextIndexID();
/** Get the last index id.*/
unsigned long getLastIndexID() const;
// Attribute public methods
/** Storage device (mail folder).*/
QString getStorageDevice() const;
/** The mapped name of the folder.*/
QString name() const;
/** Get the file name with the messages.*/
virtual QString getMessagesFileName() const=0;
/** Get the index file name.*/
QString getIndexFileName() const;
/** Get the descriptor file name.*/
QString getDescriptorFileName() const;
/** Get the folder type.*/
int getFolderType() const;
/** Get the folder protocol.*/
int getFolderProtocol() const;
/** Get the message place.*/
int getMessagesPlace() const;
/** Get the access rights.*/
int getAccessRights() const;
/** Set the access rights.*/
void setAccessRights(int access);
/** Set auto expunge flag.*/
static void setAutoExpunge(bool expunge=true);
/** Get auto expunge flag.*/
bool getAutoExpunge() const;
/** Number of messages.*/
int getMessageCount() const;
/** Number of unread messages.*/
int getUnread() const;
/** Get the prune index count.*/
unsigned int getPruneIndexCount() const;
// Add and delete messages from the folder.
/** Add a message to the folder.*/
virtual IndexClass *createMessage(const QCString &text, const QCString &uid,
const QDateTime &rcvtime, const QString &account,
MessageClass *parsedMessage = 0, // parsed message, added to avoid parsing second time
bool bSync=false, const unsigned flags=0)=0;
/** Add a message to the folder.*/
IndexClass *createMessage();
/** Delete a message from the folder.*/
virtual bool deleteMessage(IndexClass *idx)=0;
/** Copy a message in this folder.*/
virtual IndexClass* copyMessage(IndexClass *idx)=0;
/** Move a message in this folder.*/
virtual IndexClass* moveMessage(IndexClass *idx)=0;
/** Expunge the folder.*/
virtual bool expunge(bool force)=0;
/** Folder cache.*/
QMap<QString, QByteArray> entryCacheBlock();
/** Increment the unread messages count.*/
void incrementUnread();
/** Decrement the unread messages count.*/
void decrementUnread();
/** Set the unread messages count.*/
void setUnread(int _unread=0);
/** Get a list of folder messages id.*/
QStringList getEntryList();
/**
* Sync the messages from the list.
*/
virtual void sync()=0;
protected:
// Internal protected methods
/** Set all the folder files name.*/
void setupFiles();
/** Check if it needs expunge.*/
virtual bool shouldExpunge()=0;
// Index methods
/** Load the index file or build it.*/
virtual void loadIndex()=0;
/** Set up related-to index id cross-references.*/
void crossReferenceIndex(IndexClass *);
/** Set up parent and related-to index id cross references for a branch.*/
void crossReferenceIndexSet(IndexClass *);
/** Check for parent-son relationship and parent index, if appropriate.*/
void reparentIndex(IndexClass *);
/** Check for a related parent and parent index, if appropriate.*/
bool reparentByRelated(IndexClass *);
/** Check for a common subject and parent index, if appropriate.*/
bool reparentBySubject(IndexClass *);
/** Globally search for a given index.*/
static IndexClass *findIndex(const QString &);
/** Set the prune index count.*/
void setPruneIndexCount(unsigned int _pruneIndexCount=0);
/** Increment the prune index count.*/
void incrementPruneIndexCount();
/** Set the last index id.*/
void setLastIndexID(long unsigned _lastIndexId);
/** Sync index-message ids.*/
void syncIndexID(IndexClass *);
/** Check for a common subject.*/
bool subjectThreadMatch(QString parentSubject, QString sonSubject);
/** Translate a message id into an index id, checking all the folders.*/
static QString translateGlobalMessageID(QString);
/** Translate a message id into an index id, checking only one folder.*/
QString translateLocalMessageID(QString);
// Protected attributes
/** Index dictionary for a quick data access.*/
QDict<IndexClass> indexCollection;
/** Prune index count.*/
unsigned int pruneIndexCount;
/** The message list for being created.*/
QStringList syncMessages;
private:
// ---------- Private Attributes -------------
// global data
/** Global folder list.*/
static QList<MailFolder> folderList;
/** Global auto expunge mode.*/
static bool autoExpunge;
/** Global index tag.*/
static long unsigned lastIndexID;
// files attributes
/** Folder name.*/
QString storageDevice;
/** Index file name.*/
QString indexFileName;
/** Descriptor file name.*/
QString descriptorFileName;
/** Folder type.*/
int folderType;
/** Folder protocol.*/
int folderProtocol;
/** Messages place.*/
int messagesPlace;
/** Access rights.*/
int accessRights;
/** Unread message count.*/
unsigned int unread;
};
#endif
|
