/*
    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.
*/
/***************************************************************************
                uidjar.h  -  the UID jar interface class 
                             -------------------
    begin                : Wed Mar 14 19:02:00 EET 2001
    copyright            : (C) 2001 by theKompany (www.thekompany.com>
    author               : Eugen Constantinescu
    email                : eug@thekompany.com
 ***************************************************************************/

#ifndef __UIDJar__
#define __UIDJar__

#include <string>
#include <map>
#include <fstream>

using namespace std;

/** The data format we need in UID list.*/
typedef struct uidInfo
{
  /** 
    * The string information we need.
    * Ex: IMAP is using it for storing the message url.
    */
  string info;
  /** The receiving time.*/
  unsigned int rcvTime;
} UIDINFO;

typedef map<string, UIDINFO, less<string> > UIDMap;
typedef UIDMap::value_type  UIDValuePair;

/** 
  * The UID list class.
  * It is an interface for POP3 and IMAP4 UIDJar classes.
  */
class UIDJar
{
	public:
		UIDJar();
		virtual ~UIDJar();
		
		/** Load the UID map from the file.*/
		void loadLists();
		/** Save the UID map into the file.*/
		void saveLists();
		
		/** The receiving UID list.*/
		UIDMap rcvList;
		/** The UID list marked for deletion.*/
		UIDMap trashList;
		
	protected:
	  /** Setup the files name.*/
	  virtual void setupFiles() = 0;
	  
	  /** The file name of receiving UID.*/
		string rcvFileName;
		/** The file name of deleting UID.*/
		string delFileName;
		/** UID limited number.*/
		static const int UID_LIMIT;
};

#endif