mbox.h

/*
    Copyright (c) 2009 Bertjan Broeksema <broeksema@kde.org>

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

#include "kmbox_export.h"
#include "mboxentry.h"

#include <kmime/kmime_message.h>

namespace KMBox {

class MBoxPrivate;

class KMBOX_EXPORT MBox
{
  public:
    enum LockType {
      ProcmailLockfile,
      MuttDotlock,
      MuttDotlockPrivileged,
      None
    };

    MBox();

    ~MBox();

    MBoxEntry appendMessage( const KMime::Message::Ptr &message );

    MBoxEntry::List entries( const MBoxEntry::List &deletedEntries = MBoxEntry::List() ) const;

    QString fileName() const;

    bool load( const QString &fileName );

    bool lock();

    bool locked() const;

    bool purge( const MBoxEntry::List &deletedEntries, QList<MBoxEntry::Pair> *movedEntries = 0 );

    KMime::Message *readMessage( const MBoxEntry &entry );

    QByteArray readMessageHeaders( const MBoxEntry &entry );

    QByteArray readRawMessage( const MBoxEntry &entry );

    bool save( const QString &fileName = QString() );

    bool setLockType( LockType ltype );

    void setLockFile( const QString &lockFile );

    void setUnlockTimeout( int msec );

    bool unlock();

    void setReadOnly(bool ro = true);

    bool isReadOnly() const;

  private:
    //@cond PRIVATE
    friend class MBoxPrivate;
    MBoxPrivate * const d;
    //@endcond
};

}

#endif // KMBOX_MBOX_H