com.openexchange.mail.dataobjects.compose

Class ContentAwareComposedMailMessage

java.lang.Object

com.openexchange.mail.dataobjects.MailPart

com.openexchange.mail.dataobjects.MailMessage

com.openexchange.mail.dataobjects.compose.ComposedMailMessage

com.openexchange.mail.dataobjects.compose.ContentAwareComposedMailMessage

All Implemented Interfaces:

ContentAware, java.io.Serializable, java.lang.Cloneable

public class ContentAwareComposedMailMessage
extends ComposedMailMessage
implements ContentAware

ContentAwareComposedMailMessage

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
ContentAwareComposedMailMessage(javax.mail.internet.MimeMessage content, com.openexchange.session.Session session, com.openexchange.groupware.contexts.Context ctx) Initializes a new ContentAwareComposedMailMessage.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnclosedPart(MailPart part) Adds an instance of MailPart to enclosed parts
boolean	containsFrom()
TextBodyMailPart	getBodyPart() Gets this composed message's body part.
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 this composed mail's part located at given index.
java.lang.String	getFirstHeader(java.lang.String name) Gets the first header for specified header name.
javax.mail.internet.InternetAddress[]	getFrom()
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.
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
MailPart	removeEnclosedPart(int index) Removes the enclosed part at the specified position.
void	setBodyPart(TextBodyMailPart mailPart) Sets this composed message's body part.
void	setMailId(java.lang.String id) Sets the implementation-specific unique mail ID of this mail in its mail folder.

Methods inherited from class com.openexchange.mail.dataobjects.compose.ComposedMailMessage

addRecipient, addRecipients, cleanUp, getContext, getRecipients, getSendType, getSession, getUnreadMessages, hasRecipients, setFiller, setSendType, setUnreadMessages

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, containsHasAttachment, containsMessageId, containsPrevSeen, containsPriority, containsReceivedDate, containsRecentCount, containsReferences, containsSentDate, containsSubject, containsThreadLevel, containsTo, containsUserFlags, getAccountId, getAccountName, getBcc, getCc, getColorLabel, getColorLabelIntValue, getColorLabelStringValue, getDispositionNotification, getFlags, getFolder, 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, 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, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentAwareComposedMailMessage

public ContentAwareComposedMailMessage(javax.mail.internet.MimeMessage content,
                               com.openexchange.session.Session session,
                               com.openexchange.groupware.contexts.Context ctx)

Initializes a new ContentAwareComposedMailMessage.

Parameters:

content - The content object

session - The session

ctx - The context

Method Detail

containsFrom

public boolean containsFrom()

Overrides:

containsFrom in class MailMessage

Returns:

true if From is set; otherwise false

getFrom

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

Overrides:

getFrom in class MailMessage

Returns:

The From addresses.

getFirstHeader

public java.lang.String getFirstHeader(java.lang.String name)

Description copied from class: MailPart

Gets the first header for specified header name.

This is a convenience method that invokes MailPart.getHeader(String, String) with the latter parameter set to null.

Overrides:

getFirstHeader in class MailPart

Parameters:

name - The header name

Returns:

The header's first value or null

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

getEnclosedCount

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

Description copied from class: ComposedMailMessage

Gets the number of enclosed mail parts.

Note: The returned number does not include the text body part applied with ComposedMailMessage.setBodyPart(TextBodyMailPart). To check for contained parts:

 composedMail.getEnclosedCount() > 0
 

Specified by:

getEnclosedCount in class ComposedMailMessage

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: ComposedMailMessage

Gets this composed mail's part located at given index.

Note: This method does not include the text body part applied with ComposedMailMessage.setBodyPart(TextBodyMailPart).

Specified by:

getEnclosedMailPart in class ComposedMailMessage

Parameters:

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

Returns:

The mail part

Throws:

com.openexchange.exception.OXException

setBodyPart

public void setBodyPart(TextBodyMailPart mailPart)

Description copied from class: ComposedMailMessage

Sets this composed message's body part.

The body part's content is supposed to be HTML content which is ought to be converted to appropriate MIME type on transport.

Specified by:

setBodyPart in class ComposedMailMessage

Parameters:

mailPart - The body part

getBodyPart

public TextBodyMailPart getBodyPart()

Description copied from class: ComposedMailMessage

Gets this composed message's body part.

The body part's content is supposed to be HTML content which is ought to be converted to appropriate MIME type on transport.

Specified by:

getBodyPart in class ComposedMailMessage

Returns:

The body part

removeEnclosedPart

public MailPart removeEnclosedPart(int index)

Description copied from class: ComposedMailMessage

Removes the enclosed part at the specified position. Shifts any subsequent parts to the left (subtracts one from their indices). Returns the part that was removed.

Specified by:

removeEnclosedPart in class ComposedMailMessage

Parameters:

index - The index position

Returns:

The removed part

addEnclosedPart

public void addEnclosedPart(MailPart part)

Description copied from class: ComposedMailMessage

Adds an instance of MailPart to enclosed parts

Specified by:

addEnclosedPart in class ComposedMailMessage

Parameters:

part - The instance of MailPart to add

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

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

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

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