kmail

KMFolderMbox Class Reference

Inheritance diagram for KMFolderMbox:

KMFolderIndex FolderStorage KMFolderImap List of all members.

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
virtual QCString & getMsgString (int idx, QCString &mDest)
DwString getDwString (int idx)
virtual int addMsg (KMMessage *msg, int *index_return=0)
virtual int open ()
virtual void close (bool force=FALSE)
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 ()

Static Public Member Functions

static QByteArray escapeFrom (const DwString &str)

Protected Member Functions

virtual FolderJobdoCreateJob (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 KMMessagereadMsg (int idx)
virtual int createIndexFromContents ()
virtual int lock ()
virtual int unlock ()
virtual int removeContents ()
virtual int expungeContents ()

Friends

class ::KMail::MboxJob

Constructor & Destructor Documentation

KMFolderMbox::KMFolderMbox ( 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 74 of file kmfoldermbox.cpp.


Member Function Documentation

virtual KMFolderType KMFolderMbox::folderType (  )  const [inline, virtual]

Returns the type of this folder.

Reimplemented from FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 61 of file kmfoldermbox.h.

QCString & KMFolderMbox::getMsgString ( int  idx,
QCString &  mDest 
) [virtual]

Read a message and return a referece to a string.

Implements FolderStorage.

Definition at line 912 of file kmfoldermbox.cpp.

DwString KMFolderMbox::getDwString ( int  idx  )  [virtual]

Read a message and returns a DwString.

Implements FolderStorage.

Definition at line 935 of file kmfoldermbox.cpp.

int KMFolderMbox::addMsg ( KMMessage msg,
int *  index_return = 0 
) [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).

Implements FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 960 of file kmfoldermbox.cpp.

int KMFolderMbox::open (  )  [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).

Implements FolderStorage.

Definition at line 92 of file kmfoldermbox.cpp.

void KMFolderMbox::close ( bool  force = FALSE  )  [virtual]

Close folder.

If force is TRUE the files are closed even if others still use it (e.g. other mail reader windows).

Implements FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 256 of file kmfoldermbox.cpp.

int KMFolderMbox::canAccess (  )  [virtual]

Check folder for permissions Returns zero if readable and writable.

Implements FolderStorage.

Definition at line 195 of file kmfoldermbox.cpp.

void KMFolderMbox::sync (  )  [virtual]

fsync buffers to disk

Implements FolderStorage.

Definition at line 302 of file kmfoldermbox.cpp.

int KMFolderMbox::create (  )  [virtual]

Implements FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 207 of file kmfoldermbox.cpp.

int KMFolderMbox::compact ( bool  silent  )  [virtual]

Remove deleted messages from the folder.

Returns zero on success and an errno on failure.

Implements FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 1261 of file kmfoldermbox.cpp.

int KMFolderMbox::compact ( unsigned int  startIndex,
int  nbMessages,
FILE *  tmpFile,
off_t &  offs,
bool &  done 
)

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 1184 of file kmfoldermbox.cpp.

virtual bool KMFolderMbox::isReadOnly (  )  const [inline, virtual]

Is the folder read-only?

Implements FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 103 of file kmfoldermbox.h.

bool KMFolderMbox::isLocked (  )  const [inline]

Is the folder locked?

Definition at line 106 of file kmfoldermbox.h.

KMFolderIndex::IndexStatus KMFolderMbox::indexStatus (  )  [virtual]

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 531 of file kmfoldermbox.cpp.

virtual FolderJob* KMFolderMbox::doCreateJob ( KMMessage msg,
FolderJob::JobType  jt,
KMFolder folder,
QString  partSpecifier,
const AttachmentStrategy as 
) const [protected, virtual]

These two methods actually create the jobs.

They have to be implemented in all folders.

See also:
createJob

Implements FolderStorage.

Reimplemented in KMFolderImap.

KMMessage * KMFolderMbox::readMsg ( int  idx  )  [protected, virtual]

Load message from file and store it at given index.

Returns 0 on failure.

Implements FolderStorage.

Definition at line 822 of file kmfoldermbox.cpp.

int KMFolderMbox::createIndexFromContents (  )  [protected, virtual]

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 549 of file kmfoldermbox.cpp.

int KMFolderMbox::lock (  )  [protected, virtual]

Lock mail folder files.

Called by open(). Returns 0 on success and an errno error code on failure.

Definition at line 312 of file kmfoldermbox.cpp.

int KMFolderMbox::unlock (  )  [protected, virtual]

Unlock mail folder files.

Called by close(). Returns 0 on success and an errno error code on failure.

Definition at line 464 of file kmfoldermbox.cpp.

int KMFolderMbox::removeContents (  )  [protected, 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.

Implements FolderStorage.

Definition at line 1298 of file kmfoldermbox.cpp.

int KMFolderMbox::expungeContents (  )  [protected, 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.

Implements FolderStorage.

Reimplemented in KMFolderImap.

Definition at line 1306 of file kmfoldermbox.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys