com.openexchange.mail.mime.dataobjects

Class MimeMailMessage

java.lang.Object

com.openexchange.mail.dataobjects.MailPart

com.openexchange.mail.dataobjects.MailMessage

com.openexchange.mail.mime.dataobjects.MimeMailMessage

All Implemented Interfaces:

MimeRawSource, MimeCleanUp, java.io.Serializable, java.lang.Cloneable

public final class MimeMailMessage
extends MailMessage
implements MimeRawSource, MimeCleanUp

MimeMailMessage - A subclass of MailMessage to support MIME messages (as per RFC822).

Author:

Thorben Betten

See Also:

Serialized Form

Field Summary

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

COLOR_LABEL_NONE, COLOR_LABEL_PREFIX, COLOR_LABEL_PREFIX_OLD, FLAG_ANSWERED, FLAG_DELETED, FLAG_DRAFT, FLAG_FLAGGED, FLAG_FORWARDED, FLAG_READ_ACK, FLAG_RECENT, FLAG_SEEN, FLAG_SPAM, FLAG_USER, PRIORITY_HIGH, PRIORITY_HIGHEST, PRIORITY_LOW, PRIORITY_LOWEST, PRIORITY_NORMAL, USER_FORWARDED, USER_READ_ACK

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

NO_ENCLOSED_PARTS

Constructor Summary

Constructors

Constructor and Description
MimeMailMessage() Constructor - Constructs an empty mail message
MimeMailMessage(javax.mail.internet.MimeMessage msg) Constructor - Only applies specified message, but does not set any attributes

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanUp() Performs the clean-up on this MIME resources.
java.lang.Object	getContent() Returns the part's content as a Java object dependent on underlying implementation.
javax.activation.DataHandler	getDataHandler() Returns an appropriate DataHandler for this mail part.
int	getEnclosedCount() Gets the number of enclosed mail parts.
MailPart	getEnclosedMailPart(int index) Gets the mail part located at given index.
java.io.InputStream	getInputStream() Returns an input stream for this part.
java.lang.String	getMailId() Gets the implementation-specific unique ID of this mail in its mail folder.
javax.mail.internet.MimeMessage	getMimeMessage() Gets the MIME message.
javax.mail.Part	getPart() Gets the part.
java.io.InputStream	getRawInputStream() Gets an InputStream to the raw data with any Content-Transfer-Encoding intact.
char	getSeparator() Gets the separator.
int	getSeqnum() Gets the sequence number.
int	getUnreadMessages() Gets the number of unread messages
void	loadContent() Ensures that the part's content is loaded, thus this part is independent of the original.
void	prepareForCaching() Prepares this mail part to be put into cache; meaning to release all kept resources
void	setContent(javax.mail.internet.MimeMessage msg) Sets this mail message's content Through providing a null reference the body is cleared from this mail.
void	setMailId(java.lang.String id) Sets the implementation-specific unique mail ID of this mail in its mail folder.
void	setSeparator(char separator) Sets the separator.
void	setSeqnum(int seqnum) Sets the sequence number.
void	setUnreadMessages(int unreadMessages) Sets the number of unread messages
java.lang.String	toString()
void	writeTo(java.io.OutputStream out) Writes complete part's data into given output stream

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

addBcc, addBcc, addCc, addCc, addFrom, addFrom, addTo, addTo, addUserFlag, addUserFlags, clone, containsAccountId, containsAccountName, containsAppendVCard, containsBcc, containsCc, containsColorLabel, containsDispositionNotification, containsFlags, containsFolder, containsFrom, containsHasAttachment, containsMessageId, containsPrevSeen, containsPriority, containsReceivedDate, containsRecentCount, containsReferences, containsSentDate, containsSubject, containsThreadLevel, containsTo, containsUserFlags, getAccountId, getAccountName, getBcc, getCc, getColorLabel, getColorLabelIntValue, getColorLabelStringValue, getDispositionNotification, getFlags, getFolder, getFrom, getInReplyTo, getMailPath, getMessageId, getPriority, getReceivedDate, getReceivedDateDirect, getRecentCount, getReferences, getSentDate, getSubject, getThreadLevel, getTo, getUserFlags, hasAttachment, isAnswered, isAppendVCard, isColorLabel, isDeleted, isDraft, isFlagged, isForwarded, isPrevSeen, isReadAcknowledgment, isRecent, isSeen, isSpam, isUser, parseColorLabel, removeAccountId, removeAccountName, removeAppendVCard, removeBcc, removeCc, removeColorLabel, removeDispositionNotification, removeFlags, removeFolder, removeFrom, removeHasAttachment, removeMessageId, removePrevSeen, removePriority, removeReceivedDate, removeRecentCount, removeReferences, removeSentDate, removeSubject, removeThreadLevel, removeTo, removeUserFlags, setAccountId, setAccountName, setAppendVCard, setColorLabel, setDispositionNotification, setFlag, setFlags, setFolder, setHasAttachment, setMessageId, setPrevSeen, setPriority, setReceivedDate, setRecentCount, setReferences, setReferences, setSentDate, setSubject, setThreadLevel

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeMailMessage

public MimeMailMessage()

Constructor - Constructs an empty mail message

MimeMailMessage

public MimeMailMessage(javax.mail.internet.MimeMessage msg)
                throws com.openexchange.exception.OXException

Constructor - Only applies specified message, but does not set any attributes

Throws:

com.openexchange.exception.OXException - If setting message as content fails

Method Detail

getPart

public javax.mail.Part getPart()

Description copied from interface: MimeRawSource

Gets the part.

Specified by:

getPart in interface MimeRawSource

Returns:

The part or null

getSeparator

public char getSeparator()

Gets the separator.

Returns:

The separator

setSeparator

public void setSeparator(char separator)

Sets the separator.

Parameters:

separator - The separator to set

getSeqnum

public int getSeqnum()

Gets the sequence number.

Returns:

The sequence number

setSeqnum

public void setSeqnum(int seqnum)

Sets the sequence number.

Parameters:

seqnum - The sequence number to set

setContent

public void setContent(javax.mail.internet.MimeMessage msg)
                throws com.openexchange.exception.OXException

Sets this mail message's content

Through providing a null reference the body is cleared from this mail.

Parameters:

msg - The MIME message or null to clear any body references

Throws:

com.openexchange.exception.OXException - If setting message as content fails

getMimeMessage

public javax.mail.internet.MimeMessage getMimeMessage()

Gets the MIME message.

Returns:

The MIME message or null

cleanUp

public void cleanUp()

Description copied from interface: MimeCleanUp

Performs the clean-up on this MIME resources.

Specified by:

cleanUp in interface MimeCleanUp

getMailId

public java.lang.String getMailId()

Description copied from class: MailMessage

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.

Specified by:

getMailId in class MailMessage

Returns:

The ID of this mail or null if not available.

setMailId

public void setMailId(java.lang.String id)

Description copied from class: MailMessage

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.

Specified by:

setMailId in class MailMessage

Parameters:

id - The mail ID or null to indicate its absence

getContent

public java.lang.Object getContent()
                            throws com.openexchange.exception.OXException

Description copied from class: MailPart

Returns the part's content as a Java object dependent on underlying implementation.
This method is not applicable if part's MIME type is multipart/*

Specified by:

getContent in class MailPart

Returns:

The content as a Java object or null if not applicable

Throws:

com.openexchange.exception.OXException - If content cannot be returned as a Java object

getDataHandler

public javax.activation.DataHandler getDataHandler()
                                            throws com.openexchange.exception.OXException

Description copied from class: MailPart

Returns an appropriate DataHandler for this mail part.
This method is not applicable if part's MIME type is multipart/*

Specified by:

getDataHandler in class MailPart

Returns:

an appropriate DataHandler or null if not applicable

Throws:

com.openexchange.exception.OXException - If an appropriate DataHandler cannot be returned

getEnclosedCount

public int getEnclosedCount()
                     throws com.openexchange.exception.OXException

Description copied from class: MailPart

Gets the number of enclosed mail parts.
This method is only applicable if part's MIME type is multipart/*

Specified by:

getEnclosedCount in class MailPart

Returns:

The number of enclosed mail parts or MailPart.NO_ENCLOSED_PARTS if not applicable

Throws:

com.openexchange.exception.OXException

See Also:

MailPart.NO_ENCLOSED_PARTS

getEnclosedMailPart

public MailPart getEnclosedMailPart(int index)
                             throws com.openexchange.exception.OXException

Description copied from class: MailPart

Gets the mail part located at given index.
This method is only applicable if part's MIME type is multipart/*

Specified by:

getEnclosedMailPart in class MailPart

Parameters:

index - The index of desired mail part or null if not applicable

Returns:

The mail part

Throws:

com.openexchange.exception.OXException

getRawInputStream

public java.io.InputStream getRawInputStream()
                                      throws com.openexchange.exception.OXException

Description copied from interface: MimeRawSource

Gets an InputStream to the raw data with any Content-Transfer-Encoding intact. This method is useful if the "Content-Transfer-Encoding" header is incorrect or corrupt. In such a case the application may use this method and attempt to decode the raw data itself.

Specified by:

getRawInputStream in interface MimeRawSource

Returns:

The raw input stream

Throws:

com.openexchange.exception.OXException - If an error occurs

getInputStream

public java.io.InputStream getInputStream()
                                   throws com.openexchange.exception.OXException

Description copied from class: MailPart

Returns an input stream for this part.
This method is not applicable if part's MIME type is multipart/*

Specified by:

getInputStream in class MailPart

Returns:

An input stream for this part or null if not applicable

Throws:

com.openexchange.exception.OXException - If no input stream could be returned

writeTo

public void writeTo(java.io.OutputStream out)
             throws com.openexchange.exception.OXException

Description copied from class: MailPart

Writes complete part's data into given output stream

Overrides:

writeTo in class MailPart

Parameters:

out - The output stream to write to

Throws:

com.openexchange.exception.OXException - If writing to output stream fails

loadContent

public void loadContent()
                 throws com.openexchange.exception.OXException

Description copied from class: MailPart

Ensures that the part's content is loaded, thus this part is independent of the original.

This method is intended for mailing systems that read the contents stepwise on demand. If dealing with such a mail part with its underlying connection closed, the part's content is no more accessible. Otherwise this method may be implemented with an empty body.

Moreover the loaded content is no more discarded when MailPart.prepareForCaching() is invoked.

Specified by:

loadContent in class MailPart

Throws:

com.openexchange.exception.OXException - If loading part's content fails

prepareForCaching

public void prepareForCaching()

Description copied from class: MailPart

Prepares this mail part to be put into cache; meaning to release all kept resources

Specified by:

prepareForCaching in class MailPart

setUnreadMessages

public void setUnreadMessages(int unreadMessages)

Description copied from class: MailMessage

Sets the number of unread messages

Specified by:

setUnreadMessages in class MailMessage

Parameters:

unreadMessages - The number of unread messages

getUnreadMessages

public int getUnreadMessages()

Description copied from class: MailMessage

Gets the number of unread messages

Specified by:

getUnreadMessages in class MailMessage

Returns:

The number of unread messages

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object