specialmailcollections.h

/*
    Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_SPECIALMAILCOLLECTIONS_H
#define AKONADI_SPECIALMAILCOLLECTIONS_H

#include "akonadi-kmime_export.h"

#include "akonadi/specialcollections.h"

namespace Akonadi {

class SpecialMailCollectionsPrivate;

class AKONADI_KMIME_EXPORT SpecialMailCollections : public SpecialCollections
{
    Q_OBJECT

public:
    enum Type {
        Invalid = -1,    
        Root = 0,        
        Inbox,           
        Outbox,          
        SentMail,        
        Trash,           
        Drafts,          
        Templates,       
        LastType         
    };

    static SpecialMailCollections *self();

    bool hasCollection(Type type, const AgentInstance &instance) const;

    Akonadi::Collection collection(Type type, const AgentInstance &instance) const;

    static Type specialCollectionType(const Akonadi::Collection &collection);

    bool registerCollection(Type type, const Akonadi::Collection &collection);

    bool unregisterCollection(const Collection &collection);

    bool hasDefaultCollection(Type type) const;

    Akonadi::Collection defaultCollection(Type type) const;

    void verifyI18nDefaultCollection(Type type);
private Q_SLOTS:
    void slotCollectionModified(KJob *job);
private:
    //@cond PRIVATE
    friend class SpecialMailCollectionsPrivate;

#if 1 // TODO do this only if building tests:
    friend class SpecialMailCollectionsTesting;
    friend class LocalFoldersTest;
#endif

    SpecialMailCollections(SpecialMailCollectionsPrivate *dd);

    SpecialMailCollectionsPrivate *const d;
    //@endcond
};

} // namespace Akonadi

#endif // AKONADI_SPECIALMAILCOLLECTIONS_H