net.fortuna.mstor
Interface MetaMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
MetaMessageImpl

public interface MetaMessage
extends Serializable

Implements additional metadata not supported by a MimeMessage.

Author:
benfortuna

Method Summary
 Flags getFlags()
           
 MetaFolder getFolder()
          Returns the meta folder this message belongs to.
 Date getForwarded()
           
 InternetHeaders getHeaders()
           
 int getMessageNumber()
          Returns the 1-based number of the message the metadata is associated with.
 Date getReceived()
           
 Date getReplied()
           
 boolean isExpunged()
           
 void setExpunged(boolean expunged)
           
 void setFlags(Flags flags)
           
 void setForwarded(Date forwarded)
           
 void setHeaders(Enumeration headers)
           
 void setHeaders(InternetHeaders headers)
          Saves headers to metadata.
 void setReceived(Date received)
           
 void setReplied(Date replied)
           
 

Method Detail

isExpunged

boolean isExpunged()
Returns:
Returns the expunged.

setExpunged

void setExpunged(boolean expunged)
Parameters:
expunged - The expunged to set.

getHeaders

InternetHeaders getHeaders()
Returns:
headers saved in metadata

setHeaders

void setHeaders(InternetHeaders headers)
Saves headers to metadata. Implementations may choose to only save a subset of the specified headers.

Parameters:
headers - headers to save to metadata

setHeaders

void setHeaders(Enumeration headers)

getFlags

Flags getFlags()
Returns:
Returns the flags.

setFlags

void setFlags(Flags flags)
Parameters:
flags - The flags to set.

getForwarded

Date getForwarded()
Returns:
Returns the forwarded.

setForwarded

void setForwarded(Date forwarded)
Parameters:
forwarded - The forwarded to set.

getMessageNumber

int getMessageNumber()
Returns the 1-based number of the message the metadata is associated with. If a message number is not set it is assumed the message does not belong to a folder and thus has a message number of zero (0).

Returns:
the message number associated with this metadata, or zero if no message number is identified

getReceived

Date getReceived()
Returns:
Returns the received.

setReceived

void setReceived(Date received)
Parameters:
received - The received to set.

getReplied

Date getReplied()
Returns:
Returns the replied.

setReplied

void setReplied(Date replied)
Parameters:
replied - The replied to set.

getFolder

MetaFolder getFolder()
Returns the meta folder this message belongs to.

Returns:
a meta folder