kmfoldermbox.h

/*
 * kmail: KDE mail client
 * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef kmfoldermbox_h
#define kmfoldermbox_h
 
#include "kmfolderindex.h"
#include "mboxjob.h"
 
#include <sys/types.h> // for size_t
 
namespace KMail {
  class FolderJob;
  class MboxJob;
  class AttachmentStrategy;
}
using KMail::FolderJob;
using KMail::MboxJob;
using KMail::AttachmentStrategy;
 
/* Mail folder.
 * (description will be here).
 *
 * 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.
 */
 
class KMFolderMbox : public KMFolderIndex
{
  TQ_OBJECT
  
  friend class ::KMail::MboxJob;
public:
 

  KMFolderMbox(KMFolder* folder, const char* name=0);
  virtual ~KMFolderMbox();

  virtual KMFolderType folderType() const { return KMFolderTypeMbox; }

  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 { return mReadOnly; }

  bool isLocked() const { return mFilesLocked; }
 
  void setLockType( LockType ltype=FCNTL );
 
  void setProcmailLockFileName( const TQString& );
 
  static TQByteArray escapeFrom( const DwString & str );
 
  virtual IndexStatus indexStatus();

  virtual TQ_INT64 doFolderSize() const;
 
protected:
  virtual FolderJob* doCreateJob( KMMessage *msg, FolderJob::JobType jt, KMFolder *folder,
                                  TQString partSpecifier, const AttachmentStrategy *as ) const;
  virtual FolderJob* doCreateJob( TQPtrList<KMMessage>& msgList, const TQString& 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();
 
private:
  FILE *mStream;
  bool mFilesLocked; // true if the files of the folder are locked (writable)
  bool mReadOnly; // true if locking failed
  LockType mLockType;
  TQString mProcmailLockFileName;
};
 
#endif // kmfoldermbox_h