src/flmail/mailfolder.h

Ir a la documentación de este archivo.

/*
    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.
*/
/***************************************************************************
                          mailfolder.h  -  the mail folder interface
                             -------------------
    begin                : Mon Mar  5 16:16:00 EET 2001
    copyright            : (C) 2001 by theKompany (www.thekompany.com>
    author               : Eugen Constantinescu
    email                : eug@thekompany.com
 ***************************************************************************/

#ifndef MAILFOLDER_H
#define MAILFOLDER_H

#include <qstring.h>
#include <qcstring.h>
#include <qdir.h>
#include <messageclass.h>
#include <qstringlist.h>
#include <qdict.h>
#include <qptrlist.h>
#include <qmap.h>
#include <qdatetime.h>

class MessageDevice;
class IndexClass;

class MailFolder
{
    friend class IndexClass;
public:
    enum MESSAGES_PLACE {LOCAL=0, REMOTE};
    enum PROTOCOL {MBOX=0, POP3, IMAP4};
    enum TYPES {Normal=100, Deleted, Drafts, Inbox, Outbox, Sent, Templates};
    enum ACCESS_RIGHTS {DENIED=0, WRITE_ONLY=1, READ_ONLY=2, ALL=4};

    enum IMAP4_FLAGS {NO_FLAGS=0, Seen=1, Answered=2, Flagged=4, Draft=8, Recent=16, Delete=32, Other=64};

    MailFolder(const QString &_storageDevice);
    virtual ~MailFolder();

    // Index management
    void saveIndex(IndexClass *);
    void saveIndex();
    QDict<IndexClass>& indexIDict();
    static QString nextIndexID();
    unsigned long getLastIndexID() const;

    // Attribute public methods
    QString getStorageDevice() const;
    QString name() const;
    virtual QString getMessagesFileName() const=0;
    QString getIndexFileName() const;
    QString getDescriptorFileName() const;
    int getFolderType() const;
    int getFolderProtocol() const;
    int getMessagesPlace() const;
    int getAccessRights() const;
    void setAccessRights(int access);
    static void setAutoExpunge(bool expunge=true);
    bool getAutoExpunge() const;

    int getMessageCount() const;
    int getUnread() const;
    unsigned int getPruneIndexCount() const;

    // Add and delete messages from the folder.
    virtual QString createMessage(const QCString &text, const QCString &uid,
                                  const QDateTime &rcvtime, const QString &account,
                                  const MessageClass *parsedMessage = 0, // parsed message, added to avoid parsing second time
                                  bool bSync=false, const unsigned flags=0)=0;

    virtual QString createMessage();

    virtual bool deleteMessage(IndexClass *idx)=0;
    virtual QString copyMessage(IndexClass *idx)=0;
    virtual QString moveMessage(IndexClass *idx)=0;

    virtual bool expunge(bool force)=0;

    virtual bool moveMessage(const QStringList & urls)=0;
    virtual bool copyMessage(const QStringList & urls)=0;
    virtual bool deleteMessage(const QStringList & urls)=0;

    virtual bool compact(unsigned level=0);

    QMap<QString, QByteArray> entryCacheBlock();

    void incrementUnread();
    void decrementUnread();
    void setUnread(int _unread=0);
    QStringList getEntryList(const QString url=QString::null) const;
    virtual void sync()=0;

protected:
    // Internal protected methods
    void setupFiles();
    virtual bool shouldExpunge()=0;

    // Index methods
    virtual void loadIndex()=0;
    void crossReferenceIndex(IndexClass *);
    void crossReferenceIndexSet(IndexClass *);
    void reparentIndex(IndexClass *);
    bool reparentByRelated(IndexClass *);
    bool reparentBySubject(IndexClass *);
    static IndexClass *findIndex(const QString &);
    void setPruneIndexCount(unsigned int _pruneIndexCount=0);
    void incrementPruneIndexCount();
    void setLastIndexID(long unsigned _lastIndexId);
    void syncIndexID(IndexClass *);

    bool subjectThreadMatch(QString parentSubject, QString sonSubject);
    static QString translateGlobalMessageID(QString);
    QString translateLocalMessageID(QString);

    // Protected attributes
    QDict<IndexClass> indexCollection;
    unsigned int pruneIndexCount;
    QPtrList<MessageDevice> syncMessages;

private:
    // ---------- Private Attributes -------------
    // global data
    static QPtrList<MailFolder> folderList;
    static bool autoExpunge;
    static long unsigned lastIndexID;

    // files attributes
    QString storageDevice;
    QString indexFileName;
    QString descriptorFileName;
    int folderType;
    int folderProtocol;
    int messagesPlace;
    int accessRights;

    unsigned int unread;
};

#endif