org.apache.james.mailbox.maildir.mail.model

Class MaildirMessage

java.lang.Object

org.apache.james.mailbox.store.mail.model.AbstractMessage<Integer>

org.apache.james.mailbox.maildir.mail.model.MaildirMessage

All Implemented Interfaces:

Comparable<Message<Integer>>, Message<Integer>

public class MaildirMessage
extends AbstractMessage<Integer>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	newMessage

Constructor Summary

Constructors

Constructor and Description
MaildirMessage(Mailbox<Integer> mailbox, long uid, MaildirMessageName messageName)

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getBodyContent() Gets the body content of the document.
protected int	getBodyStartOctet() Return the start octet of the body
InputStream	getFullContent() Return the full content of the message via a FileInputStream
long	getFullContentOctets() The number of octets contained in the full content of this document.
InputStream	getHeaderContent() Gets the header as InputStream.
Date	getInternalDate()
Integer	getMailboxId() Return the mailbox id of the linked mailbox
String	getMediaType() Gets the top level MIME content media type.
long	getModSeq() Return the mod-sequence for the message
List<Property>	getProperties() Gets a read-only list of meta-data properties.
String	getSubType() Gets the MIME content subtype.
Long	getTextualLineCount() Gets the number of CRLF in a textual document.
long	getUid() Return the uid
boolean	isAnswered() Return if it was marked as answered
boolean	isDeleted() Return if it was mark as deleted
boolean	isDraft() Return if it was mark as draft
boolean	isFlagged() Return if it was flagged
boolean	isNew() Indicates whether this MaildirMessage reflects a new message or one that already exists in the file system.
boolean	isRecent() Return if it was marked as recent
boolean	isSeen() Return if it was marked as seen
void	setFlags(javax.mail.Flags flags) Set the Flags
void	setModSeq(long modSeq) Set the mod-sequence for the message.
void	setUid(long uid) Set the uid for the message.
String	toString()

Methods inherited from class org.apache.james.mailbox.store.mail.model.AbstractMessage

compareTo, createFlags, createUserFlags, getBodyOctets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

newMessage

protected boolean newMessage

Constructor Detail

MaildirMessage

public MaildirMessage(Mailbox<Integer> mailbox,
              long uid,
              MaildirMessageName messageName)
               throws IOException

Throws:

IOException

Method Detail

getMailboxId

public Integer getMailboxId()

Description copied from interface: Message

Return the mailbox id of the linked mailbox

Returns:

mailboxId

getUid

public long getUid()

Description copied from interface: Message

Return the uid

Returns:

uid

setUid

public void setUid(long uid)

Description copied from interface: Message

Set the uid for the message. This must be called before the message is added to the store and must be unique / sequential.

setFlags

public void setFlags(javax.mail.Flags flags)

Description copied from interface: Message

Set the Flags

See Also:

Message.setFlags( javax.mail.Flags)

isAnswered

public boolean isAnswered()

Description copied from interface: Message

Return if it was marked as answered

Returns:

answered

See Also:

Message.isAnswered()

isDeleted

public boolean isDeleted()

Description copied from interface: Message

Return if it was mark as deleted

Returns:

deleted

See Also:

Message.isDeleted()

isDraft

public boolean isDraft()

Description copied from interface: Message

Return if it was mark as draft

Returns:

draft

See Also:

Message.isDraft()

isFlagged

public boolean isFlagged()

Description copied from interface: Message

Return if it was flagged

Returns:

flagged

See Also:

Message.isFlagged()

isRecent

public boolean isRecent()

Description copied from interface: Message

Return if it was marked as recent

Returns:

recent

See Also:

Message.isRecent()

isSeen

public boolean isSeen()

Description copied from interface: Message

Return if it was marked as seen

Returns:

seen

See Also:

Message.isSeen()

isNew

public boolean isNew()

Indicates whether this MaildirMessage reflects a new message or one that already exists in the file system.

Returns:

true if it is new, false if it already exists

toString

public String toString()

Overrides:

toString in class Object

getModSeq

public long getModSeq()

Description copied from interface: Message

Return the mod-sequence for the message

Returns:

message

See Also:

Message.getModSeq()

setModSeq

public void setModSeq(long modSeq)

Description copied from interface: Message

Set the mod-sequence for the message. This must be called before the message is added to the store or any flags are changed. This must be unique / sequential.

See Also:

Message.setModSeq(long)

getMediaType

public String getMediaType()

Description copied from interface: Message

Gets the top level MIME content media type.

Returns:

top level MIME content media type, or null if default

See Also:

Message.getMediaType()

getSubType

public String getSubType()

Description copied from interface: Message

Gets the MIME content subtype.

Returns:

the MIME content subtype, or null if default

See Also:

Message.getSubType()

getFullContentOctets

public long getFullContentOctets()

Description copied from interface: Message

The number of octets contained in the full content of this document.

Returns:

number of octets

See Also:

Message.getFullContentOctets()

getTextualLineCount

public Long getTextualLineCount()

Description copied from interface: Message

Gets the number of CRLF in a textual document.

Returns:

CRLF count when document is textual, null otherwise

See Also:

Message.getTextualLineCount()

getProperties

public List<Property> getProperties()

Description copied from interface: Message

Gets a read-only list of meta-data properties. For properties with multiple values, this list will contain several enteries with the same namespace and local name.

Returns:

unmodifiable list of meta-data, not null

See Also:

Message.getProperties()

getInternalDate

public Date getInternalDate()

See Also:

Message.getInternalDate()

getFullContent

public InputStream getFullContent()
                           throws IOException

Return the full content of the message via a FileInputStream

Specified by:

getFullContent in interface Message<Integer>

Overrides:

getFullContent in class AbstractMessage<Integer>

Returns:

content

Throws:

IOException

getBodyContent

public InputStream getBodyContent()
                           throws IOException

Description copied from interface: Message

Gets the body content of the document. Headers are excluded. Be aware that this method need to return a new fresh InputStream on every call, which basicly means it need to start at position 0

Returns:

body, not null

Throws:

IOException

See Also:

Message.getBodyContent()

getBodyStartOctet

protected int getBodyStartOctet()

Description copied from class: AbstractMessage

Return the start octet of the body

Specified by:

getBodyStartOctet in class AbstractMessage<Integer>

Returns:

startOctet

See Also:

AbstractMessage.getBodyStartOctet()

getHeaderContent

public InputStream getHeaderContent()
                             throws IOException

Description copied from interface: Message

Gets the header as InputStream. This MUST INCLUDE the CRLF terminator Be aware that this method need to return a new fresh InputStream on every call

Returns:

header

Throws:

IOException