com.openexchange.mail.dataobjects.compose

Class ReferencedMailPart

java.lang.Object

com.openexchange.mail.dataobjects.MailPart

com.openexchange.mail.dataobjects.compose.ReferencedMailPart

All Implemented Interfaces:

ComposedMailPart, java.io.Serializable, java.lang.Cloneable

public abstract class ReferencedMailPart
extends MailPart
implements ComposedMailPart

ReferencedMailPart - A MailPart implementation that points to a referenced part in original mail.

Since a mail part causes troubles when its input stream is read multiple times, corresponding data is either stored in an internal byte array or copied as a temporary file to disk (depending on TransportConfig#getReferencedPartLimit()). Therefore this part needs special handling to ensure removal of temporary file when it is dispatched.

Author:

Thorben Betten

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.openexchange.mail.dataobjects.compose.ComposedMailPart

ComposedMailPart.ComposedPartType

Field Summary

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

NO_ENCLOSED_PARTS

Method Summary

Methods

Modifier and Type	Method and Description
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.lang.String	getFileID() Gets this referenced part's file ID if its content has been written to disc.
java.io.InputStream	getInputStream() Returns an input stream for this part.
ComposedMailPart.ComposedPartType	getType()
boolean	isMail() Checks if referenced part is a mail
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

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

addHeader, addHeaders, clone, 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, writeTo

Methods inherited from class java.lang.Object

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

Method Detail

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

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()

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

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

getFileID

public java.lang.String getFileID()

Gets this referenced part's file ID if its content has been written to disc.

Returns:

The file ID or null if content is kept inside rather than on disc.

isMail

public boolean isMail()

Checks if referenced part is a mail

Returns:

true if referenced part is a mail; otherwise false

getType

public ComposedMailPart.ComposedPartType getType()

Specified by:

getType in interface ComposedMailPart

Returns:

This SMTP part's type as a ComposedMailPart.ComposedPartType enumeration type