FolderStorage Class Reference
Mail folder. More...
#include <folderstorage.h>
Inheritance diagram for FolderStorage:


Public Types | |
enum | ChildrenState { HasChildren, HasNoChildren, ChildrenUnknown } |
Public Slots | |
virtual int | updateIndex ()=0 |
virtual void | reallyAddMsg (KMMessage *aMsg) |
virtual void | reallyAddCopyOfMsg (KMMessage *aMsg) |
Signals | |
void | changed () |
void | cleared () |
void | expunged (KMFolder *) |
void | nameChanged () |
void | locationChanged (const QString &, const QString &) |
void | contentsTypeChanged (KMail::FolderContentsType type) |
void | readOnlyChanged (KMFolder *) |
void | msgRemoved (KMFolder *, Q_UINT32 sernum) |
void | msgRemoved (int idx, QString msgIdMD5, QString strippedSubjMD5) |
void | msgRemoved (KMFolder *) |
void | msgAdded (int idx) |
void | msgAdded (KMFolder *, Q_UINT32 sernum) |
void | msgChanged (KMFolder *, Q_UINT32 sernum, int delta) |
void | msgHeaderChanged (KMFolder *, int) |
void | statusMsg (const QString &) |
void | numUnreadMsgsChanged (KMFolder *) |
void | removed (KMFolder *, bool) |
Public Member Functions | |
FolderStorage (KMFolder *folder, const char *name=0) | |
KMFolder * | folder () const |
void | setAcctList (KMAcctList *list) |
KMAcctList * | acctList () const |
virtual KMFolderType | folderType () const |
virtual QString | fileName () const |
QString | location () const |
virtual QString | indexLocation () const =0 |
virtual bool | noContent () const |
virtual void | setNoContent (bool aNoContent) |
virtual bool | noChildren () const |
virtual void | setNoChildren (bool aNoChildren) |
virtual ChildrenState | hasChildren () const |
virtual void | setHasChildren (ChildrenState state) |
virtual void | updateChildrenState () |
virtual KMMessage * | getMsg (int idx) |
virtual KMMsgInfo * | unGetMsg (int idx) |
virtual bool | isMessage (int idx) |
virtual KMMessage * | readTemporaryMsg (int idx) |
virtual QCString & | getMsgString (int idx, QCString &mDest)=0 |
virtual DwString | getDwString (int idx)=0 |
virtual void | ignoreJobsForMessage (KMMessage *) |
virtual FolderJob * | createJob (KMMessage *msg, FolderJob::JobType jt=FolderJob::tGetMessage, KMFolder *folder=0, QString partSpecifier=QString::null, const AttachmentStrategy *as=0) const |
virtual FolderJob * | createJob (QPtrList< KMMessage > &msgList, const QString &sets, FolderJob::JobType jt=FolderJob::tGetMessage, KMFolder *folder=0) const |
virtual const KMMsgBase * | getMsgBase (int idx) const =0 |
virtual KMMsgBase * | getMsgBase (int idx)=0 |
virtual const KMMsgBase * | operator[] (int idx) const |
virtual KMMsgBase * | operator[] (int idx) |
virtual KMMessage * | take (int idx) |
virtual void | take (QPtrList< KMMessage > msgList) |
virtual int | addMsg (KMMessage *msg, int *index_return=0)=0 |
virtual int | addMsgKeepUID (KMMessage *msg, int *index_return=0) |
void | emitMsgAddedSignals (int idx) |
virtual bool | canAddMsgNow (KMMessage *aMsg, int *aIndex_ret) |
virtual void | removeMsg (int i, bool imapQuiet=FALSE) |
virtual void | removeMsg (const QPtrList< KMMsgBase > &msgList, bool imapQuiet=FALSE) |
virtual void | removeMsg (const QPtrList< KMMessage > &msgList, bool imapQuiet=FALSE) |
virtual int | expungeOldMsg (int days) |
virtual int | moveMsg (KMMessage *msg, int *index_return=0) |
virtual int | moveMsg (QPtrList< KMMessage >, int *index_return=0) |
virtual int | find (const KMMsgBase *msg) const =0 |
int | find (const KMMessage *msg) const |
virtual int | count (bool cache=false) const |
virtual int | countUnread () |
virtual void | msgStatusChanged (const KMMsgStatus oldStatus, const KMMsgStatus newStatus, int idx) |
virtual int | open ()=0 |
virtual int | canAccess ()=0 |
virtual void | close (bool force=FALSE)=0 |
virtual void | tryReleasingFolder (KMFolder *) |
virtual void | sync ()=0 |
bool | isOpened () const |
virtual void | markNewAsUnread () |
virtual void | markUnreadAsRead () |
virtual int | create (bool imap=FALSE)=0 |
virtual void | remove () |
virtual int | expunge () |
virtual int | compact (bool silent)=0 |
virtual int | rename (const QString &newName, KMFolderDir *aParent=0) |
bool | autoCreateIndex () const |
virtual void | setAutoCreateIndex (bool) |
bool | dirty () const |
void | setDirty (bool f) |
bool | needsCompacting () const |
virtual void | setNeedsCompacting (bool f) |
virtual void | quiet (bool beQuiet) |
virtual bool | isReadOnly () const =0 |
QString | label () const |
virtual const char * | type () const |
bool | hasAccounts () const |
virtual void | correctUnreadMsgsCount () |
virtual int | writeIndex (bool createEmptyIndex=false)=0 |
void | fillMsgDict (KMMsgDict *dict) |
int | writeMsgDict (KMMsgDict *dict=0) |
int | touchMsgDict () |
int | appendtoMsgDict (int idx=-1) |
void | setRDict (KMMsgDictREntry *rentry) |
KMMsgDictREntry * | rDict () const |
virtual void | setStatus (int idx, KMMsgStatus status, bool toggle=false) |
virtual void | setStatus (QValueList< int > &ids, KMMsgStatus status, bool toggle=false) |
void | removeJobs () |
virtual void | readConfig () |
virtual void | writeConfig () |
virtual KMFolder * | trashFolder () const |
void | addJob (FolderJob *) const |
bool | compactable () const |
virtual void | setContentsType (KMail::FolderContentsType type, bool quiet=false) |
KMail::FolderContentsType | contentsType () const |
Static Public Member Functions | |
static size_t | crlf2lf (char *str, const size_t strLen) |
static QString | dotEscape (const QString &) |
Protected Types | |
enum | { mDirtyTimerInterval = 600000 } |
Protected Slots | |
virtual void | removeJob (QObject *) |
Protected Member Functions | |
virtual FolderJob * | doCreateJob (KMMessage *msg, FolderJob::JobType jt, KMFolder *folder, QString partSpecifier, const AttachmentStrategy *as) const =0 |
virtual FolderJob * | doCreateJob (QPtrList< KMMessage > &msgList, const QString &sets, FolderJob::JobType jt, KMFolder *folder) const =0 |
void | headerOfMsgChanged (const KMMsgBase *, int idx) |
virtual KMMessage * | readMsg (int idx)=0 |
virtual bool | readIndex ()=0 |
virtual int | removeContents ()=0 |
virtual int | expungeContents ()=0 |
virtual KMMsgBase * | takeIndexEntry (int idx)=0 |
virtual KMMsgInfo * | setIndexEntry (int idx, KMMessage *msg)=0 |
virtual void | clearIndex (bool autoDelete=true, bool syncDict=false)=0 |
virtual void | fillDictFromIndex (KMMsgDict *dict)=0 |
virtual void | truncateIndex ()=0 |
Protected Attributes | |
int | mOpenCount |
int | mQuiet |
bool | mChanged |
bool | mAutoCreateIndex |
bool | mDirty |
bool | mFilesLocked |
KMAcctList * | mAcctList |
int | mUnreadMsgs |
int | mGuessedUnreadMsgs |
int | mTotalMsgs |
bool | mWriteConfigEnabled |
bool | needsCompact |
bool | mCompactable |
bool | mNoContent |
bool | mNoChildren |
bool | mConvertToUtf8 |
KMMsgDictREntry * | mRDict |
QPtrList< FolderJob > | mJobList |
QTimer * | mDirtyTimer |
ChildrenState | mHasChildren |
KMail::FolderContentsType | mContentsType |
KMFolder * | mFolder |
Detailed Description
Mail folder.(description will be here).
Accounts: The accounts (of KMail) that are fed into the folder are represented as the children of the folder. They are only stored here during runtime to have a reference for which accounts point to a specific folder.
Definition at line 78 of file folderstorage.h.
Constructor & Destructor Documentation
|
Usually a parent is given. But in some cases there is no fitting parent object available. Then the name of the folder is used as the absolute path to the folder file. Definition at line 61 of file folderstorage.cpp. References mAutoCreateIndex, mCompactable, mContentsType, mDirty, mGuessedUnreadMsgs, mRDict, mUnreadMsgs, needsCompact, and updateIndex(). |
Member Function Documentation
|
Returns the type of this folder.
Definition at line 97 of file folderstorage.h. Referenced by KMFolder::folderType(), KMail::RenameJob::RenameJob(), KMail::RenameJob::slotMoveCompleted(), and KMail::RenameJob::slotRenameResult(). |
|
Returns the filename of the folder (reimplemented in KMFolderImap).
Definition at line 129 of file folderstorage.cpp. Referenced by KMFolder::fileName(), and location(). |
|
Returns full path to folder file.
Definition at line 119 of file folderstorage.cpp. References dotEscape(), and fileName(). Referenced by getMsg(), KMFolder::location(), and rename(). |
|
Returns full path to index file.
Referenced by expunge(), KMFolder::indexLocation(), remove(), and rename(). |
|
Returns, if the folder can't contain mails, but only subfolder.
Definition at line 108 of file folderstorage.h. Referenced by KMFolder::noContent(). |
|
Specify, that the folder can't contain mails.
Definition at line 111 of file folderstorage.h. Referenced by KMFolder::setNoContent(). |
|
Returns, if the folder can't have children.
Definition at line 115 of file folderstorage.h. Referenced by KMFolder::noChildren(). |
|
Specify, that the folder can't have children.
Definition at line 1011 of file folderstorage.cpp. References setHasChildren(). Referenced by KMFolder::setNoChildren(). |
|
Returns if the folder has children, has no children or we don't know.
Definition at line 127 of file folderstorage.h. |
|
Specify if the folder has children.
Definition at line 130 of file folderstorage.h. Referenced by setNoChildren(), and updateChildrenState(). |
|
Updates the hasChildren() state.
Definition at line 999 of file folderstorage.cpp. References setHasChildren(). Referenced by KMFolder::setChild(). |
|
Read message at given index. Indexing starts at zero Definition at line 427 of file folderstorage.cpp. References count(), getMsgBase(), label(), location(), mCompactable, readMsg(), and writeConfig(). Referenced by KMFolder::getMsg(). |
|
Replace KMMessage with KMMsgInfo and delete KMMessage.
Definition at line 494 of file folderstorage.cpp. References count(), getMsgBase(), and ignoreJobsForMessage(). Referenced by reallyAddCopyOfMsg(), reallyAddMsg(), and KMFolder::unGetMsg(). |
|
Checks if the message is already "gotten" with getMsg.
Definition at line 519 of file folderstorage.cpp. References count(), and getMsgBase(). Referenced by KMFolder::isMessage(). |
|
Load message from file and do NOT store it, only return it. This is equivalent to, but faster than, getMsg+unGetMsg WARNING: the caller has to delete the returned value! Definition at line 465 of file folderstorage.cpp. References count(), getDwString(), and getMsgBase(). |
|
Read a message and return a referece to a string.
Referenced by KMFolder::getMsgString(). |
|
Read a message and returns a DwString.
Referenced by KMFolder::getDwString(), and readTemporaryMsg(). |
|
Removes and deletes all jobs associated with the particular message.
Definition at line 939 of file folderstorage.cpp. References mJobList. Referenced by KMFolder::ignoreJobsForMessage(), and unGetMsg(). |
|
These methods create respective FolderJob (You should derive FolderJob for each derived KMFolder).
Definition at line 528 of file folderstorage.cpp. References addJob(), and doCreateJob(). Referenced by KMFolder::createJob(). |
|
Provides access to the basic message fields that are also stored in the index. Whenever you only need subject, from, date, status you should use this method instead of getMsg() because getMsg() will load the message if necessary and this method does not. Referenced by KMail::CopyFolderJob::copyMessagesToTargetDir(), expungeOldMsg(), getMsg(), KMFolder::getMsgBase(), isMessage(), markNewAsUnread(), markUnreadAsRead(), operator[](), readTemporaryMsg(), removeMsg(), setStatus(), KMail::RenameJob::slotMoveMessages(), take(), and unGetMsg(). |
|
Same as getMsgBase(int).
Definition at line 181 of file folderstorage.h. References getMsgBase(). |
|
Same as getMsgBase(int). This time non-const. Definition at line 184 of file folderstorage.h. References getMsgBase(). |
|
Detach message from this folder. Usable to call addMsg() afterwards. Loads the message if it is not loaded up to now. Definition at line 376 of file folderstorage.cpp. References count(), getMsgBase(), msgRemoved(), mUnreadMsgs, needsCompact, numUnreadMsgsChanged(), readMsg(), and setDirty(). Referenced by KMFolder::take(). |
|
Add the given message to the folder. Usually the message is added at the end of the folder. Returns zero on success and an errno error code on failure. The index of the new message is stored in index_return if given. Please note that the message is added as is to the folder and the folder takes ownership of the message (deleting it in the destructor). Referenced by KMFolder::addMsg(), addMsgKeepUID(), moveMsg(), reallyAddCopyOfMsg(), and reallyAddMsg(). |
|
(Note(bo): This needs to be fixed better at a later point. ) This is overridden by dIMAP because addMsg strips the X-UID header from the mail. Definition at line 202 of file folderstorage.h. References addMsg(). Referenced by KMFolder::addMsgKeepUID(). |
|
Called by derived classes implementation of addMsg. Emits msgAdded signals Definition at line 249 of file folderstorage.cpp. References msgAdded(). Referenced by KMFolder::emitMsgAddedSignals(). |
|
Returns FALSE, if the message has to be retrieved from an IMAP account first. In this case this function does this and cares for the rest Definition at line 261 of file folderstorage.cpp. References KMFolder::createJob(), KMFolder::folderType(), and reallyAddMsg(). |
|
Remove (first occurrence of) given message from the folder.
Definition at line 338 of file folderstorage.cpp. References getMsgBase(), msgRemoved(), mUnreadMsgs, needsCompact, numUnreadMsgsChanged(), and setDirty(). Referenced by expungeOldMsg(), and KMFolder::removeMsg(). |
|
Delete messages in the folder that are older than days. Return the number of deleted messages. Definition at line 225 of file folderstorage.cpp. References count(), getMsgBase(), and removeMsg(). Referenced by KMFolder::expungeOldMsg(). |
|
Detaches the given message from it's current folder and adds it to this folder. Returns zero on success and an errno error code on failure. The index of the new message is stored in index_return if given. Definition at line 549 of file folderstorage.cpp. References addMsg(), KMFolder::close(), close(), open(), and KMFolder::open(). Referenced by KMFolder::moveMsg(). |
|
Returns the index of the given message or -1 if not found.
Referenced by KMFolder::find(). |
|
Number of messages in this folder.
Definition at line 760 of file folderstorage.cpp. Referenced by appendtoMsgDict(), KMFolder::count(), expungeOldMsg(), getMsg(), isMessage(), markNewAsUnread(), markUnreadAsRead(), readTemporaryMsg(), reallyAddCopyOfMsg(), take(), and unGetMsg(). |
|
Number of new or unread messages in this folder.
Definition at line 769 of file folderstorage.cpp. References close(), mGuessedUnreadMsgs, mUnreadMsgs, open(), and readConfig(). Referenced by KMFolder::countUnread(). |
|
Called by KMMsgBase::setStatus when status of a message has changed required to keep the number unread messages variable current.
Definition at line 788 of file folderstorage.cpp. References msgChanged(), mUnreadMsgs, and numUnreadMsgsChanged(). Referenced by KMFolder::msgStatusChanged(). |
|
Open folder for access. Does not work if the parent is not set. Does nothing if the folder is already opened. To reopen a folder call close() first. Returns zero on success and an error code equal to the c-library fopen call otherwise (errno). Referenced by correctUnreadMsgsCount(), countUnread(), expunge(), moveMsg(), KMFolder::open(), KMFolder::remove(), and rename(). |
|
Check folder for permissions Returns zero if readable and writable.
Referenced by KMFolder::canAccess(). |
|
Close folder. If force is TRUE the files are closed even if others still use it (e.g. other mail reader windows). Referenced by KMFolder::close(), correctUnreadMsgsCount(), countUnread(), expunge(), moveMsg(), remove(), and rename(). |
|
Try releasing Currently used for KMFolderSearch and the background tasks like expiry. Definition at line 263 of file folderstorage.h. |
|
fsync buffers to disk
Referenced by KMFolder::sync(). |
|
Test if folder is opened.
Definition at line 269 of file folderstorage.h. Referenced by KMFolder::isOpened(). |
|
Mark all new messages as unread.
Definition at line 153 of file folderstorage.cpp. References count(), and getMsgBase(). Referenced by KMFolder::markNewAsUnread(). |
|
Mark all new and unread messages as read.
Definition at line 169 of file folderstorage.cpp. References count(), and getMsgBase(). Referenced by KMFolder::markUnreadAsRead(). |
|
Create a new folder with the name of this object and open it. Returns zero on success and an error code equal to the c-library fopen call otherwise. Referenced by KMFolder::create(). |
|
Removes the folder physically from disk and empties the contents of the folder in memory. Note that the folder is closed during this process, whether there are others using it or not.
Definition at line 684 of file folderstorage.cpp. References close(), indexLocation(), needsCompact, removeContents(), and removed(). Referenced by KMFolder::remove(). |
|
Delete entire folder. Forces a close *but* opens the folder again afterwards. Returns errno(3) error code or zero on success.
Definition at line 708 of file folderstorage.cpp. References changed(), close(), expungeContents(), expunged(), indexLocation(), mAutoCreateIndex, mDirty, mUnreadMsgs, needsCompact, numUnreadMsgsChanged(), open(), and writeConfig(). Referenced by KMFolder::expunge(). |
|
Remove deleted messages from the folder.
Returns zero on success and an errno on failure. A statusbar message will inform the user that the compaction worked, unless Referenced by KMFolder::compact(). |
|
Physically rename the folder. Returns zero on success and an errno on failure. Definition at line 590 of file folderstorage.cpp. References close(), indexLocation(), location(), locationChanged(), nameChanged(), open(), and writeConfig(). Referenced by KMFolder::rename(), and KMail::RenameJob::slotRenameResult(). |
|
Returns TRUE if a table of contents file is automatically created.
Definition at line 304 of file folderstorage.h. References mAutoCreateIndex. Referenced by KMFolder::autoCreateIndex(). |
|
Allow/disallow automatic creation of a table of contents file. Default is TRUE. Definition at line 137 of file folderstorage.cpp. References mAutoCreateIndex. Referenced by KMFolder::setAutoCreateIndex(). |
|
Returns TRUE if the table of contents is dirty. This happens when a message is deleted from the folder. The toc will then be re-created when the folder is closed. Definition at line 313 of file folderstorage.h. References mDirty. Referenced by KMFolder::dirty(). |
|
Change the dirty flag.
Definition at line 143 of file folderstorage.cpp. References mAutoCreateIndex, and mDirty. Referenced by removeMsg(), KMFolder::setDirty(), and take(). |
|
Returns TRUE if the folder contains deleted messages.
Definition at line 319 of file folderstorage.h. References needsCompact. Referenced by KMFolder::needsCompacting(). |
|
If set to quiet the folder will not emit msgAdded(idx) signal. This is necessary because adding the messages to the listview one by one as they come in ( as happens on msgAdded(idx) ) is very slow for large ( >10000 ) folders. For pop, where whole bodies are downloaded this is not an issue, but for imap, where we only download headers it becomes a bottleneck. We therefore set the folder quiet() and rebuild the listview completely once the complete folder has been checked. Definition at line 191 of file folderstorage.cpp. References changed(). Referenced by KMFolder::quiet(). |
|
Is the folder read-only?
Referenced by KMFolder::isReadOnly(). |
|
Returns the label of the folder for visualization.
Definition at line 755 of file folderstorage.cpp. Referenced by getMsg(). |
|
Type of the folder. Inherited. Definition at line 747 of file folderstorage.cpp. Referenced by readConfig(), and KMFolder::type(). |
|
Returns TRUE if accounts are associated with this folder.
Definition at line 342 of file folderstorage.h. Referenced by KMFolder::hasAccounts(). |
|
A cludge to help make sure the count of unread messges is kept in sync.
Definition at line 862 of file folderstorage.cpp. References close(), numUnreadMsgsChanged(), and open(). Referenced by KMFolder::correctUnreadMsgsCount(). |
|
Write index to index-file. Returns 0 on success and errno error on failure. Referenced by KMFolder::writeIndex(). |
|
Inserts messages into the message dictionary. Might be called during kernel initialization. Definition at line 870 of file folderstorage.cpp. Referenced by KMFolder::fillMsgDict(). |
|
Writes the message serial number file.
Definition at line 876 of file folderstorage.cpp. Referenced by KMFolder::writeMsgDict(). |
|
Touches the message serial number file.
Definition at line 887 of file folderstorage.cpp. Referenced by KMFolder::touchMsgDict(). |
|
Append message to end of message serial number file.
Definition at line 897 of file folderstorage.cpp. References count(). Referenced by KMFolder::appendtoMsgDict(). |
|
Sets the reverse-dictionary for this folder.
Definition at line 923 of file folderstorage.cpp. References mRDict. Referenced by KMFolder::setRDict(). |
|
Returns the reverse-dictionary for this folder.
Definition at line 368 of file folderstorage.h. References mRDict. Referenced by KMFolder::rDict(). |
|
Set the status of the message at index
Definition at line 912 of file folderstorage.cpp. References getMsgBase(). Referenced by KMFolder::setStatus(), and setStatus(). |
|
Set the status of the message(s) in the QValueList
Definition at line 931 of file folderstorage.cpp. References setStatus(). |
|
Convert "\r\n" line endings in "\n" line endings. The conversion happens in place. Returns the length of the resulting string. Definition at line 969 of file folderstorage.cpp. Referenced by KMFolder::crlf2lf(). |
|
Escape a leading dot.
Definition at line 99 of file folderstorage.cpp. Referenced by location(), and KMFolder::subdirLocation(). |
|
Read the config file.
Definition at line 827 of file folderstorage.cpp. References mCompactable, mUnreadMsgs, setContentsType(), and type(). Referenced by countUnread(), and KMFolder::KMFolder(). |
|
Write the config file.
Definition at line 846 of file folderstorage.cpp. References mCompactable, mContentsType, mGuessedUnreadMsgs, and mUnreadMsgs. Referenced by expunge(), getMsg(), rename(), KMFolder::setAutoExpire(), KMFolder::setMailingListEnabled(), KMFolder::setReadExpireAge(), and KMFolder::setUnreadExpireAge(). |
|
If this folder has a special trash folder set, return it. Otherwise return 0. Definition at line 396 of file folderstorage.h. Referenced by KMFolder::trashFolder(). |
|
Add job for this folder. This is done automatically by createJob. This method is public only for other kind of FolderJob like ExpireJob. Definition at line 105 of file folderstorage.cpp. References mJobList. Referenced by createJob(). |
|
false if index file is out of sync with mbox file
Definition at line 405 of file folderstorage.h. References mCompactable. |
|
Set the type of contents held in this folder (mail, calendar, etc.).
Definition at line 1019 of file folderstorage.cpp. References contentsTypeChanged(), and mContentsType. Referenced by readConfig(). |
|
Definition at line 413 of file folderstorage.h. References mContentsType. Referenced by KMail::CopyFolderJob::createTargetDir(). |
|
Emitted when the status, name, or associated accounts of this folder changed.
|
|
Emitted when the contents of a folder have been cleared (new search in a search folder, for example).
|
|
Emitted after an expunge. If not quiet, changed() will be emmitted first. Referenced by expunge(). |
|
Emitted when the name of the folder changes.
Referenced by rename(). |
|
Emitted when the location on disk of the folder changes. This is used by all code which uses the locatio on disk of the folder storage ( or the cache storage ) as an identifier for the folder. Referenced by rename(). |
|
Emitted when the contents type (calendar, mail, tasks, . .) of the folderstorage changes. Referenced by setContentsType(). |
|
Emitted when the readonly status of the folder changes.
|
|
Emitted before a message is removed from the folder.
Referenced by removeMsg(), and take(). |
|
Emitted after a message is removed from the folder.
|
|
Emitted when a message is added from the folder.
Referenced by emitMsgAddedSignals(). |
|
Emitted, when the status of a message is changed.
Referenced by msgStatusChanged(). |
|
Emitted when a field of the header of a specific message changed.
Referenced by headerOfMsgChanged(). |
|
Emmited to display a message somewhere in a status line.
|
|
Emitted when number of unread messages has changed.
Referenced by correctUnreadMsgsCount(), expunge(), msgStatusChanged(), removeMsg(), and take(). |
|
Emitted when a folder was removed.
Referenced by remove(). |
|
Incrementally update the index if possible else call writeIndex.
Referenced by FolderStorage(), and KMFolder::updateIndex(). |
|
Add the message to the folder after it has been retrieved from an IMAP server.
Definition at line 283 of file folderstorage.cpp. References addMsg(), and unGetMsg(). Referenced by canAddMsgNow(), and KMFolder::reallyAddMsg(). |
|
Add a copy of the message to the folder after it has been retrieved from an IMAP server.
Definition at line 303 of file folderstorage.cpp. References addMsg(), count(), and unGetMsg(). Referenced by KMFolder::reallyAddCopyOfMsg(). |
|
These two methods actually create the jobs. They have to be implemented in all folders.
Referenced by createJob(). |
|
Tell the folder that a header field that is usually used for the index (subject, from, . ..) has changed of given message. This method is usually called from within KMMessage::setSubject/set... Definition at line 816 of file folderstorage.cpp. References msgHeaderChanged(). |
|
Load message from file and store it at given index. Returns 0 on failure. |
|
Read index file and fill the message-info list mMsgList.
|
|
Called by KMFolder::remove() to delete the actual contents. At the time of the call the folder has already been closed, and the various index files deleted. Returns 0 on success. Referenced by remove(). |
|
Called by KMFolder::expunge() to delete the actual contents. At the time of the call the folder has already been closed, and the various index files deleted. Returns 0 on success. Referenced by expunge(). |
Member Data Documentation
|
is the automatic creation of a index file allowed ?
Definition at line 527 of file folderstorage.h. Referenced by autoCreateIndex(), expunge(), FolderStorage(), setAutoCreateIndex(), and setDirty(). |
|
if the index is dirty it will be recreated upon close()
Definition at line 529 of file folderstorage.h. Referenced by dirty(), expunge(), FolderStorage(), and setDirty(). |
|
TRUE if the files of the folder are locked (writable).
Definition at line 531 of file folderstorage.h. |
|
number of unread messages, -1 if not yet set
Definition at line 535 of file folderstorage.h. Referenced by countUnread(), expunge(), FolderStorage(), msgStatusChanged(), readConfig(), removeMsg(), take(), and writeConfig(). |
|
number of unread messages, -1 if not yet set
Definition at line 535 of file folderstorage.h. Referenced by countUnread(), FolderStorage(), and writeConfig(). |
|
sven: true if on destruct folder needs to be compacted.
Definition at line 539 of file folderstorage.h. Referenced by expunge(), FolderStorage(), needsCompacting(), remove(), removeMsg(), and take(). |
|
false if index file is out of sync with mbox file
Definition at line 541 of file folderstorage.h. Referenced by compactable(), FolderStorage(), getMsg(), readConfig(), and writeConfig(). |
|
Points at the reverse dictionary for this folder.
Definition at line 547 of file folderstorage.h. Referenced by FolderStorage(), rDict(), and setRDict(). |
|
List of jobs created by this folder.
Definition at line 549 of file folderstorage.h. Referenced by addJob(), and ignoreJobsForMessage(). |
|
Type of contents in this folder.
Definition at line 557 of file folderstorage.h. Referenced by contentsType(), FolderStorage(), setContentsType(), and writeConfig(). |
The documentation for this class was generated from the following files: