You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
2.9 KiB
92 lines
2.9 KiB
/* kmail message dictionary |
|
* keeps location information for every message |
|
* the message serial number is the key for the dictionary |
|
*/ |
|
|
|
#ifndef __KMMSGDICT |
|
#define __KMMSGDICT |
|
|
|
class KMFolder; |
|
class KMMsgBase; |
|
class KMMsgDictEntry; |
|
class KMMsgDictREntry; |
|
class KMDict; |
|
class QString; |
|
|
|
class KMMsgDict |
|
{ |
|
public: |
|
KMMsgDict(); |
|
~KMMsgDict(); |
|
|
|
/** Insert a new message. The message serial number is specified in |
|
* @p msgSerNum and may be zero, in which case a new serial number is |
|
* generated. Returns the message serial number. */ |
|
unsigned long insert(unsigned long msgSerNum, const KMMsgBase *msg, int index = -1); |
|
|
|
/** Insert a new message. The message serial number is taken from |
|
* the message, and passed to the other insert(). Returns the message |
|
* serial number. */ |
|
unsigned long insert(const KMMsgBase *msg, int index = -1); |
|
|
|
/** Removes a message. */ |
|
void remove(unsigned long msgSerNum); |
|
|
|
/** Removes a message, and returns its message serial number. */ |
|
unsigned long remove(const KMMsgBase *msg); |
|
|
|
/** Updates index for a message. */ |
|
void update(const KMMsgBase *msg, int index, int newIndex); |
|
|
|
/** Returns (folder,index) pair for a message. */ |
|
void getLocation(unsigned long key, KMFolder **retFolder, int *retIndex); |
|
void getLocation(const KMMsgBase *msg, KMFolder **retFolder, int *retIndex); |
|
|
|
/** Returns a message serial number for a (folder,index) pair. Zero |
|
if no such message. */ |
|
unsigned long getMsgSerNum(KMFolder *folder, int index); |
|
|
|
/** Returns the name of the .folder.index.ids file. */ |
|
static QString getFolderIdsLocation(const KMFolder *folder); |
|
|
|
/** Returns TRUE if the .folder.index.ids file should not be read. */ |
|
bool isFolderIdsOutdated(const KMFolder *folder); |
|
|
|
/** Reads the .folder.index.ids file. Returns 0 on success. */ |
|
int readFolderIds(KMFolder *folder); |
|
|
|
/** Writes the .folder.index.ids file. Returns 0 on success. */ |
|
int writeFolderIds(KMFolder *folder); |
|
|
|
/** Touches the .folder.index.ids file. Returns 0 on success. */ |
|
int touchFolderIds(KMFolder *folder); |
|
|
|
/** Appends the message to the .folder.index.ids file. |
|
* Returns 0 on success. */ |
|
int appendtoFolderIds(KMFolder *folder, int index); |
|
|
|
/** Returns true if the folder has a .folder.index.ids file. */ |
|
bool hasFolderIds(const KMFolder *folder); |
|
|
|
/** Removes the .folder.index.ids file. */ |
|
bool removeFolderIds(KMFolder *folder); |
|
|
|
// delete an entry that has been assigned to a folder |
|
static void deleteRentry(KMMsgDictREntry *entry); |
|
|
|
protected: |
|
/** Returns the next message serial number for use. */ |
|
unsigned long getNextMsgSerNum(); |
|
|
|
/** Opens the .folder.index.ids file, and writes the header |
|
* information at the beginning of the file. */ |
|
KMMsgDictREntry *openFolderIds(KMFolder *folder, bool truncate); |
|
|
|
/** The dictionary. */ |
|
KMDict *dict; |
|
|
|
/** Highest message serial number we know of. */ |
|
unsigned long nextMsgSerNum; |
|
}; |
|
|
|
#endif /* __KMMSGDICT */
|
|
|