• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

kmail

kmfolder.h

Go to the documentation of this file.

/* -*- mode: C++ -*-
 * 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 kmfolder_h
#define kmfolder_h

// for large file support

#include "kmfoldernode.h"
#include "kmfoldertype.h"
#include "kmmsginfo.h"
#include "kmglobal.h"
#include "kmkernel.h"
#include "folderjob.h"
using KMail::FolderJob;
#include "mailinglist-magic.h"
using KMail::MailingList;
//#include "kmaccount.h" // for AccountList
class KMAccount;
typedef QList<KMAccount*> AccountList;

#include "mimelib/string.h"
#include <kshortcut.h>

#include <QList>


#include <sys/types.h>
#include <stdio.h>

class KMMessage;
class KMFolderDir;
class FolderStorage;
class KMFolderJob;

namespace KMail {
   class AttachmentStrategy;
}
using KMail::AttachmentStrategy;

typedef QList<quint32> SerNumList;

class KMFolder: public KMFolderNode
{
  Q_OBJECT
  friend class ::KMFolderJob;
public:

  KMFolder( KMFolderDir* parent, const QString& name,
                KMFolderType aFolderType, bool withIndex = true,
                bool exportedSernums = true );
  ~KMFolder();

  bool isMainInbox() {
    return this == KMKernel::self()->inboxFolder();
  }
  bool isOutbox() {
    return this == KMKernel::self()->outboxFolder();
  }
  bool isSent() {
    return KMKernel::self()->folderIsSentMailFolder( this );
  }
  bool isTrash() {
    return KMKernel::self()->folderIsTrash( this );
  }
  bool isDrafts() {
    return KMKernel::self()->folderIsDrafts( this );
  }

  bool isTemplates() {
    return KMKernel::self()->folderIsTemplates( this );
  }

  void setAcctList( AccountList* list ) { mAcctList = list; }
  AccountList* acctList() { return mAcctList; }

  bool hasAccounts() const { return (mAcctList != 0); }

  void readConfig( KConfigGroup & config );

  void writeConfig( KConfigGroup & config ) const;

  FolderStorage* storage() { return mStorage; }
  const FolderStorage* storage() const { return mStorage; }

  KMFolderType folderType() const;

  QString fileName() const;

  QString location() const;

  virtual QString indexLocation() const;

  virtual QString idsLocation() const;

  virtual QString sortedLocation() const;

  QString subdirLocation() const;

  KMFolderDir* child() const
    { return mChild; }

  KMFolderDir* createChildFolder();

  void setChild( KMFolderDir* aChild );

  bool noContent() const;

  void setNoContent(bool aNoContent);

  bool noChildren() const;

  void setNoChildren(bool aNoChildren);

  KMMessage* getMsg(int idx);

  KMMsgInfo* unGetMsg(int idx);

  bool isMessage(int idx);

  DwString getDwString(int idx);

  void ignoreJobsForMessage( KMMessage* );

  FolderJob* createJob( KMMessage *msg, FolderJob::JobType jt = FolderJob::tGetMessage,
                        KMFolder *folder = 0, const QString &partSpecifier = QString(),
                        const AttachmentStrategy *as = 0 ) const;
  FolderJob* createJob( QList<KMMessage*>& msgList, const QString& sets,
                        FolderJob::JobType jt = FolderJob::tGetMessage,
                        KMFolder *folder = 0 ) const;

  const KMMsgBase* getMsgBase(int idx) const;
  KMMsgBase* getMsgBase(int idx);

  const KMMsgBase* operator[](int idx) const;

  KMMsgBase* operator[](int idx);

  KMMessage* take(int idx);
  void takeMessages(const QList<KMMessage*>& msgList);

  int addMsg(KMMessage* msg, int* index_return = 0);

  int addMsgKeepUID(KMMessage* msg, int* index_return = 0);

  int addMessages(QList<KMMessage*>&, QList<int>& index_return);

  void emitMsgAddedSignals(int idx);

  void removeMsg(int i, bool imapQuiet = false);
  void removeMessages(QList<KMMessage*> msgList, bool imapQuiet = false);

  int expungeOldMsg(int days);

  int moveMsg(KMMessage* msg, int* index_return = 0);
  int moveMsg(QList<KMMessage*>, int* index_return = 0);

  int find(const KMMsgBase* msg) const;
  int find( const KMMessage * msg ) const;

  int count(bool cache = false) const;

  int countUnread();

  int countUnreadRecursive();

  void msgStatusChanged( const MessageStatus& oldStatus,
                         const MessageStatus& newStatus,
                         int idx);

  int open( const char *owner );

  virtual bool canAccess() const;

  void close( const char *owner, bool force=false );

  void sync();

  bool isOpened() const;

  void markNewAsUnread();

  void markUnreadAsRead();

  void remove();

  int expunge();

  enum CompactOptions { CompactLater, CompactNow, CompactSilentlyNow };
  void compact( CompactOptions options );

  int rename(const QString& newName, KMFolderDir *aParent = 0);

  bool dirty() const;

  void setDirty(bool f);

  bool needsCompacting() const;
  void setNeedsCompacting(bool f);

  void quiet(bool beQuiet);

  bool isReadOnly() const;

  bool canDeleteMessages() const;

  bool isSystemFolder() const { return mIsSystemFolder; }
  void setSystemFolder(bool itIs) { mIsSystemFolder = itIs; }

  virtual QString label() const;
  void setLabel( const QString& l ) { mLabel = l; }

  virtual QString systemLabel() const { return mSystemLabel; }
  void setSystemLabel( const QString& l ) { mSystemLabel = l; }

  virtual QString prettyUrl() const;

  void setMailingListEnabled( bool enabled );
  bool isMailingListEnabled() const { return mMailingListEnabled; }

  void setMailingList( const MailingList& mlist );
  MailingList mailingList() const
  { return mMailingList; }
  QString mailingListPostAddress() const;

  void setUseDefaultIdentity( bool useDefaultIdentity );
  bool useDefaultIdentity() const { return mUseDefaultIdentity; }

  void setIdentity(uint identity);
  uint identity() const;

  QString whoField() const { return mWhoField; }
  void setWhoField(const QString& aWhoField);

  QString userWhoField(void) { return mUserWhoField; }
  void setUserWhoField(const QString &whoField,bool writeConfig=true);

  void correctUnreadMsgsCount();

  QString idString() const;

  void setAutoExpire(bool enabled);

  bool isAutoExpire() const { return mExpireMessages; }

  void setUnreadExpireAge(int age);

  void setUnreadExpireUnits(ExpireUnits units);

  void setReadExpireAge(int age);

  void setReadExpireUnits(ExpireUnits units);

  int getUnreadExpireAge() const { return mUnreadExpireAge; }

  int getReadExpireAge() const { return mReadExpireAge; }

  ExpireUnits getUnreadExpireUnits() const { return mUnreadExpireUnits; }

  ExpireUnits getReadExpireUnits() const { return mReadExpireUnits; }

  enum ExpireAction { ExpireDelete, ExpireMove };
  ExpireAction expireAction() const { return mExpireAction; }
  void setExpireAction( ExpireAction a );

  QString expireToFolderId() const { return mExpireToFolderId; }
  void setExpireToFolderId( const QString& id );

  void expireOldMessages( bool immediate );

  int writeIndex( bool createEmptyIndex = false );

  void setStatus(int idx, const MessageStatus& status, bool toggle=false);

  void setStatus(QList<int>& ids, const MessageStatus& status, bool toggle=false);

  bool useCustomIcons() const { return mUseCustomIcons; }
  void setUseCustomIcons(bool useCustomIcons) { mUseCustomIcons = useCustomIcons; }
  QString normalIconPath() const { return mNormalIconPath; }
  QString unreadIconPath() const { return mUnreadIconPath; }
  void setIconPaths(const QString &normalPath, const QString &unreadPath);

  void removeJobs();

  void daysToExpire( int& unreadDays, int& readDays );

  KMFolder* trashFolder() const;

  bool putRepliesInSameFolder() const { return mPutRepliesInSameFolder; }
  void setPutRepliesInSameFolder( bool b ) { mPutRepliesInSameFolder = b; }

  bool ignoreNewMail() const { return mIgnoreNewMail; }
  void setIgnoreNewMail( bool b ) { mIgnoreNewMail = b; }

  const KShortcut &shortcut() const { return mShortcut; }
  void setShortcut( const KShortcut& );

  bool isMoveable() const;

  bool moveInProgress() const { return mMoveInProgress; }

  void setMoveInProgress( bool b ) { mMoveInProgress = b; }

signals:
  void changed();

  void closed();

  void cleared();

  void expunged( KMFolder* );

  void iconsChanged();

  void nameChanged();

  void shortcutChanged( KMFolder * );

  void msgRemoved(KMFolder*, quint32 sernum);

  void msgRemoved( int idx, const QString& msgIdMD5 );
  void msgRemoved(KMFolder*);

  void msgAdded(int idx);
  void msgAdded(KMFolder*, quint32 sernum);

  void msgChanged(KMFolder*, quint32 sernum, int delta);

  void msgHeaderChanged(KMFolder*, int);

  void statusMsg(const QString&);

  void numUnreadMsgsChanged( KMFolder* );

  void removed(KMFolder*, bool);

  void viewConfigChanged();

  void folderSizeChanged( KMFolder * );

public slots:
  int updateIndex();

  void reallyAddMsg(KMMessage* aMsg);

  void reallyAddCopyOfMsg(KMMessage* aMsg);

private slots:

  void slotContentsTypeChanged( KMail::FolderContentsType type );

  void slotFolderSizeChanged();

  void slotIdentitiesChanged();

private:
  FolderStorage* mStorage;
  KMFolderDir* mChild;
  bool mIsSystemFolder;
  bool mHasIndex :1;
  bool mExportsSernums :1;
  bool mMoveInProgress :1;

  QString mLabel;
  QString mSystemLabel;

  bool         mExpireMessages;          // true if old messages are expired
  int          mUnreadExpireAge;         // Given in unreadExpireUnits
  int          mReadExpireAge;           // Given in readExpireUnits
  ExpireUnits  mUnreadExpireUnits;
  ExpireUnits  mReadExpireUnits;
  ExpireAction mExpireAction;
  QString      mExpireToFolderId;

  bool mUseCustomIcons;
  QString mNormalIconPath;
  QString mUnreadIconPath;

  bool                mMailingListEnabled;
  MailingList         mMailingList;

  AccountList* mAcctList;

  bool mUseDefaultIdentity;
  uint mIdentity;

  QString mWhoField, mUserWhoField;

  bool mPutRepliesInSameFolder;

  bool mIgnoreNewMail;

  KShortcut mShortcut;
};

class KMFolderOpener {
  KMFolder * mFolder;
  const char * const mOwner;
  int mOpenRc;

public:
  KMFolderOpener( KMFolder *folder, const char *owner )
   : mFolder( folder )
   , mOwner( owner )
  {
    assert( folder ); //change if that's not what you want
    mOpenRc = folder->open( owner );
  }

  ~KMFolderOpener()
  {
    if ( !mOpenRc )
      mFolder->close( mOwner );
  }

  KMFolder * folder() const { return mFolder; }
  
  int openResult() const { return mOpenRc; }
  
private:
  //we forbid construction on the heap as good as we can
  void * operator new( size_t size );
};

#endif /*kmfolder_h*/

kmail

Skip menu "kmail"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

kdepim

Skip menu "kdepim"

• akonadi
•   clients
•   kabc
•   kcal
•   kcm
• akregator
• console
•   kabcclient
•   konsolekalendar
• kaddressbook
• kalarm
•   lib
• kdgantt
• kdgantt1
• kjots
• kleopatra
• kmail
• kmobiletools
• knode
• knotes
• kontact
• kontactinterfaces
• korganizer
•   korgac
• kpilot
• ktimetracker
•   doc
• libkdepim
• libkholidays
• libkleo
• libkpgp
• maildir

Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal