com.openexchange.mail.structure.handler

Class MIMEStructureHandler

java.lang.Object

com.openexchange.mail.structure.handler.MIMEStructureHandler

All Implemented Interfaces:

StructureHandler

public final class MIMEStructureHandler
extends java.lang.Object
implements StructureHandler

MIMEStructureHandler - The handler to generate a JSON object reflecting a message's MIME structure.

Author:

Thorben Betten

Constructor Summary

Constructors

Constructor and Description
MIMEStructureHandler(long maxSize) Initializes a new MIMEStructureHandler.

Method Summary

Methods

Modifier and Type	Method and Description
org.json.JSONObject	getJSONMailObject() Gets the JSON representation of mail's MIME structure.
boolean	handleAttachment(MailPart part, java.lang.String id)
boolean	handleColorLabel(int colorLabel)
boolean	handleEnd(MailMessage mail)
boolean	handleHeaders(java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> iter)
boolean	handleInlineUUEncodedAttachment(UUEncodedPart part, java.lang.String id)
boolean	handleInlineUUEncodedPlainText(java.lang.String decodedTextContent, ContentType contentType, int size, java.lang.String fileName, java.lang.String id)
boolean	handleMultipartEnd()
boolean	handleMultipartStart(ContentType contentType, int bodyPartCount, java.lang.String id)
boolean	handleNestedMessage(MailPart mailPart, java.lang.String id)
boolean	handleReceivedDate(java.util.Date receivedDate)
boolean	handleSMIMEBodyData(byte[] data)
boolean	handleSMIMEBodyText(MailPart part)
boolean	handleSystemFlags(int flags)
boolean	handleUserFlags(java.lang.String[] userFlags)
MIMEStructureHandler	setForceJSONArray4Multipart(boolean forceJSONArray4Multipart) Sets whether a JSON array is enforced for a multipart even if it only consists of one part.

Methods inherited from class java.lang.Object

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

Constructor Detail

MIMEStructureHandler

public MIMEStructureHandler(long maxSize)

Initializes a new MIMEStructureHandler.

Parameters:

maxSize - The max. size of a mail part to let its content being inserted as base64 encoded or UTF-8 string.

Method Detail

setForceJSONArray4Multipart

public MIMEStructureHandler setForceJSONArray4Multipart(boolean forceJSONArray4Multipart)

Sets whether a JSON array is enforced for a multipart even if it only consists of one part.

Parameters:

forceJSONArray4Multipart - true to enforce a JSON array; otherwise false

Returns:

This handler with new behavior applied

handleEnd

public boolean handleEnd(MailMessage mail)
                  throws com.openexchange.exception.OXException

Specified by:

handleEnd in interface StructureHandler

Throws:

com.openexchange.exception.OXException

getJSONMailObject

public org.json.JSONObject getJSONMailObject()

Gets the JSON representation of mail's MIME structure.

Returns:

The JSON representation of mail's MIME structure

handleAttachment

public boolean handleAttachment(MailPart part,
                       java.lang.String id)
                         throws com.openexchange.exception.OXException

Specified by:

handleAttachment in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleSMIMEBodyText

public boolean handleSMIMEBodyText(MailPart part)
                            throws com.openexchange.exception.OXException

Specified by:

handleSMIMEBodyText in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleSMIMEBodyData

public boolean handleSMIMEBodyData(byte[] data)
                            throws com.openexchange.exception.OXException

Specified by:

handleSMIMEBodyData in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleColorLabel

public boolean handleColorLabel(int colorLabel)
                         throws com.openexchange.exception.OXException

Specified by:

handleColorLabel in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleHeaders

public boolean handleHeaders(java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> iter)
                      throws com.openexchange.exception.OXException

Specified by:

handleHeaders in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleInlineUUEncodedAttachment

public boolean handleInlineUUEncodedAttachment(UUEncodedPart part,
                                      java.lang.String id)
                                        throws com.openexchange.exception.OXException

Specified by:

handleInlineUUEncodedAttachment in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleInlineUUEncodedPlainText

public boolean handleInlineUUEncodedPlainText(java.lang.String decodedTextContent,
                                     ContentType contentType,
                                     int size,
                                     java.lang.String fileName,
                                     java.lang.String id)
                                       throws com.openexchange.exception.OXException

Specified by:

handleInlineUUEncodedPlainText in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleMultipartStart

public boolean handleMultipartStart(ContentType contentType,
                           int bodyPartCount,
                           java.lang.String id)
                             throws com.openexchange.exception.OXException

Specified by:

handleMultipartStart in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleMultipartEnd

public boolean handleMultipartEnd()
                           throws com.openexchange.exception.OXException

Specified by:

handleMultipartEnd in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleNestedMessage

public boolean handleNestedMessage(MailPart mailPart,
                          java.lang.String id)
                            throws com.openexchange.exception.OXException

Specified by:

handleNestedMessage in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleReceivedDate

public boolean handleReceivedDate(java.util.Date receivedDate)
                           throws com.openexchange.exception.OXException

Specified by:

handleReceivedDate in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleSystemFlags

public boolean handleSystemFlags(int flags)
                          throws com.openexchange.exception.OXException

Specified by:

handleSystemFlags in interface StructureHandler

Throws:

com.openexchange.exception.OXException

handleUserFlags

public boolean handleUserFlags(java.lang.String[] userFlags)
                        throws com.openexchange.exception.OXException

Specified by:

handleUserFlags in interface StructureHandler

Throws:

com.openexchange.exception.OXException