mailcommon/foldercollection.h

   1 /*
   2   Copyright (c) 2009 Montel Laurent <montel@kde.org>
   3
   4   This program is free software; you can redistribute it and/or modify it
   5   under the terms of the GNU General Public License, version 2, as
   6   published by the Free Software Foundation.
   7
   8   This program is distributed in the hope that it will be useful, but
   9   WITHOUT ANY WARRANTY; without even the implied warranty of
  10   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11   General Public License for more details.
  12
  13   You should have received a copy of the GNU General Public License along
  14   with this program; if not, write to the Free Software Foundation, Inc.,
  15   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  16 */
  17
  18 #ifndef MAILCOMMON_FOLDERCOLLECTION_H
  19 #define MAILCOMMON_FOLDERCOLLECTION_H
  20
  21 #include "mailcommon_export.h"
  22
  23 #include <messagecore/mailinglist.h>
  24 using MessageCore::MailingList;
  25
  26 #include <Akonadi/Collection>
  27 #include <Akonadi/CollectionStatistics>
  28
  29 #include <KSharedConfig>
  30 #include <KShortcut>
  31 #include <KIO/Job>
  32
  33 namespace MailCommon {
  34
  35 class MAILCOMMON_EXPORT FolderCollection : public QObject
  36 {
  37   Q_OBJECT
  38
  39   public:
  40     static QSharedPointer<FolderCollection> forCollection(
  41       const Akonadi::Collection &coll, bool writeConfig = true );
  42
  43     ~FolderCollection();
  44
  45     Akonadi::Collection collection() const;
  46     void setCollection( const Akonadi::Collection &collection );
  47
  48     static QString configGroupName( const Akonadi::Collection &col );
  49     static void clearCache();
  50
  51     bool isWriteConfig() const;
  52     void setWriteConfig( bool writeConfig );
  53
  54     void writeConfig() const;
  55     void readConfig();
  56
  57     QString name() const;
  58
  59     bool isReadOnly() const;
  60
  61     bool isStructural() const;
  62
  63     bool isSystemFolder() const;
  64
  65     qint64 count() const;
  66
  67     bool canDeleteMessages() const;
  68
  69     bool canCreateMessages() const;
  70
  71     bool isValid() const;
  72
  73     Akonadi::Collection::Rights rights() const;
  74
  75     Akonadi::CollectionStatistics statistics() const;
  76
  77     void setShortcut( const KShortcut & );
  78     const KShortcut &shortcut() const
  79     {
  80       return mShortcut;
  81     }
  82
  83     /**
  84      *  Get / set whether the default identity should be used instead of the
  85      *  identity specified by setIdentity().
  86      */
  87     void setUseDefaultIdentity( bool useDefaultIdentity );
  88     bool useDefaultIdentity() const
  89     {
  90       return mUseDefaultIdentity;
  91     }
  92
  93     void setIdentity( uint identity );
  94     uint identity() const;
  95
  96     /**
  97      * Returns true if this folder is associated with a mailing-list.
  98      */
  99     void setMailingListEnabled( bool enabled );
 100     bool isMailingListEnabled() const
 101     {
 102       return mMailingListEnabled;
 103     }
 104
 105     void setMailingList( const MailingList &mlist );
 106
 107     MailingList mailingList() const
 108     {
 109       return mMailingList;
 110     }
 111
 112     /**
 113      * Returns true if the replies to mails from this folder should be
 114      * put in the same folder.
 115      */
 116     bool putRepliesInSameFolder() const
 117     {
 118       return mPutRepliesInSameFolder;
 119     }
 120     void setPutRepliesInSameFolder( bool b )
 121     {
 122       mPutRepliesInSameFolder = b;
 123     }
 124
 125     /**
 126      * Returns true if this folder should be hidden from all folder selection dialogs
 127      */
 128     bool hideInSelectionDialog() const
 129     {
 130       return mHideInSelectionDialog;
 131     }
 132     void setHideInSelectionDialog( bool hide )
 133     {
 134       mHideInSelectionDialog = hide;
 135     }
 136
 137     /**
 138      * Returns true if the user doesn't want to get notified about new mail
 139      * in this folder.
 140      */
 141     bool ignoreNewMail() const
 142     {
 143       return mIgnoreNewMail;
 144     }
 145     void setIgnoreNewMail( bool b )
 146     {
 147       mIgnoreNewMail = b;
 148     }
 149
 150     QString mailingListPostAddress() const;
 151
 152   protected slots:
 153     void slotIdentitiesChanged();
 154
 155   private:
 156     explicit FolderCollection( const Akonadi::Collection &col, bool writeconfig );
 157
 158     Akonadi::Collection mCollection;
 159
 160     /** Mailing list attributes */
 161     bool                mMailingListEnabled;
 162     MailingList         mMailingList;
 163
 164     bool mUseDefaultIdentity;
 165     uint mIdentity;
 166
 167     /** Should new mail in this folder be ignored? */
 168     bool mIgnoreNewMail;
 169
 170     /** Should replies to messages in this folder be put in here? */
 171     bool mPutRepliesInSameFolder;
 172
 173     /** Should this folder be hidden in the folder selection dialog? */
 174     bool mHideInSelectionDialog;
 175
 176     /** shortcut associated with this folder or null, if none is configured. */
 177     KShortcut mShortcut;
 178     bool mWriteConfig;
 179
 180     bool mOldIgnoreNewMail;
 181 };
 182
 183 }
 184
 185 #endif