expirecollectionattribute.h

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-

  Copyright (c) 2011, 2012, 2013 Montel Laurent <montel@kde.org>

  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License, version 2, as
  published by the Free Software Foundation.

  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 MAILCOMMON_EXPIRECOLLECTIONATTRIBUTE_H
#define MAILCOMMON_EXPIRECOLLECTIONATTRIBUTE_H

#include "mailcommon_export.h"

#include <Akonadi/Attribute>
#include <Akonadi/Collection>

namespace MailCommon {

class MAILCOMMON_EXPORT ExpireCollectionAttribute : public Akonadi::Attribute
{
public:
    ExpireCollectionAttribute();

    /*
     * Define the possible units to use for measuring message expiry.
     * expireNever is used to switch off message expiry, and expireMaxUnits
     * must always be the last in the list (for bounds checking).
     */
    enum ExpireUnits {
        ExpireNever,
        ExpireDays,
        ExpireWeeks,
        ExpireMonths,
        ExpireMaxUnits
    };

    enum ExpireAction {
        ExpireDelete,
        ExpireMove
    };

    QByteArray type() const;
    Attribute *clone() const;
    QByteArray serialized() const;
    void deserialize( const QByteArray &data );

    static int daysToExpire( int number, ExpireCollectionAttribute::ExpireUnits units );

    static ExpireCollectionAttribute *expirationCollectionAttribute(
            const Akonadi::Collection &collection, bool &mustDeleteExpirationAttribute );

    void loadFromConfig( const Akonadi::Collection &collection );

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

    void setAutoExpire( bool enabled );

    bool isAutoExpire() const;

    void setUnreadExpireAge( int age );

    void setUnreadExpireUnits( ExpireUnits units );

    void setReadExpireAge( int age );

    void setReadExpireUnits( ExpireUnits units );

    int unreadExpireAge() const;

    int readExpireAge() const;

    ExpireAction expireAction() const;
    void setExpireAction( ExpireAction a );

    Akonadi::Collection::Id expireToFolderId() const;
    void setExpireToFolderId( Akonadi::Collection::Id id );

    ExpireUnits unreadExpireUnits() const;

    ExpireUnits readExpireUnits() const;

private:
    bool mExpireMessages;         // true if old messages are expired
    int mUnreadExpireAge;         // Given in unreadExpireUnits
    int mReadExpireAge;           // Given in readExpireUnits
    ExpireCollectionAttribute::ExpireUnits  mUnreadExpireUnits;
    ExpireCollectionAttribute::ExpireUnits  mReadExpireUnits;
    ExpireCollectionAttribute::ExpireAction mExpireAction;
    Akonadi::Collection::Id mExpireToFolderId;
};

}
#endif /* EXPIRATIONCOLLECTIONATTRIBUTE_H */