/*
    Copyright (C) 2001-2002 by theKompany.com <www.thekompany.com>
    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    By PLUGINS we mean the commercial plug-ins developed by theKompany.com
    for Aethera.

    In addition, as a special exception, theKompany.com gives permission
    to link the code of this program with PLUGINS (or with
    modified versions of PLUGINS that use the same license as PLUGINS),
    and distribute linked combinations including the two.  You must obey
    the GNU General Public License in all respects for all of the code used
    other than PLUGINS.  If you modify this file, you may extend this
    exception to your version of the file, but you are not obligated to do so.
    If you do not wish to do so, delete this exception statement from your
    version.

    This license grants you the ability to use PLUGINS with Aethera only
    and may not be used outside of Aethera.
    See also http://www.thekompany.com/products/license.txt for details.
*/
/*
 * This file is part of Magellan <http://www.kAlliance.org/Magellan>
 *
 * Copyright (c) 1998-2000 Teodor Mihai <teddy@ireland.com>
 * Copyright (c) 1998-2000 Laur Ivan <laur.ivan@ul.ie>
 * Copyright (c) 1999-2000 Virgil Palanciuc <vv@ulise.cs.pub.ro>
 *
 * Requires the Qt widget libraries, available at no cost at
 * http://www.troll.no/
 *
 * Also requires the KDE libraries, available at no cost at
 * http://www.kde.org/
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef __IndexClass__
#define __IndexClass__

#include <qptrlist.h>

#include "aqmailglobal.h"

class MimePart;
class QDataStream;
class QString;
class MailFolder;

class AQMAIL_EXPORT IndexClass
{
    friend QDataStream& operator>>(QDataStream &, IndexClass &);
    friend QDataStream& operator<<(QDataStream &, IndexClass &);

public:

    IndexClass(MailFolder *parent, QString id=QString::null);
    IndexClass(const IndexClass &);
    ~IndexClass();

    QString url() const;

    QString getID() const;
    void setID(const QString &);

    QString getParentID() const;
    void setParentID(const QString &);

    QString getMessageID() const;
    void setMessageID(const QString &);

    bool getUnreadMark();
    void setUnreadMark(bool);

    MailFolder *getParentFolder() const;
    void setParentFolder(MailFolder *);

    /** Get the messages file name.*/
    QString getDataFilename() const;
    /** Get the descriptor file name.*/
    QString getDescriptorFileName() const;

    long getDescriptorOffset(void) const;
    void setDescriptorOffset(long);

    long getDescriptorLength(void) const;
    void setDescriptorLength(long);

    long getUniblockOffset() const;
    void setUniblockOffset(long, bool bParts=false);

    long getUniblockLength() const;
    void setUniblockLength(long);

    bool isMultipartOnly();
    void setMultipartOnly(bool);

    int getSize();

    int addPart(MimePart *, bool uniblockRelative=false);
    bool removePart(int);
    int getPartCount() const;
    MimePart *getPartAt(int);
    bool isFullMessage() const;

    bool isLocked();
    void lock()
    ;
    void unlock();

private:

    // disable the default constructor
    IndexClass();

    MailFolder *_parent;
    QString _id;
    QString _parentID;
    QString _messageID;
    Q_LONG _descriptorOffset;
    Q_LONG _descriptorLength;
    Q_LONG _uniblockOffset;
    Q_LONG _uniblockLength;
    QPtrList<MimePart> _partList;
    int _multipartOnly;
    int _unreadMark;

    bool _lock;
};

#endif