kmail
FolderStorage Class Reference
#include <folderstorage.h>
Inheritance diagram for FolderStorage:

Detailed Description
The FolderStorage class is the bass class for the storage related aspects of a collection of mail (a folder).
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.
Public Types | |
enum | ChildrenState { HasChildren, HasNoChildren, ChildrenUnknown } |
Public Slots | |
virtual int | updateIndex ()=0 |
virtual void | reallyAddMsg (KMMessage *aMsg) |
virtual void | reallyAddCopyOfMsg (KMMessage *aMsg) |
void | slotEmitChangedTimer () |
Signals | |
void | changed () |
void | cleared () |
void | expunged (KMFolder *) |
void | invalidated (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) |
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) |
void | searchResult (KMFolder *, QValueList< Q_UINT32 >, const KMSearchPattern *, bool complete) |
void | searchDone (KMFolder *, Q_UINT32, const KMSearchPattern *, bool) |
Public Member Functions | |
FolderStorage (KMFolder *folder, const char *name=0) | |
virtual | ~FolderStorage () |
KMFolder * | folder () 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) |
virtual int | addMsg (QPtrList< KMMessage > &, QValueList< int > &index_return) |
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 ()=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 void | correctUnreadMsgsCount () |
virtual int | writeIndex (bool createEmptyIndex=false)=0 |
void | registerWithMessageDict () |
void | deregisterFromMessageDict () |
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) |
KMail::FolderContentsType | contentsType () const |
virtual void | search (const KMSearchPattern *) |
virtual void | search (const KMSearchPattern *, Q_UINT32 serNum) |
virtual bool | isMoveable () const |
Static Public Member Functions | |
static QString | dotEscape (const QString &) |
Protected Types | |
enum | { mDirtyTimerInterval = 600000 } |
Protected Slots | |
virtual void | removeJob (QObject *) |
void | slotProcessNextSearchBatch () |
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 void | fillMessageDict () |
void | readFolderIdsFile () |
int | writeFolderIdsFile () const |
int | touchFolderIdsFile () |
int | appendToFolderIdsFile (int idx=-1) |
void | setRDict (KMMsgDictREntry *rentry) const |
KMMsgDictREntry * | rDict () const |
void | replaceMsgSerNum (unsigned long sernum, KMMsgBase *msg, int idx) |
void | invalidateFolder () |
virtual int | removeContents ()=0 |
virtual int | expungeContents ()=0 |
virtual bool | readIndex ()=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 | truncateIndex ()=0 |
Protected Attributes | |
int | mOpenCount |
int | mQuiet |
bool | mChanged:1 |
bool | mAutoCreateIndex:1 |
bool | mExportsSernums:1 |
bool | mDirty:1 |
bool | mFilesLocked:1 |
int | mUnreadMsgs |
int | mGuessedUnreadMsgs |
int | mTotalMsgs |
bool | mWriteConfigEnabled:1 |
bool | needsCompact:1 |
bool | mCompactable:1 |
bool | mNoContent:1 |
bool | mNoChildren:1 |
bool | mConvertToUtf8:1 |
KMMsgDictREntry * | mRDict |
QPtrList< FolderJob > | mJobList |
QTimer * | mDirtyTimer |
ChildrenState | mHasChildren |
KMail::FolderContentsType | mContentsType |
KMFolder * | mFolder |
QTimer * | mEmitChangedTimer |
int | mCurrentSearchedMsg |
const KMSearchPattern * | mSearchPattern |
Friends | |
class | KMMsgDict |
Constructor & Destructor Documentation
FolderStorage::FolderStorage | ( | KMFolder * | folder, | |
const char * | name = 0 | |||
) |
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 63 of file folderstorage.cpp.
Member Function Documentation
virtual KMFolderType FolderStorage::folderType | ( | ) | const [inline, virtual] |
Returns the type of this folder.
Reimplemented in KMFolderCachedImap, KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
Definition at line 94 of file folderstorage.h.
QString FolderStorage::fileName | ( | ) | const [virtual] |
Returns the filename of the folder (reimplemented in KMFolderImap).
Reimplemented in KMFolderImap.
Definition at line 130 of file folderstorage.cpp.
QString FolderStorage::location | ( | ) | const |
virtual QString FolderStorage::indexLocation | ( | ) | const [pure virtual] |
virtual bool FolderStorage::noContent | ( | ) | const [inline, virtual] |
Returns, if the folder can't contain mails, but only subfolder.
Definition at line 105 of file folderstorage.h.
virtual void FolderStorage::setNoContent | ( | bool | aNoContent | ) | [inline, virtual] |
virtual bool FolderStorage::noChildren | ( | ) | const [inline, virtual] |
void FolderStorage::setNoChildren | ( | bool | aNoChildren | ) | [virtual] |
virtual ChildrenState FolderStorage::hasChildren | ( | ) | const [inline, virtual] |
Returns if the folder has children, has no children or we don't know.
Definition at line 124 of file folderstorage.h.
virtual void FolderStorage::setHasChildren | ( | ChildrenState | state | ) | [inline, virtual] |
void FolderStorage::updateChildrenState | ( | ) | [virtual] |
KMMessage * FolderStorage::getMsg | ( | int | idx | ) | [virtual] |
Read message at given index.
Indexing starts at zero
Reimplemented in KMFolderImap, and KMFolderSearch.
Definition at line 461 of file folderstorage.cpp.
KMMsgInfo * FolderStorage::unGetMsg | ( | int | idx | ) | [virtual] |
Replace KMMessage with KMMsgInfo and delete KMMessage.
Definition at line 526 of file folderstorage.cpp.
bool FolderStorage::isMessage | ( | int | idx | ) | [virtual] |
Checks if the message is already "gotten" with getMsg.
Definition at line 551 of file folderstorage.cpp.
KMMessage * FolderStorage::readTemporaryMsg | ( | int | idx | ) | [virtual] |
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 496 of file folderstorage.cpp.
virtual QCString& FolderStorage::getMsgString | ( | int | idx, | |
QCString & | mDest | |||
) | [pure virtual] |
Read a message and return a referece to a string.
Implemented in KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual DwString FolderStorage::getDwString | ( | int | idx | ) | [pure virtual] |
Read a message and returns a DwString.
Implemented in KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
void FolderStorage::ignoreJobsForMessage | ( | KMMessage * | ) | [virtual] |
Removes and deletes all jobs associated with the particular message.
Reimplemented in KMFolderImap, and KMFolderSearch.
Definition at line 1013 of file folderstorage.cpp.
virtual FolderJob* FolderStorage::createJob | ( | KMMessage * | msg, | |
FolderJob::JobType | jt = FolderJob::tGetMessage , |
|||
KMFolder * | folder = 0 , |
|||
QString | partSpecifier = QString::null , |
|||
const AttachmentStrategy * | as = 0 | |||
) | const [virtual] |
These methods create respective FolderJob (You should derive FolderJob for each derived KMFolder).
virtual const KMMsgBase* FolderStorage::getMsgBase | ( | int | idx | ) | const [pure virtual] |
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.
Implemented in KMFolderIndex, and KMFolderSearch.
virtual const KMMsgBase* FolderStorage::operator[] | ( | int | idx | ) | const [inline, virtual] |
virtual KMMsgBase* FolderStorage::operator[] | ( | int | idx | ) | [inline, virtual] |
KMMessage * FolderStorage::take | ( | int | idx | ) | [virtual] |
Detach message from this folder.
Usable to call addMsg() afterwards. Loads the message if it is not loaded up to now.
Reimplemented in KMFolderCachedImap, KMFolderImap, and KMFolderMaildir.
Definition at line 409 of file folderstorage.cpp.
virtual int FolderStorage::addMsg | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) | [pure virtual] |
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).
Implemented in KMFolderCachedImap, KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual int FolderStorage::addMsgKeepUID | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) | [inline, virtual] |
(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.
Reimplemented in KMFolderCachedImap.
Definition at line 199 of file folderstorage.h.
int FolderStorage::addMsg | ( | QPtrList< KMMessage > & | , | |
QValueList< int > & | index_return | |||
) | [virtual] |
Adds the given messages to the folder.
Behaviour is identical to addMsg(msg)
Reimplemented in KMFolderImap.
Definition at line 1109 of file folderstorage.cpp.
void FolderStorage::emitMsgAddedSignals | ( | int | idx | ) |
Called by derived classes implementation of addMsg.
Emits msgAdded signals
Restart always the timer or not. BTW we get a kmheaders refresh each 3 seg.?
Definition at line 271 of file folderstorage.cpp.
bool FolderStorage::canAddMsgNow | ( | KMMessage * | aMsg, | |
int * | aIndex_ret | |||
) | [virtual] |
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 288 of file folderstorage.cpp.
void FolderStorage::removeMsg | ( | int | i, | |
bool | imapQuiet = FALSE | |||
) | [virtual] |
Remove (first occurrence of) given message from the folder.
Reimplemented in KMFolderCachedImap, KMFolderImap, and KMFolderMaildir.
Definition at line 367 of file folderstorage.cpp.
int FolderStorage::expungeOldMsg | ( | int | days | ) | [virtual] |
Delete messages in the folder that are older than days.
Return the number of deleted messages.
Definition at line 241 of file folderstorage.cpp.
int FolderStorage::moveMsg | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) | [virtual] |
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 581 of file folderstorage.cpp.
virtual int FolderStorage::find | ( | const KMMsgBase * | msg | ) | const [pure virtual] |
Returns the index of the given message or -1 if not found.
Implemented in KMFolderIndex, and KMFolderSearch.
int FolderStorage::count | ( | bool | cache = false |
) | const [virtual] |
Number of messages in this folder.
Reimplemented in KMFolderIndex, and KMFolderSearch.
Definition at line 788 of file folderstorage.cpp.
int FolderStorage::countUnread | ( | ) | [virtual] |
void FolderStorage::msgStatusChanged | ( | const KMMsgStatus | oldStatus, | |
const KMMsgStatus | newStatus, | |||
int | idx | |||
) | [virtual] |
Called by KMMsgBase::setStatus when status of a message has changed required to keep the number unread messages variable current.
Reimplemented in KMFolderMaildir.
Definition at line 816 of file folderstorage.cpp.
virtual int FolderStorage::open | ( | ) | [pure virtual] |
Open folder for access.
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).
Implemented in KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual int FolderStorage::canAccess | ( | ) | [pure virtual] |
Check folder for permissions Returns zero if readable and writable.
Implemented in KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual void FolderStorage::close | ( | bool | force = FALSE |
) | [pure virtual] |
Close folder.
If force is TRUE the files are closed even if others still use it (e.g. other mail reader windows).
Implemented in KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual void FolderStorage::tryReleasingFolder | ( | KMFolder * | ) | [inline, virtual] |
Try releasing folder
if possible, something is attempting an exclusive access to it.
Currently used for KMFolderSearch and the background tasks like expiry.
Reimplemented in KMFolderSearch.
Definition at line 266 of file folderstorage.h.
virtual void FolderStorage::sync | ( | ) | [pure virtual] |
bool FolderStorage::isOpened | ( | ) | const [inline] |
void FolderStorage::markNewAsUnread | ( | ) | [virtual] |
void FolderStorage::markUnreadAsRead | ( | ) | [virtual] |
virtual int FolderStorage::create | ( | ) | [pure virtual] |
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.
Implemented in KMFolderCachedImap, KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
void FolderStorage::remove | ( | ) | [virtual] |
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.
- See also:
- KMFolder::removeContents
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 719 of file folderstorage.cpp.
int FolderStorage::expunge | ( | ) | [virtual] |
Delete entire folder.
Forces a close *but* opens the folder again afterwards. Returns errno(3) error code or zero on success. see KMFolder::expungeContents
Definition at line 744 of file folderstorage.cpp.
virtual int FolderStorage::compact | ( | bool | silent | ) | [pure virtual] |
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 silent
is set.
Implemented in KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
int FolderStorage::rename | ( | const QString & | newName, | |
KMFolderDir * | aParent = 0 | |||
) | [virtual] |
Physically rename the folder.
Returns zero on success and an errno on failure.
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 625 of file folderstorage.cpp.
bool FolderStorage::autoCreateIndex | ( | ) | const [inline] |
Returns TRUE if a table of contents file is automatically created.
Definition at line 307 of file folderstorage.h.
void FolderStorage::setAutoCreateIndex | ( | bool | ) | [virtual] |
Allow/disallow automatic creation of a table of contents file.
Default is TRUE.
Definition at line 138 of file folderstorage.cpp.
bool FolderStorage::dirty | ( | ) | const [inline] |
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 316 of file folderstorage.h.
void FolderStorage::setDirty | ( | bool | f | ) |
bool FolderStorage::needsCompacting | ( | ) | const [inline] |
Returns TRUE if the folder contains deleted messages.
Definition at line 322 of file folderstorage.h.
void FolderStorage::quiet | ( | bool | beQuiet | ) | [virtual] |
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 192 of file folderstorage.cpp.
virtual bool FolderStorage::isReadOnly | ( | ) | const [pure virtual] |
Is the folder read-only?
Implemented in KMFolderCachedImap, KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
QString FolderStorage::label | ( | ) | const |
Returns the label of the folder for visualization.
Definition at line 783 of file folderstorage.cpp.
void FolderStorage::correctUnreadMsgsCount | ( | ) | [virtual] |
A cludge to help make sure the count of unread messges is kept in sync.
Definition at line 906 of file folderstorage.cpp.
virtual int FolderStorage::writeIndex | ( | bool | createEmptyIndex = false |
) | [pure virtual] |
Write index to index-file.
Returns 0 on success and errno error on failure.
Implemented in KMFolderIndex, and KMFolderSearch.
void FolderStorage::registerWithMessageDict | ( | ) |
Triggers registration with the message dict, which will cause the dict to ask the FolderStorage to fill itself into it.
Definition at line 913 of file folderstorage.cpp.
void FolderStorage::deregisterFromMessageDict | ( | ) |
Triggers deregistration from the message dict, which will cause the dict to ask the FolderStorage to write the relevant data structures to disk.
Definition at line 919 of file folderstorage.cpp.
void FolderStorage::setStatus | ( | int | idx, | |
KMMsgStatus | status, | |||
bool | toggle = false | |||
) | [virtual] |
Set the status of the message at index idx
to status
.
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 992 of file folderstorage.cpp.
void FolderStorage::setStatus | ( | QValueList< int > & | ids, | |
KMMsgStatus | status, | |||
bool | toggle = false | |||
) | [virtual] |
Set the status of the message(s) in the QValueList ids
to status
.
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 1005 of file folderstorage.cpp.
QString FolderStorage::dotEscape | ( | const QString & | ) | [static] |
void FolderStorage::readConfig | ( | ) | [virtual] |
Read the config file.
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 870 of file folderstorage.cpp.
void FolderStorage::writeConfig | ( | ) | [virtual] |
Write the config file.
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 889 of file folderstorage.cpp.
virtual KMFolder* FolderStorage::trashFolder | ( | ) | const [inline, virtual] |
If this folder has a special trash folder set, return it.
Otherwise return 0.
Reimplemented in KMFolderCachedImap, and KMFolderImap.
Definition at line 377 of file folderstorage.h.
void FolderStorage::addJob | ( | FolderJob * | ) | const |
Add job for this folder.
This is done automatically by createJob. This method is public only for other kind of FolderJob like ExpireJob.
bool FolderStorage::compactable | ( | ) | const [inline] |
void FolderStorage::setContentsType | ( | KMail::FolderContentsType | type | ) | [virtual] |
Set the type of contents held in this folder (mail, calendar, etc.).
Definition at line 1065 of file folderstorage.cpp.
KMail::FolderContentsType FolderStorage::contentsType | ( | ) | const [inline] |
- Returns:
- the type of contents held in this folder (mail, calendar, etc.)
Definition at line 391 of file folderstorage.h.
void FolderStorage::search | ( | const KMSearchPattern * | ) | [virtual] |
Search for messages The end is signaled with searchDone().
Reimplemented in KMFolderImap.
Definition at line 1074 of file folderstorage.cpp.
void FolderStorage::search | ( | const KMSearchPattern * | , | |
Q_UINT32 | serNum | |||
) | [virtual] |
Check if the message matches the search criteria The end is signaled with searchDone().
Reimplemented in KMFolderImap.
Definition at line 1101 of file folderstorage.cpp.
bool FolderStorage::isMoveable | ( | ) | const [virtual] |
Returns true if this folder can be moved.
Reimplemented in KMFolderCachedImap, KMFolderImap, and KMFolderSearch.
Definition at line 1124 of file folderstorage.cpp.
void FolderStorage::changed | ( | ) | [signal] |
Emitted when the status, name, or associated accounts of this folder changed.
void FolderStorage::cleared | ( | ) | [signal] |
Emitted when the contents of a folder have been cleared (new search in a search folder, for example).
void FolderStorage::expunged | ( | KMFolder * | ) | [signal] |
Emitted after an expunge.
If not quiet, changed() will be emmitted first.
void FolderStorage::invalidated | ( | KMFolder * | ) | [signal] |
Emitted when the serial numbers of this folder were invalidated.
void FolderStorage::nameChanged | ( | ) | [signal] |
Emitted when the name of the folder changes.
void FolderStorage::locationChanged | ( | const QString & | , | |
const QString & | ||||
) | [signal] |
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.
void FolderStorage::contentsTypeChanged | ( | KMail::FolderContentsType | type | ) | [signal] |
Emitted when the contents type (calendar, mail, tasks, .
.) of the folderstorage changes.
void FolderStorage::readOnlyChanged | ( | KMFolder * | ) | [signal] |
Emitted when the readonly status of the folder changes.
void FolderStorage::msgRemoved | ( | KMFolder * | , | |
Q_UINT32 | sernum | |||
) | [signal] |
Emitted before a message is removed from the folder.
void FolderStorage::msgRemoved | ( | int | idx, | |
QString | msgIdMD5 | |||
) | [signal] |
Emitted after a message is removed from the folder.
void FolderStorage::msgAdded | ( | int | idx | ) | [signal] |
Emitted when a message is added from the folder.
void FolderStorage::msgChanged | ( | KMFolder * | , | |
Q_UINT32 | sernum, | |||
int | delta | |||
) | [signal] |
Emitted, when the status of a message is changed.
void FolderStorage::msgHeaderChanged | ( | KMFolder * | , | |
int | ||||
) | [signal] |
Emitted when a field of the header of a specific message changed.
void FolderStorage::statusMsg | ( | const QString & | ) | [signal] |
Emmited to display a message somewhere in a status line.
void FolderStorage::numUnreadMsgsChanged | ( | KMFolder * | ) | [signal] |
Emitted when number of unread messages has changed.
void FolderStorage::removed | ( | KMFolder * | , | |
bool | ||||
) | [signal] |
Emitted when a folder was removed.
void FolderStorage::searchResult | ( | KMFolder * | , | |
QValueList< Q_UINT32 > | , | |||
const KMSearchPattern * | , | |||
bool | complete | |||
) | [signal] |
Emitted when a search delivers results The matching serial numbers are included If complete
is true the search is done.
void FolderStorage::searchDone | ( | KMFolder * | , | |
Q_UINT32 | , | |||
const KMSearchPattern * | , | |||
bool | ||||
) | [signal] |
Emitted when a search for a single message is completed The serial number and a bool matching yes/no is included.
virtual int FolderStorage::updateIndex | ( | ) | [pure virtual, slot] |
Incrementally update the index if possible else call writeIndex.
Implemented in KMFolderIndex, and KMFolderSearch.
void FolderStorage::reallyAddMsg | ( | KMMessage * | aMsg | ) | [virtual, slot] |
Add the message to the folder after it has been retrieved from an IMAP server.
Definition at line 310 of file folderstorage.cpp.
void FolderStorage::reallyAddCopyOfMsg | ( | KMMessage * | aMsg | ) | [virtual, slot] |
Add a copy of the message to the folder after it has been retrieved from an IMAP server.
Definition at line 331 of file folderstorage.cpp.
void FolderStorage::slotEmitChangedTimer | ( | ) | [slot] |
void FolderStorage::slotProcessNextSearchBatch | ( | ) | [protected, slot] |
virtual FolderJob* FolderStorage::doCreateJob | ( | KMMessage * | msg, | |
FolderJob::JobType | jt, | |||
KMFolder * | folder, | |||
QString | partSpecifier, | |||
const AttachmentStrategy * | as | |||
) | const [protected, pure virtual] |
These two methods actually create the jobs.
They have to be implemented in all folders.
- See also:
- createJob
Implemented in KMFolderCachedImap, KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
void FolderStorage::headerOfMsgChanged | ( | const KMMsgBase * | , | |
int | idx | |||
) | [protected] |
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 850 of file folderstorage.cpp.
virtual KMMessage* FolderStorage::readMsg | ( | int | idx | ) | [protected, pure virtual] |
Load message from file and store it at given index.
Returns 0 on failure.
Implemented in KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual void FolderStorage::fillMessageDict | ( | ) | [inline, protected, virtual] |
Inserts messages into the message dictionary.
The messages will get new serial numbers. This is only used on newly appeared folders, where there is no .ids file yet, or when that has been invalidated.
Reimplemented in KMFolderIndex.
Definition at line 527 of file folderstorage.h.
void FolderStorage::readFolderIdsFile | ( | ) | [protected] |
Read the on-disk cache of serial numbers of messages in this store and fill those into the global message dict, such that the messages we hold can be looked up there.
Definition at line 925 of file folderstorage.cpp.
int FolderStorage::writeFolderIdsFile | ( | ) | const [protected] |
int FolderStorage::touchFolderIdsFile | ( | ) | [protected] |
int FolderStorage::appendToFolderIdsFile | ( | int | idx = -1 |
) | [protected] |
Append message to end of message serial number file.
Definition at line 962 of file folderstorage.cpp.
void FolderStorage::setRDict | ( | KMMsgDictREntry * | rentry | ) | const [protected] |
Sets the reverse-dictionary for this folder.
const, because the mRDict is mutable, since it is not part of the (conceptually) const-relevant state of the object.
Definition at line 980 of file folderstorage.cpp.
KMMsgDictREntry* FolderStorage::rDict | ( | ) | const [inline, protected] |
void FolderStorage::replaceMsgSerNum | ( | unsigned long | sernum, | |
KMMsgBase * | msg, | |||
int | idx | |||
) | [protected] |
Replaces the serial number for the message msg
at index idx
with sernum
.
Definition at line 974 of file folderstorage.cpp.
void FolderStorage::invalidateFolder | ( | ) | [protected] |
Called when serial numbers for a folder are invalidated, invalidates/recreates data structures dependent on the serial numbers for this folder.
Definition at line 936 of file folderstorage.cpp.
virtual int FolderStorage::removeContents | ( | ) | [protected, pure virtual] |
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.
Implemented in KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual int FolderStorage::expungeContents | ( | ) | [protected, pure virtual] |
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.
Implemented in KMFolderImap, KMFolderMaildir, KMFolderMbox, and KMFolderSearch.
virtual bool FolderStorage::readIndex | ( | ) | [protected, pure virtual] |
Read index file and fill the message-info list mMsgList.
Implemented in KMFolderIndex, and KMFolderSearch.
Member Data Documentation
bool FolderStorage::mAutoCreateIndex [protected] |
bool FolderStorage::mExportsSernums [protected] |
Has this storage exported its serial numbers to the global message dict for lookup?
Definition at line 585 of file folderstorage.h.
bool FolderStorage::mDirty [protected] |
if the index is dirty it will be recreated upon close()
Definition at line 587 of file folderstorage.h.
bool FolderStorage::mFilesLocked [protected] |
TRUE if the files of the folder are locked (writable).
Definition at line 589 of file folderstorage.h.
int FolderStorage::mUnreadMsgs [protected] |
bool FolderStorage::needsCompact [protected] |
sven: true if on destruct folder needs to be compacted.
Definition at line 596 of file folderstorage.h.
bool FolderStorage::mCompactable [protected] |
KMMsgDictREntry* FolderStorage::mRDict [mutable, protected] |
QPtrList<FolderJob> FolderStorage::mJobList [mutable, protected] |
The documentation for this class was generated from the following files: