com.openexchange.mail.dataobjects
Class MailMessage

java.lang.Object
  com.openexchange.mail.dataobjects.MailPart
      com.openexchange.mail.dataobjects.MailMessage

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ComposedMailMessage, CompositeMailMessage, IDMailMessage, MIMEMailMessage

public abstract class MailMessage
extends MailPart

MailMessage - Abstract super class for all MailMessage subclasses.

Author:

Thorben Betten

See Also:

Serialized Form

Field Summary

static int	COLOR_LABEL_NONE The int value for no color label
static java.lang.String	COLOR_LABEL_PREFIX The prefix for a mail message's color labels stored as a user flag
static java.lang.String	COLOR_LABEL_PREFIX_OLD The deprecated prefix for a mail message's color labels stored as a user flag
static int	FLAG_ANSWERED This message has been answered.
static int	FLAG_DELETED This message is marked deleted.
static int	FLAG_DRAFT This message is a draft.
static int	FLAG_FLAGGED This message is flagged.
static int	FLAG_FORWARDED Virtual forwarded flag that marks this message as being forwarded.
static int	FLAG_READ_ACK Virtual read acknowledgment flag that marks this message as being notified for delivery.
static int	FLAG_RECENT This message is recent.
static int	FLAG_SEEN This message is seen.
static int	FLAG_SPAM Virtual Spam flag
static int	FLAG_USER A special flag that indicates that this folder supports user defined flags.
static int	PRIORITY_HIGH High priority
static int	PRIORITY_HIGHEST Highest priority
static int	PRIORITY_LOW Low priority
static int	PRIORITY_LOWEST Lowest priority
static int	PRIORITY_NORMAL Normal priority
static java.lang.String	USER_FORWARDED The value of virtual forwarded flag.
static java.lang.String	USER_READ_ACK The value of virtual read acknowledgment flag.

Fields inherited from class com.openexchange.mail.dataobjects.MailPart

NO_ENCLOSED_PARTS

Method Summary

void	addBcc(javax.mail.internet.InternetAddress addr) Adds an email address to Bcc
void	addBcc(javax.mail.internet.InternetAddress[] addrs) Adds email addresses to Bcc
void	addCc(javax.mail.internet.InternetAddress addr) Adds an email address to Cc
void	addCc(javax.mail.internet.InternetAddress[] addrs) Adds email addresses to Cc
void	addFrom(javax.mail.internet.InternetAddress addr) Adds an email address to From.
void	addFrom(javax.mail.internet.InternetAddress[] addrs) Adds email addresses to From.
void	addTo(javax.mail.internet.InternetAddress addr) Adds an email address to To.
void	addTo(javax.mail.internet.InternetAddress[] addrs) Adds email addresses to To
void	addUserFlag(java.lang.String userFlag) Adds given user flag
void	addUserFlags(java.lang.String[] userFlags) Adds given user flags
java.lang.Object	clone()
boolean	containsAccountId()
boolean	containsAccountName()
boolean	containsAppendVCard()
boolean	containsBcc()
boolean	containsCc()
boolean	containsColorLabel()
boolean	containsDispositionNotification()
boolean	containsFlags()
boolean	containsFolder()
boolean	containsFrom()
boolean	containsHasAttachment()
boolean	containsPrevSeen()
boolean	containsPriority()
boolean	containsReceivedDate()
boolean	containsRecentCount()
boolean	containsSentDate()
boolean	containsSubject()
boolean	containsThreadLevel()
boolean	containsTo()
boolean	containsUserFlags()
int	getAccountId() Gets the account ID.
java.lang.String	getAccountName() Gets the account Name
javax.mail.internet.InternetAddress[]	getBcc()
javax.mail.internet.InternetAddress[]	getCc()
int	getColorLabel() Gets the color label
static int	getColorLabelIntValue(java.lang.String cl) Determines the corresponding int value of a given color label's string representation.
static java.lang.String	getColorLabelStringValue(int cl) Generates the color label's string representation from given int value.
javax.mail.internet.InternetAddress	getDispositionNotification() Gets the dispositionNotification
int	getFlags() Gets the flags
java.lang.String	getFolder() Gets the folder
javax.mail.internet.InternetAddress[]	getFrom()
abstract java.lang.String	getMailId() Gets the implementation-specific unique ID of this mail in its mail folder.
MailPath	getMailPath() Gets the mail path.
int	getPriority() Gets the priority
java.util.Date	getReceivedDate() Gets the received date which represents the internal timestamp set by mail server on arrival.
java.util.Date	getReceivedDateDirect() Gets the received date directly which represents the internal timestamp set by mail server on arrival.
int	getRecentCount() Gets the number of recent mails in associated folder.
java.util.Date	getSentDate() Gets the sent date which corresponds to Date header
java.lang.String	getSubject() Gets the subject
int	getThreadLevel() Gets the threadLevel
javax.mail.internet.InternetAddress[]	getTo()
abstract int	getUnreadMessages() Gets the number of unread messages
java.lang.String[]	getUserFlags() Gets the user flags
boolean	hasAttachment() Gets the hasAttachment
boolean	isAnswered()
boolean	isAppendVCard() Gets the appendVCard
static boolean	isColorLabel(java.lang.String cl) Tests if specified string matches a color label pattern.
boolean	isDeleted()
boolean	isDraft()
boolean	isFlagged()
boolean	isForwarded()
boolean	isPrevSeen() Gets the previous \Seen state.
boolean	isReadAcknowledgment()
boolean	isRecent()
boolean	isSeen()
boolean	isSpam()
boolean	isUser()
static int	parseColorLabel(java.lang.String cl, int defaultValue) Parses specified color label's string.
void	removeAccountId() Removes the account ID.
void	removeAccountName() Removes the account name.
void	removeAppendVCard() Removes the appendVCard
void	removeBcc() Removes the Bcc addresses
void	removeCc() Removes the Cc addresses
void	removeColorLabel() Removes the color label
void	removeDispositionNotification() Removes the dispositionNotification
void	removeFlags() Removes the flags
void	removeFolder() Removes the folder
void	removeFrom() Removes the From addresses.
void	removeHasAttachment() Removes the hasAttachment
void	removePrevSeen() Removes the previous \Seen state
void	removePriority() Removes the priority
void	removeReceivedDate() Removes the received date
void	removeRecentCount() Removes the recent count.
void	removeSentDate() Removes the sent date
void	removeSubject() Removes the subject
void	removeThreadLevel() Removes the threadLevel
void	removeTo() Removes the To addresses
void	removeUserFlags() Removes the userFlags
void	setAccountId(int accountId) Sets the account ID.
void	setAccountName(java.lang.String accountName) Sets the account Name
void	setAppendVCard(boolean appendVCard) Sets the appendVCard
void	setColorLabel(int colorLabel) Sets the color label
void	setDispositionNotification(javax.mail.internet.InternetAddress dispositionNotification) Sets the dispositionNotification
void	setFlag(int flag, boolean enable) Sets a system flag
void	setFlags(int flags) Sets the flags
void	setFolder(java.lang.String folder) Sets the folder
void	setHasAttachment(boolean hasAttachment) Sets the hasAttachment
abstract void	setMailId(java.lang.String id) Sets the implementation-specific unique mail ID of this mail in its mail folder.
void	setPrevSeen(boolean prevSeen) Sets the previous \Seen state.
void	setPriority(int priority) Sets the priority
void	setReceivedDate(java.util.Date receivedDate) Sets the received date
void	setRecentCount(int recentCount) Sets the number of recent mails in associated folder.
void	setSentDate(java.util.Date sentDate) Sets the sent date
void	setSubject(java.lang.String subject) Sets the subject
void	setThreadLevel(int threadLevel) Sets the threadLevel
abstract void	setUnreadMessages(int unreadMessages) Sets the number of unread messages

Methods inherited from class com.openexchange.mail.dataobjects.MailPart

addHeader, addHeaders, containsContentDisposition, containsContentId, containsContentType, containsFileName, containsHeader, containsHeaders, containsMsgref, containsSequenceId, containsSize, getContent, getContentDisposition, getContentId, getContentType, getDataHandler, getEnclosedCount, getEnclosedMailPart, getFileName, getFirstHeader, getHeader, getHeader, getHeader, getHeaders, getHeadersIterator, getHeadersSize, getInputStream, getMatchingHeaders, getMsgref, getNonMatchingHeaders, getSequenceId, getSize, getSource, getSourceBytes, hasEnclosedParts, hasHeaders, loadContent, prepareForCaching, removeContentDisposition, removeContentId, removeContentType, removeFileName, removeHeader, removeHeaders, removeMsgref, removeSequenceId, removeSize, setContentDisposition, setContentDisposition, setContentId, setContentType, setContentType, setFileName, setMsgref, setSequenceId, setSize, writeTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_ANSWERED

public static final int FLAG_ANSWERED

This message has been answered. This flag is set by clients to indicate that this message has been answered to.

See Also:

Constant Field Values

FLAG_DELETED

public static final int FLAG_DELETED

This message is marked deleted. Clients set this flag to mark a message as deleted. The expunge operation on a folder removes all messages in that folder that are marked for deletion.

See Also:

Constant Field Values

FLAG_DRAFT

public static final int FLAG_DRAFT

This message is a draft. This flag is set by clients to indicate that the message is a draft message.

See Also:

Constant Field Values

FLAG_FLAGGED

public static final int FLAG_FLAGGED

This message is flagged. No semantic is defined for this flag. Clients alter this flag.

See Also:

Constant Field Values

FLAG_RECENT

public static final int FLAG_RECENT

This message is recent. Folder implementations set this flag to indicate that this message is new to this folder, that is, it has arrived since the last time this folder was opened.

Clients cannot alter this flag.

See Also:

Constant Field Values

FLAG_SEEN

public static final int FLAG_SEEN

This message is seen. This flag is implicitly set by the implementation when the this Message's content is returned to the client in some form.

See Also:

Constant Field Values

FLAG_USER

public static final int FLAG_USER

A special flag that indicates that this folder supports user defined flags.

Clients cannot alter this flag.

See Also:

Constant Field Values

FLAG_SPAM

public static final int FLAG_SPAM

Virtual Spam flag

See Also:

Constant Field Values

FLAG_FORWARDED

public static final int FLAG_FORWARDED

Virtual forwarded flag that marks this message as being forwarded.

See Also:

Constant Field Values

FLAG_READ_ACK

public static final int FLAG_READ_ACK

Virtual read acknowledgment flag that marks this message as being notified for delivery.

See Also:

Constant Field Values

USER_FORWARDED

public static final java.lang.String USER_FORWARDED

The value of virtual forwarded flag.

See Also:

Constant Field Values

USER_READ_ACK

public static final java.lang.String USER_READ_ACK

The value of virtual read acknowledgment flag.

See Also:

Constant Field Values

PRIORITY_HIGHEST

public static final int PRIORITY_HIGHEST

Highest priority

See Also:

Constant Field Values

PRIORITY_HIGH

public static final int PRIORITY_HIGH

High priority

See Also:

Constant Field Values

PRIORITY_NORMAL

public static final int PRIORITY_NORMAL

Normal priority

See Also:

Constant Field Values

PRIORITY_LOW

public static final int PRIORITY_LOW

Low priority

See Also:

Constant Field Values

PRIORITY_LOWEST

public static final int PRIORITY_LOWEST

Lowest priority

See Also:

Constant Field Values

COLOR_LABEL_PREFIX

public static final java.lang.String COLOR_LABEL_PREFIX

The prefix for a mail message's color labels stored as a user flag

See Also:

Constant Field Values

COLOR_LABEL_PREFIX_OLD

public static final java.lang.String COLOR_LABEL_PREFIX_OLD

The deprecated prefix for a mail message's color labels stored as a user flag

See Also:

Constant Field Values

COLOR_LABEL_NONE

public static final int COLOR_LABEL_NONE

The int value for no color label

See Also:

Constant Field Values

Method Detail

getColorLabelIntValue

public static int getColorLabelIntValue(java.lang.String cl)
                                 throws MailException

Determines the corresponding int value of a given color label's string representation.

A color label's string representation matches the pattern:
<value-of-COLOR_LABEL_PREFIX><color-label-int-value>

<value-of-COLOR_LABEL_PREFIX_OLD ><color-label-int-value> is also accepted.

Parameters:

cl - The color label's string representation

Returns:

The color label's int value

Throws:

MailException

isColorLabel

public static boolean isColorLabel(java.lang.String cl)

Tests if specified string matches a color label pattern.

Parameters:

cl - The string to check

Returns:

true if specified string matches a color label pattern; otherwise false

parseColorLabel

public static int parseColorLabel(java.lang.String cl,
                                  int defaultValue)

Parses specified color label's string.

Note that this method assumes isColorLabel(String) would return true for specified string.

Parameters:

cl - The color label's string

defaultValue - The default value to return if parsing color label's int value fails

Returns:

The color label's int value or defaultValue on failure.

getColorLabelStringValue

public static java.lang.String getColorLabelStringValue(int cl)

Generates the color label's string representation from given int value.

A color label's string representation matches the pattern:
<value-of-COLOR_LABEL_PREFIX><color-label-int-value>

Parameters:

cl - The color label's int value

Returns:

The color abel's string representation

addFrom

public void addFrom(javax.mail.internet.InternetAddress addr)

Adds an email address to From.

Parameters:

addr - The address

addFrom

public void addFrom(javax.mail.internet.InternetAddress[] addrs)

Adds email addresses to From.

Parameters:

addrs - The addresses

containsFrom

public boolean containsFrom()

Returns:

true if From is set; otherwise false

removeFrom

public void removeFrom()

Removes the From addresses.

getFrom

public javax.mail.internet.InternetAddress[] getFrom()

Returns:

The From addresses.

addTo

public void addTo(javax.mail.internet.InternetAddress addr)

Adds an email address to To.

Parameters:

addr - The address

addTo

public void addTo(javax.mail.internet.InternetAddress[] addrs)

Adds email addresses to To

Parameters:

addrs - The addresses

containsTo

public boolean containsTo()

Returns:

true if To is set; otherwise false

removeTo

public void removeTo()

Removes the To addresses

getTo

public javax.mail.internet.InternetAddress[] getTo()

Returns:

The To addresses

addCc

public void addCc(javax.mail.internet.InternetAddress addr)

Adds an email address to Cc

Parameters:

addr - The address

addCc

public void addCc(javax.mail.internet.InternetAddress[] addrs)

Adds email addresses to Cc

Parameters:

addrs - The addresses

containsCc

public boolean containsCc()

Returns:

true if Cc is set; otherwise false

removeCc

public void removeCc()

Removes the Cc addresses

getCc

public javax.mail.internet.InternetAddress[] getCc()

Returns:

The Cc addresses

addBcc

public void addBcc(javax.mail.internet.InternetAddress addr)

Adds an email address to Bcc

Parameters:

addr - The address

addBcc

public void addBcc(javax.mail.internet.InternetAddress[] addrs)

Adds email addresses to Bcc

Parameters:

addrs - The addresses

containsBcc

public boolean containsBcc()

Returns:

true if Bcc is set; otherwise false

removeBcc

public void removeBcc()

Removes the Bcc addresses

getBcc

public javax.mail.internet.InternetAddress[] getBcc()

Returns:

The Bcc addresses

getFlags

public int getFlags()

Gets the flags

Returns:

the flags

isAnswered

public boolean isAnswered()

Returns:

true if flag \ANSWERED is set; otherwise false

isDeleted

public boolean isDeleted()

Returns:

true if flag \DELETED is set; otherwise false

isDraft

public boolean isDraft()

Returns:

true if flag \DRAFT is set; otherwise false

isFlagged

public boolean isFlagged()

Returns:

true if flag \FLAGGED is set; otherwise false

isRecent

public boolean isRecent()

Returns:

true if flag \RECENT is set; otherwise false

isSeen

public boolean isSeen()

Returns:

true if flag \SEEN is set; otherwise false

isSpam

public boolean isSpam()

Returns:

true if virtual spam flag is set; otherwise false

isForwarded

public boolean isForwarded()

Returns:

true if forwarded flag is set; otherwise false

isReadAcknowledgment

public boolean isReadAcknowledgment()

Returns:

true if read acknowledgment flag is set; otherwise false

isUser

public boolean isUser()

Returns:

true if flag \USER is set; otherwise false

containsFlags

public boolean containsFlags()

Returns:

true if flags is set; otherwise false

removeFlags

public void removeFlags()

Removes the flags

setFlags

public void setFlags(int flags)

Sets the flags

Parameters:

flags - the flags to set

setFlag

public void setFlag(int flag,
                    boolean enable)
             throws MailException

Sets a system flag

Parameters:

flag - The system flag to set

enable - true to enable; otherwise false

Throws:

MailException - If an illegal flag argument is specified

isPrevSeen

public boolean isPrevSeen()

Gets the previous \Seen state.

This flag is used when writing the message later on. There a check is performed whether header Disposition-Notification-To is indicated or not.

Returns:

the previous \Seen state

containsPrevSeen

public boolean containsPrevSeen()

Returns:

true if previous \Seen state is set; otherwise false

removePrevSeen

public void removePrevSeen()

Removes the previous \Seen state

setPrevSeen

public void setPrevSeen(boolean prevSeen)

Sets the previous \Seen state.

This flag is used when writing the message later on. There a check is performed whether header Disposition-Notification-To is indicated or not.

Parameters:

prevSeen - the previous \Seen state to set

getThreadLevel

public int getThreadLevel()

Gets the threadLevel

Returns:

the threadLevel

containsThreadLevel

public boolean containsThreadLevel()

Returns:

true if threadLevel is set; otherwise false

removeThreadLevel

public void removeThreadLevel()

Removes the threadLevel

setThreadLevel

public void setThreadLevel(int threadLevel)

Sets the threadLevel

Parameters:

threadLevel - the threadLevel to set

getSubject

public java.lang.String getSubject()

Gets the subject

Returns:

the subject

containsSubject

public boolean containsSubject()

Returns:

true if subject is set; otherwise false

removeSubject

public void removeSubject()

Removes the subject

setSubject

public void setSubject(java.lang.String subject)

Sets the subject

Parameters:

subject - the subject to set

getSentDate

public java.util.Date getSentDate()

Gets the sent date which corresponds to Date header

Returns:

the sent date

containsSentDate

public boolean containsSentDate()

Returns:

true if sent date is set; otherwise false

removeSentDate

public void removeSentDate()

Removes the sent date

setSentDate

public void setSentDate(java.util.Date sentDate)

Sets the sent date

Parameters:

sentDate - the sent date to set

getReceivedDate

public java.util.Date getReceivedDate()

Gets the received date which represents the internal timestamp set by mail server on arrival.

Returns:

The received date

getReceivedDateDirect

public java.util.Date getReceivedDateDirect()

Gets the received date directly which represents the internal timestamp set by mail server on arrival.

Returns:

The received date

containsReceivedDate

public boolean containsReceivedDate()

Returns:

true if received date is set; otherwise false

removeReceivedDate

public void removeReceivedDate()

Removes the received date

setReceivedDate

public void setReceivedDate(java.util.Date receivedDate)

Sets the received date

Parameters:

receivedDate - the received date to set

addUserFlag

public void addUserFlag(java.lang.String userFlag)

Adds given user flag

Parameters:

userFlag - The user flag to add

addUserFlags

public void addUserFlags(java.lang.String[] userFlags)

Adds given user flags

Parameters:

userFlags - The user flags to add

containsUserFlags

public boolean containsUserFlags()

Returns:

true if userFlags is set; otherwise false

removeUserFlags

public void removeUserFlags()

Removes the userFlags

getUserFlags

public java.lang.String[] getUserFlags()

Gets the user flags

Returns:

The user flags

getColorLabel

public int getColorLabel()

Gets the color label

Returns:

the color label

containsColorLabel

public boolean containsColorLabel()

Returns:

true if color label is set; otherwise false

removeColorLabel

public void removeColorLabel()

Removes the color label

setColorLabel

public void setColorLabel(int colorLabel)

Sets the color label

Parameters:

colorLabel - the color label to set

getPriority

public int getPriority()

Gets the priority

Returns:

the priority

containsPriority

public boolean containsPriority()

Returns:

true if priority is set; otherwise false

removePriority

public void removePriority()

Removes the priority

setPriority

public void setPriority(int priority)

Sets the priority

