kmail Library API Documentation

kmfoldermaildir.h

00001 #ifndef kmfoldermaildir_h
00002 #define kmfoldermaildir_h
00003 
00004 #include "kmfolderindex.h"
00005 
00006 
00007 class KMFolderMaildir;
00008 namespace KMail {
00009   class FolderJob;
00010   class MaildirJob;
00011   class AttachmentStrategy;
00012 }
00013 using KMail::FolderJob;
00014 using KMail::MaildirJob;
00015 using KMail::AttachmentStrategy;
00016 
00017 class KMFolderMaildir : public KMFolderIndex
00018 {
00019   Q_OBJECT
00020   friend class MaildirJob;
00021 public:
00025   KMFolderMaildir(KMFolder* folder, const char* name=0);
00026   virtual ~KMFolderMaildir();
00027 
00029   virtual KMFolderType folderType() const { return KMFolderTypeMaildir; }
00030 
00032   virtual QCString& getMsgString(int idx, QCString& mDest);
00033   virtual DwString getDwString(int idx);
00034 
00037   virtual KMMessage* take(int idx);
00038   virtual void take(QPtrList<KMMessage> msgList)
00039   { return KMFolderIndex::take(msgList); }
00040 
00047   virtual int addMsg(KMMessage* msg, int* index_return = 0);
00048 
00050   virtual void removeMsg(int i, bool imapQuiet = FALSE);
00051   virtual void removeMsg(QPtrList<KMMessage> msgList, bool imapQuiet = FALSE)
00052   { return KMFolderIndex::removeMsg(msgList, imapQuiet); }
00053 
00054   // Called by KMMsgBase::setStatus when status of a message has changed
00055   // required to keep the number unread messages variable current.
00056   virtual void msgStatusChanged( const KMMsgStatus oldStatus,
00057                                  const KMMsgStatus newStatus,
00058                  int idx);
00059 
00065   virtual int open();
00066 
00067   virtual int canAccess();
00068 
00070   virtual void sync();
00071 
00074   virtual void close(bool force=FALSE);
00075 
00079   virtual int create(bool imap = FALSE);
00080 
00087   static int createMaildirFolders( const QString & folderPath );
00088 
00089   static QString constructValidFileName( QString file = QString(),
00090                                   KMMsgStatus status = KMMsgStatusNew );
00091 
00092   static bool removeFile( const QString & folderPath,
00093                           const QString& filename );
00094 
00097   int compact( unsigned int startIndex, int nbMessages, const QStringList& entryList, bool& done );
00098 
00101   virtual int compact( bool silent );
00102 
00104   virtual bool isReadOnly() const { return false; }
00105 
00106 protected:
00107   virtual FolderJob* doCreateJob( KMMessage *msg, FolderJob::JobType jt, KMFolder *folder,
00108                                   QString partSpecifier, const AttachmentStrategy *as ) const;
00109   virtual FolderJob* doCreateJob( QPtrList<KMMessage>& msgList, const QString& sets,
00110                                   FolderJob::JobType jt, KMFolder *folder ) const;
00113   virtual KMMessage* readMsg(int idx);
00114 
00118   virtual int removeContents();
00119 
00123   virtual int expungeContents();
00124 
00128   virtual int createIndexFromContents();
00129 
00139   int addMsgInternal( KMMessage* msg, int* index_return = 0, bool stripUid=false );
00140 
00141 private:
00142   void readFileHeaderIntern(const QString& dir, const QString& file, KMMsgStatus status);
00143   QString moveInternal(const QString& oldLoc, const QString& newLoc, KMMsgInfo* mi);
00144   QString moveInternal(const QString& oldLoc, const QString& newLoc, QString& aFileName, KMMsgStatus status);
00145   bool removeFile(const QString& filename);
00146 
00152   virtual IndexStatus indexStatus();
00153 
00154   QStrList mIdxToFileList;
00155   int mIdxCount;
00156 };
00157 #endif /*kmfoldermaildir_h*/
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 2 09:55:13 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003