mailfilter.h

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-
 * 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 MAILCOMMON_MAILFILTER_H
#define MAILCOMMON_MAILFILTER_H

#include "../mailcommon_export.h"

#include "filteractions/filteraction.h"
#include "../search/searchpattern.h"

#include <kshortcut.h>
#include <akonadi/collection.h>

#include <kmime/kmime_message.h>

#include <QtCore/QDataStream>

class KConfigGroup;

namespace MailCommon {

// maximum number of filter actions per filter
const int FILTER_MAX_ACTIONS = 8;

class MAILCOMMON_EXPORT MailFilter
{
    friend MAILCOMMON_EXPORT QDataStream& operator<<( QDataStream &stream, const MailFilter &filter );
    friend MAILCOMMON_EXPORT QDataStream& operator>>( QDataStream &stream, MailFilter &filter );

public:
    enum ReturnCode { NoResult, GoOn, CriticalError };

    enum AccountType { All, ButImap, Checked };

    MailFilter();

    explicit MailFilter( const KConfigGroup & aConfig, bool internal, bool & needUpdate );

    MailFilter( const MailFilter & other );

    ~MailFilter();

    void generateRandomIdentifier();

    QString identifier() const;

    QString name() const;

    ReturnCode execActions(ItemContext &context, bool& stopIt , bool applyOnOutbound) const ;

    SearchRule::RequiredPart requiredPart(const QString& id) const;

    void writeConfig( KConfigGroup& config, bool exportFilter ) const;

    bool readConfig( const KConfigGroup& config, bool interactive = false );

    QString purify(bool removeAction = true);

    bool isEmpty() const;

    QList<FilterAction*>* actions();

    const QList<FilterAction*>* actions() const;

    SearchPattern* pattern();

    const SearchPattern* pattern() const;

    void setApplyOnOutbound( bool aApply = true );

    void setApplyBeforeOutbound( bool aApply = true );

    bool applyOnOutbound() const;

    bool applyBeforeOutbound() const;

    void setApplyOnInbound( bool aApply = true );

    bool applyOnInbound() const;

    void setApplyOnExplicit( bool aApply = true );

    bool applyOnExplicit() const;

    void setApplicability( AccountType aApply = All );

    AccountType applicability() const;

    void setApplyOnAccount( const QString& id, bool aApply = true );

    bool applyOnAccount( const QString &id ) const;

    void setStopProcessingHere( bool aStop );
    bool stopProcessingHere() const;

    void setConfigureShortcut( bool aShort );

    bool configureShortcut() const;

    void setConfigureToolbar( bool aTool );

    bool configureToolbar() const;

    QString toolbarName() const;

    void setToolbarName( const QString &toolbarName );

    void setShortcut( const KShortcut &shortcut );

    const KShortcut & shortcut() const;

    void setIcon( const QString &icon );

    QString icon() const;

    void folderRemoved( const Akonadi::Collection& aFolder, const Akonadi::Collection& aNewFolder );

    const QString asString() const;

    void setAutoNaming( bool useAutomaticNames );

    bool isAutoNaming() const;

    bool isEnabled() const;
    void setEnabled( bool );

    void generateSieveScript(QStringList &requires, QString &code);

private:
    QString mIdentifier;
    SearchPattern mPattern;
    QList<FilterAction*> mActions;
    QStringList mAccounts;
    QString mIcon;
    QString mToolbarName;
    KShortcut mShortcut;
    bool bApplyOnInbound : 1;
    bool bApplyBeforeOutbound : 1;
    bool bApplyOnOutbound : 1;
    bool bApplyOnExplicit : 1;
    bool bStopProcessingHere : 1;
    bool bConfigureShortcut : 1;
    bool bConfigureToolbar : 1;
    bool bAutoNaming : 1;
    bool bEnabled : 1;
    AccountType mApplicability;
};

MAILCOMMON_EXPORT QDataStream& operator<<( QDataStream &stream, const MailFilter &filter );
MAILCOMMON_EXPORT QDataStream& operator>>( QDataStream &stream, MailFilter &filter );

}

#endif /*MAILCOMMON_MAILFILTER_H*/