kmail

kmfoldermbox.h

00001 /*
00002  * kmail: KDE mail client
00003  * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
00004  *
00005  * This program is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 2 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with this program; if not, write to the Free Software
00017  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00018  *
00019  */
00020 #ifndef kmfoldermbox_h
00021 #define kmfoldermbox_h
00022 
00023 #include "kmfolderindex.h"
00024 #include "mboxjob.h"
00025 
00026 #include <sys/types.h> // for size_t
00027 
00028 namespace KMail {
00029   class FolderJob;
00030   class MboxJob;
00031   class AttachmentStrategy;
00032 }
00033 using KMail::FolderJob;
00034 using KMail::MboxJob;
00035 using KMail::AttachmentStrategy;
00036 
00037 /* Mail folder.
00038  * (description will be here).
00039  *
00040  * Accounts:
00041  *   The accounts (of KMail) that are fed into the folder are
00042  *   represented as the children of the folder. They are only stored here
00043  *   during runtime to have a reference for which accounts point to a
00044  *   specific folder.
00045  */
00046 
00047 class KMFolderMbox : public KMFolderIndex
00048 {
00049   Q_OBJECT
00050   friend class ::KMail::MboxJob;
00051 public:
00052 
00053 
00057   KMFolderMbox(KMFolder* folder, const char* name=0);
00058   virtual ~KMFolderMbox();
00059 
00061   virtual KMFolderType folderType() const { return KMFolderTypeMbox; }
00062 
00064   DwString getDwString(int idx);
00065 
00072   virtual int addMsg( KMMessage* msg, int* index_return = 0 );
00073 
00079   virtual int open(const char *owner);
00080 
00083   virtual void close(const char *owner, bool force=FALSE);
00084 
00085   virtual int canAccess();
00086 
00088   virtual void sync();
00089 
00091   virtual int create();
00092 
00095   virtual int compact( bool silent );
00096 
00099   int compact( unsigned int startIndex, int nbMessages, FILE* tmpFile, off_t& offs, bool& done );
00100 
00102   virtual bool isReadOnly() const { return mReadOnly; }
00103 
00105   bool isLocked() const { return mFilesLocked; }
00106 
00107   void setLockType( LockType ltype=FCNTL );
00108 
00109   void setProcmailLockFileName( const QString& );
00110 
00111   static QByteArray escapeFrom( const DwString & str );
00112 
00113   virtual IndexStatus indexStatus();
00114 
00115 protected:
00116   virtual FolderJob* doCreateJob( KMMessage *msg, FolderJob::JobType jt, KMFolder *folder,
00117                                   QString partSpecifier, const AttachmentStrategy *as ) const;
00118   virtual FolderJob* doCreateJob( QPtrList<KMMessage>& msgList, const QString& sets,
00119                                   FolderJob::JobType jt, KMFolder *folder ) const;
00122   virtual KMMessage* readMsg(int idx);
00123 
00127   virtual int createIndexFromContents();
00128 
00131   virtual int lock();
00132 
00135   virtual int unlock();
00136 
00140   virtual int removeContents();
00141 
00145   virtual int expungeContents();
00146 
00147 private:
00148   FILE *mStream;
00149   bool mFilesLocked; // TRUE if the files of the folder are locked (writable)
00150   bool mReadOnly; // true if locking failed
00151   LockType mLockType;
00152   QString mProcmailLockFileName;
00153 };
00154 
00155 #endif // kmfoldermbox_h
kmail

kmfoldermbox.h

kmail

API Dox
