vmime/src/messaging/IMAPFolder.hpp

//
// VMime library (http://vmime.sourceforge.net)
// Copyright (C) 2002-2004 Vincent Richard <vincent@vincent-richard.net>
//
// 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., 675 Mass Ave, Cambridge, MA 02139, USA.
//

#ifndef VMIME_MESSAGING_IMAPFOLDER_HPP_INCLUDED
#define VMIME_MESSAGING_IMAPFOLDER_HPP_INCLUDED


#include <vector>
#include <map>

#include "../types.hpp"
#include "folder.hpp"


namespace vmime {
namespace messaging {


class IMAPStore;
class IMAPMessage;
class IMAPConnection;


/** IMAP folder implementation.
  */

class IMAPFolder : public folder
{
protected:

	friend class IMAPStore;
	friend class IMAPMessage;


	IMAPFolder(const folder::path& path, IMAPStore* store, const int type = TYPE_UNDEFINED, const int flags = FLAG_UNDEFINED);
	IMAPFolder(const IMAPFolder&) : folder() { }

	~IMAPFolder();

public:

	const int mode() const;

	const int type();

	const int flags();

	const folder::path::component name() const;
	const folder::path fullPath() const;

	void open(const int mode, bool failIfModeIsNotAvailable = false);
	void close(const bool expunge);
	void create(const int type);

	const bool exists();

	const bool isOpen() const;

	message* getMessage(const int num);
	std::vector <message*> getMessages(const int from = 1, const int to = -1);
	std::vector <message*> getMessages(const std::vector <int>& nums);
	const int getMessageCount();

	folder* getFolder(const folder::path::component& name);
	std::vector <folder*> getFolders(const bool recursive = false);

	void rename(const folder::path& newPath);

	void deleteMessage(const int num);
	void deleteMessages(const int from = 1, const int to = -1);
	void deleteMessages(const std::vector <int>& nums);

	void setMessageFlags(const int from, const int to, const int flags, const int mode = message::FLAG_MODE_SET);
	void setMessageFlags(const std::vector <int>& nums, const int flags, const int mode = message::FLAG_MODE_SET);

	void addMessage(vmime::message* msg, const int flags = message::FLAG_UNDEFINED, vmime::datetime* date = NULL, progressionListener* progress = NULL);
	void addMessage(utility::inputStream& is, const int size, const int flags = message::FLAG_UNDEFINED, vmime::datetime* date = NULL, progressionListener* progress = NULL);

	void copyMessage(const folder::path& dest, const int num);
	void copyMessages(const folder::path& dest, const int from = 1, const int to = -1);
	void copyMessages(const folder::path& dest, const std::vector <int>& nums);

	void status(int& count, int& unseen);

	void expunge();

	folder* getParent();

	const class store& store() const;
	class store& store();


	void fetchMessages(std::vector <message*>& msg, const int options, progressionListener* progress = NULL);
	void fetchMessage(message* msg, const int options);

	const int getFetchCapabilities() const;

private:

	void registerMessage(IMAPMessage* msg);
	void unregisterMessage(IMAPMessage* msg);

	void onStoreDisconnected();

	void onClose();

	const int testExistAndGetType();

	void setMessageFlags(const string& set, const int flags, const int mode);

	void copyMessages(const string& set, const folder::path& dest);


	IMAPStore* m_store;
	IMAPConnection* m_connection;

	folder::path m_path;
	folder::path::component m_name;

	int m_mode;
	bool m_open;

	int m_type;
	int m_flags;

	int m_messageCount;

	int m_uidValidity;

	std::vector <IMAPMessage*> m_messages;
};


} // messaging
} // vmime


#endif // VMIME_MESSAGING_IMAPFOLDER_HPP_INCLUDED