//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002-2006 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.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_NET_MESSAGE_HPP_INCLUDED
#define VMIME_NET_MESSAGE_HPP_INCLUDED
#include "vmime/header.hpp"
#include "vmime/mediaType.hpp"
#include "vmime/utility/progressListener.hpp"
#include "vmime/utility/stream.hpp"
namespace vmime {
namespace net {
class structure;
/** A MIME part in a message.
*/
class part : public object
{
protected:
part() { }
part(const part&) : object() { }
virtual ~part() { }
public:
/** Return the structure of this part.
*
* @return structure of the part
*/
virtual ref <const structure> getStructure() const = 0;
/** Return the structure of this part.
*
* @return structure of the part
*/
virtual ref <structure> getStructure() = 0;
/** Return the header section for this part (you must fetch header
* before using this function: see message::fetchPartHeader).
*
* @return header section
*/
virtual ref <const header> getHeader() const = 0;
/** Return the media-type of the content in this part.
*
* @return content media type
*/
virtual const mediaType& getType() const = 0;
/** Return the size of this part.
*
* @return size of the part (in bytes)
*/
virtual const int getSize() const = 0;
/** Return the part sequence number (index).
* The first part is at index zero.
*
* @return part number
*/
virtual const int getNumber() const = 0;
/** Return the sub-part at the specified position (zero is the
* first part).
*
* @param pos index of the sub-part
* @return sub-part at position 'pos'
*/
ref <const part> getPartAt(const int pos) const;
/** Return the sub-part at the specified position (zero is the
* first part).
*
* @param pos index of the sub-part
* @return sub-part at position 'pos'
*/
ref <part> getPartAt(const int pos);
/** Return the number of sub-parts in this part.
*
* @return number of sub-parts
*/
const int getPartCount() const;
};
/** Structure of a MIME part/message.
*/
class structure : public object
{
protected:
structure() { }
structure(const structure&) : object() { }
public:
virtual ~structure() { }
/** Return the part at the specified position (first
* part is at position 0).
*
* @param pos position
* @return part at position 'pos'
*/
virtual ref <const part> getPartAt(const int pos) const = 0;
/** Return the part at the specified position (first
* part is at position 0).
*
* @param pos position
* @return part at position 'pos'
*/
virtual ref <part> getPartAt(const int pos) = 0;
/** Return the number of parts in this part.
*
* @return number of parts
*/
virtual const int getPartCount() const = 0;
};
/** Abstract representation of a message in a store/transport service.
*/
class message : public object
{
protected:
message() { }
message(const message&) : object() { }
public:
virtual ~message() { }
/** The type for an unique message identifier.
*/
typedef string uid;
/** Return the MIME structure of the message (must fetch before).
*
* @return MIME structure of the message
*/
virtual ref <const structure> getStructure() const = 0;
/** Return the MIME structure of the message (must fetch before).
*
* @return MIME structure of the message
*/
virtual ref <structure> getStructure() = 0;
/** Return a reference to the header fields of the message (must fetch before).
*
* @return header section of the message
*/
virtual ref <const header> getHeader() const = 0;
/** Return the sequence number of this message. This number is
* used to reference the message in the folder.
*
* @return sequence number of the message
*/
virtual const int getNumber() const = 0;
/** Return the unique identified of this message (must fetch before).
*
* @return UID of the message
*/
virtual const uid getUniqueId() const = 0;
/** Return the size of the message (must fetch before).
*
* @return size of the message (in bytes)
*/
virtual const int getSize() const = 0;
/** Check whether this message has been expunged
* (ie: definitively deleted).
*
* @return true if the message is expunged, false otherwise
*/
virtual const bool isExpunged() const = 0;
/** Possible flags for a message.
*/
enum Flags
{
FLAG_SEEN = (1 << 0), /**< Message has been seen. */
FLAG_RECENT = (1 << 1), /**< Message has been recently received. */
FLAG_DELETED = (1 << 2), /**< Message is marked for deletion. */
FLAG_REPLIED = (1 << 3), /**< User replied to this message. */
FLAG_MARKED = (1 << 4), /**< Used-defined flag. */
FLAG_PASSED = (1 << 5), /**< Message has been resent/forwarded/bounced. */
FLAG_UNDEFINED = 9999 /**< Used internally (this should not be returned
by the flags() function). */
};
/** Methods for setting the flags.
*/
enum FlagsModes
{
FLAG_MODE_SET, /**< Set (replace) the flags. */
FLAG_MODE_ADD, /**< Add the flags. */
FLAG_MODE_REMOVE /**< Remove the flags. */
};
/** Return the flags of this message.
*
* @return flags of the message
*/
virtual const int getFlags() const = 0;
/** Set the flags of this message.
*
* @param flags set of flags (see Flags)
* @param mode indicate how to treat old and new flags (see FlagsModes)
*/
virtual void setFlags(const int flags, const int mode = FLAG_MODE_SET) = 0;
/** Extract the whole message data (header + contents).
*
* \warning Partial fetch might not be supported by the underlying protocol.
*
* @param os output stream in which to write message data
* @param progress progress listener, or NULL if not used
* @param start index of the first byte to retrieve (used for partial fetch)
* @param length number of bytes to retrieve (used for partial fetch)
* @param peek if true, try not to mark the message as read. This may not
* be supported by the protocol (IMAP supports this), but it will NOT throw
* an exception if not supported.
*/
virtual void extract(utility::outputStream& os, utility::progressListener* progress = NULL, const int start = 0, const int length = -1, const bool peek = false) const = 0;
/** Extract the specified MIME part of the message (header + contents).
*
* \warning Partial fetch might not be supported by the underlying protocol.
*
* @param p part to extract
* @param os output stream in which to write part data
* @param progress progress listener, or NULL if not used
* @param start index of the first byte to retrieve (used for partial fetch)
* @param length number of bytes to retrieve (used for partial fetch)
* @param peek if true, try not to mark the message as read. This may not
* be supported by the protocol (IMAP supports this), but it will NOT throw
* an exception if not supported.
*/
virtual void extractPart(ref <const part> p, utility::outputStream& os, utility::progressListener* progress = NULL, const int start = 0, const int length = -1, const bool peek = false) const = 0;
/** Fetch the MIME header for the specified part.
*
* @param p the part for which to fetch the header
*/
virtual void fetchPartHeader(ref <part> p) = 0;
};
} // net
} // vmime
#endif // VMIME_NET_MESSAGE_HPP_INCLUDED
syntax highlighted by Code2HTML, v. 0.9.1