Parameters:

priority - the priority to set

getDispositionNotification

public javax.mail.internet.InternetAddress getDispositionNotification()

Gets the dispositionNotification

Returns:

the dispositionNotification

containsDispositionNotification

public boolean containsDispositionNotification()

Returns:

true if dispositionNotification is set; otherwise false

removeDispositionNotification

public void removeDispositionNotification()

Removes the dispositionNotification

setDispositionNotification

public void setDispositionNotification(javax.mail.internet.InternetAddress dispositionNotification)

Sets the dispositionNotification

Parameters:

dispositionNotification - the dispositionNotification to set

getFolder

public java.lang.String getFolder()

Gets the folder

Returns:

the folder

containsFolder

public boolean containsFolder()

Returns:

true if folder is set; otherwise false

removeFolder

public void removeFolder()

Removes the folder

setFolder

public void setFolder(java.lang.String folder)

Sets the folder

Parameters:

folder - the folder to set

getAccountId

public int getAccountId()

Gets the account ID.

Returns:

The account ID

containsAccountId

public boolean containsAccountId()

Returns:

true if account ID is set; otherwise false

removeAccountId

public void removeAccountId()

Removes the account ID.

setAccountId

public void setAccountId(int accountId)

Sets the account ID.

Parameters:

accountId - The account ID

getAccountName

public java.lang.String getAccountName()

Gets the account Name

Returns:

The account name

containsAccountName

public boolean containsAccountName()

Returns:

true if account name is set; otherwise false

removeAccountName

public void removeAccountName()

Removes the account name.

setAccountName

public void setAccountName(java.lang.String accountName)

Sets the account Name

Parameters:

accountName - The account name

hasAttachment

public boolean hasAttachment()

Gets the hasAttachment

Returns:

the hasAttachment

containsHasAttachment

public boolean containsHasAttachment()

Returns:

true if hasAttachment is set; otherwise false

removeHasAttachment

public void removeHasAttachment()

Removes the hasAttachment

setHasAttachment

public void setHasAttachment(boolean hasAttachment)

Sets the hasAttachment

Parameters:

hasAttachment - the hasAttachment to set

clone

public java.lang.Object clone()

Overrides:

clone in class MailPart

isAppendVCard

public boolean isAppendVCard()

Gets the appendVCard

Returns:

the appendVCard

containsAppendVCard

public boolean containsAppendVCard()

Returns:

true if appendVCard is set; otherwise false

removeAppendVCard

public void removeAppendVCard()

Removes the appendVCard

setAppendVCard

public void setAppendVCard(boolean appendVCard)

Sets the appendVCard

Parameters:

appendVCard - the appendVCard to set

getRecentCount

public int getRecentCount()

Gets the number of recent mails in associated folder.

Returns:

The recent count

containsRecentCount

public boolean containsRecentCount()

Returns:

true if number of recent mails is set; otherwise false

removeRecentCount

public void removeRecentCount()

Removes the recent count.

setRecentCount

public void setRecentCount(int recentCount)

Sets the number of recent mails in associated folder.

Parameters:

recentCount - The recent count

getMailPath

public MailPath getMailPath()

Gets the mail path.

Parameters:

accountId - The account ID

Returns:

The mail path

getMailId

public abstract java.lang.String getMailId()

Gets the implementation-specific unique ID of this mail in its mail folder. The ID returned by this method is used in storages to refer to a mail.

Note If ID is numeric, max. 52 bits may be used in returned value which implies a max. allowed value of 4503599627370495.

Returns:

The ID of this mail or null if not available.

setMailId

public abstract void setMailId(java.lang.String id)

Sets the implementation-specific unique mail ID of this mail in its mail folder. The ID returned by this method is used in storages to refer to a mail.

Note If ID is numeric, max. 52 bits may be used in specified value which implies a max. allowed value of 4503599627370495.

Parameters:

id - The mail ID or null to indicate its absence

getUnreadMessages

public abstract int getUnreadMessages()

Gets the number of unread messages

Returns:

The number of unread messages

setUnreadMessages

public abstract void setUnreadMessages(int unreadMessages)

Sets the number of unread messages

Parameters:

unreadMessages - The number of unread messages