kmail
KMFolderMbox Class Reference
Inheritance diagram for KMFolderMbox:

Detailed Description
Definition at line 47 of file kmfoldermbox.h.
Public Member Functions | |
KMFolderMbox (KMFolder *folder, const char *name=0) | |
virtual | ~KMFolderMbox () |
virtual KMFolderType | folderType () const |
DwString | getDwString (int idx) |
virtual int | addMsg (KMMessage *msg, int *index_return=0) |
virtual int | open (const char *owner) |
virtual void | reallyDoClose (const char *owner) |
virtual int | canAccess () |
virtual void | sync () |
virtual int | create () |
virtual int | compact (bool silent) |
int | compact (unsigned int startIndex, int nbMessages, FILE *tmpFile, off_t &offs, bool &done) |
virtual bool | isReadOnly () const |
bool | isLocked () const |
void | setLockType (LockType ltype=FCNTL) |
void | setProcmailLockFileName (const QString &) |
virtual IndexStatus | indexStatus () |
virtual Q_INT64 | doFolderSize () const |
Static Public Member Functions | |
static QByteArray | escapeFrom (const DwString &str) |
Protected Member Functions | |
virtual FolderJob * | doCreateJob (KMMessage *msg, FolderJob::JobType jt, KMFolder *folder, QString partSpecifier, const AttachmentStrategy *as) const |
virtual FolderJob * | doCreateJob (QPtrList< KMMessage > &msgList, const QString &sets, FolderJob::JobType jt, KMFolder *folder) const |
virtual KMMessage * | readMsg (int idx) |
virtual int | createIndexFromContents () |
virtual int | lock () |
virtual int | unlock () |
virtual int | removeContents () |
virtual int | expungeContents () |
Friends | |
class | ::KMail::MboxJob |
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 75 of file kmfoldermbox.cpp. |
Member Function Documentation
|
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). Implements FolderStorage. Reimplemented in KMFolderImap. Definition at line 929 of file kmfoldermbox.cpp. |
|
Check folder for permissions Returns zero if readable and writable.
Implements FolderStorage. Definition at line 198 of file kmfoldermbox.cpp. |
|
Remove some deleted messages from the folder. Returns zero on success and an errno on failure. This is only for use from MboxCompactionJob. Definition at line 1145 of file kmfoldermbox.cpp. |
|
Remove deleted messages from the folder. Returns zero on success and an errno on failure. Implements FolderStorage. Reimplemented in KMFolderImap. Definition at line 1222 of file kmfoldermbox.cpp. |
|
Implements FolderStorage. Reimplemented in KMFolderImap. Definition at line 210 of file kmfoldermbox.cpp. |
|
Create index file from messages file and fill the message-info list mMsgList. Returns 0 on success and an errno value (see fopen) on failure. Implements KMFolderIndex. Definition at line 540 of file kmfoldermbox.cpp. |
|
These two methods actually create the jobs. They have to be implemented in all folders.
Implements FolderStorage. Reimplemented in KMFolderImap. |
|
reimp
Reimplemented from FolderStorage. Definition at line 1271 of file kmfoldermbox.cpp. |
|
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. Implements FolderStorage. Reimplemented in KMFolderImap. Definition at line 1261 of file kmfoldermbox.cpp. |
|
Returns the type of this folder.
Reimplemented from FolderStorage. Reimplemented in KMFolderImap. Definition at line 61 of file kmfoldermbox.h. |
|
Read a message and return it as a string.
Implements FolderStorage. Definition at line 904 of file kmfoldermbox.cpp. |
|
Tests whether the contents of this folder is newer than the index. Should return IndexTooOld if the index is older than the contents. Should return IndexMissing if there is contents but no index. Should return IndexOk if the folder doesn't exist anymore "physically" or if the index is not older than the contents. Implements KMFolderIndex. Definition at line 522 of file kmfoldermbox.cpp. |
|
Is the folder locked?
Definition at line 104 of file kmfoldermbox.h. |
|
Is the folder read-only?
Implements FolderStorage. Reimplemented in KMFolderImap. Definition at line 101 of file kmfoldermbox.h. |
|
Lock mail folder files. Called by open(). Returns 0 on success and an errno error code on failure. Definition at line 303 of file kmfoldermbox.cpp. |
|
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). Implements FolderStorage. Definition at line 95 of file kmfoldermbox.cpp. |
|
Load message from file and store it at given index. Returns 0 on failure. Implements FolderStorage. Definition at line 813 of file kmfoldermbox.cpp. |
|
Implements FolderStorage. Reimplemented in KMFolderImap. Definition at line 259 of file kmfoldermbox.cpp. |
|
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. Implements FolderStorage. Definition at line 1253 of file kmfoldermbox.cpp. |
|
fsync buffers to disk
Implements FolderStorage. Definition at line 293 of file kmfoldermbox.cpp. |
|
Unlock mail folder files. Called by close(). Returns 0 on success and an errno error code on failure. Definition at line 455 of file kmfoldermbox.cpp. |
The documentation for this class was generated from the following files: