com.openexchange.mail.parser.handlers

Class JsonMessageHandler

java.lang.Object

com.openexchange.mail.parser.handlers.JsonMessageHandler

All Implemented Interfaces:

MailMessageHandler

public final class JsonMessageHandler
extends java.lang.Object
implements MailMessageHandler

JsonMessageHandler - Generates a JSON message representation considering user-sensitive data.

Author:

Thorben Betten

Constructor Summary

Constructors

Constructor and Description
JsonMessageHandler(int accountId, MailPath mailPath, MailMessage mail, DisplayMode displayMode, boolean embedded, com.openexchange.session.Session session, UserSettingMail usm, boolean token, int ttlMillis) Initializes a new JsonMessageHandler
JsonMessageHandler(int accountId, java.lang.String mailPath, DisplayMode displayMode, boolean embedded, com.openexchange.session.Session session, UserSettingMail usm, boolean token, int ttlMillis) Initializes a new JsonMessageHandler

Method Summary

Methods

Modifier and Type	Method and Description
org.json.JSONObject	getJSONObject() Gets the filled instance of JSONObject
boolean	handleAttachment(MailPart part, boolean isInline, java.lang.String baseContentType, java.lang.String fileName, java.lang.String id) Handle an attachment part (any non-inline parts and file attachments)
boolean	handleBccRecipient(javax.mail.internet.InternetAddress[] recipientAddrs) Handle the 'Bcc' recipient message header
boolean	handleCcRecipient(javax.mail.internet.InternetAddress[] recipientAddrs) Handle the 'Cc' recipient message header
boolean	handleColorLabel(int colorLabel) Handle message's color label
boolean	handleContentId(java.lang.String contentId) Handle content id
boolean	handleDispositionNotification(javax.mail.internet.InternetAddress dispositionNotificationTo, boolean seen) Handle message's disposition notification
boolean	handleFrom(javax.mail.internet.InternetAddress[] fromAddrs) Handle the 'From' message header
boolean	handleHeaders(int size, java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> iter) Handle those message headers which cannot be handled through a handleXXX method
boolean	handleImagePart(MailPart part, java.lang.String imageCID, java.lang.String baseContentType, boolean isInline, java.lang.String fileName, java.lang.String id) Handle an image part (image/*)
boolean	handleInlineHtml(java.lang.String htmlContent, ContentType contentType, long size, java.lang.String fileName, java.lang.String id) Handle a html inline part (text/html)
boolean	handleInlinePlainText(java.lang.String plainTextContentArg, ContentType contentType, long size, java.lang.String fileName, java.lang.String id) Handle a plain text inline part (either text/plain or text/enriched)
boolean	handleInlineUUEncodedAttachment(UUEncodedPart part, java.lang.String id) Handle a UUEncoded file attachment inline part
boolean	handleInlineUUEncodedPlainText(java.lang.String decodedTextContent, ContentType contentType, int size, java.lang.String fileName, java.lang.String id) Handle a UUEncoded plain text inline part
void	handleMessageEnd(MailMessage mail) Perform some optional finishing operations
boolean	handleMsgRef(java.lang.String msgRef) Handle referenced mail
boolean	handleMultipart(MailPart mp, int bodyPartCount, java.lang.String id) Handle a multipart (multipart/*)
boolean	handleMultipartEnd(MailPart mp, java.lang.String id) Handle end of a multipart (multipart/*)
boolean	handleNestedMessage(MailPart mailPart, java.lang.String id) Handle a nested message (message/rfc822) Get the message via: MailMessage nestedMail = (MailMessage) mailPart.getContent();
boolean	handlePriority(int priority) Handle message's priority
boolean	handleReceivedDate(java.util.Date receivedDate) Handle message's received date
boolean	handleSentDate(java.util.Date sentDate) Handle message's sent date
boolean	handleSpecialPart(MailPart part, java.lang.String baseContentType, java.lang.String fileName, java.lang.String id) Handle special parts.
boolean	handleSubject(java.lang.String subject) Handle message's subject
boolean	handleSystemFlags(int flags) Handle message's system flags (//SEEN, //ANSWERED, ...)
boolean	handleToRecipient(javax.mail.internet.InternetAddress[] recipientAddrs) Handle the 'To' recipient message header
boolean	handleUserFlags(java.lang.String[] userFlags) Handle message's user flags
JsonMessageHandler	setAttachHTMLAlternativePart(boolean attachHTMLAlternativePart) Sets whether the HTML part of a multipart/alternative content shall be attached.
JsonMessageHandler	setExactLength(boolean exactLength) Sets whether to set the exact length of mail parts.
JsonMessageHandler	setIncludePlainText(boolean includePlainText) Sets whether to include raw plain-text in generated JSON object.
JsonMessageHandler	setTimeZone(java.util.TimeZone timeZone) Sets the time zone.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonMessageHandler

public JsonMessageHandler(int accountId,
                  java.lang.String mailPath,
                  DisplayMode displayMode,
                  boolean embedded,
                  com.openexchange.session.Session session,
                  UserSettingMail usm,
                  boolean token,
                  int ttlMillis)
                   throws com.openexchange.exception.OXException

Initializes a new JsonMessageHandler

Parameters:

accountId - The account ID

mailPath - The unique mail path

displayMode - The display mode

session - The session providing needed user data

usm - The mail settings used for preparing message content if displayVersion is set to true; otherwise it is ignored.

Throws:

com.openexchange.exception.OXException - If JSON message handler cannot be initialized

JsonMessageHandler

public JsonMessageHandler(int accountId,
                  MailPath mailPath,
                  MailMessage mail,
                  DisplayMode displayMode,
                  boolean embedded,
                  com.openexchange.session.Session session,
                  UserSettingMail usm,
                  boolean token,
                  int ttlMillis)
                   throws com.openexchange.exception.OXException

Initializes a new JsonMessageHandler

Parameters:

accountId - The account ID

mailPath - The unique mail path

mail - The mail message to add JSON fields not set by message parser traversal

displayMode - The display mode

session - The session providing needed user data

usm - The mail settings used for preparing message content if displayVersion is set to true; otherwise it is ignored.

token - true to add attachment tokens

ttlMillis - The tokens' timeout

Throws:

com.openexchange.exception.OXException - If JSON message handler cannot be initialized

Method Detail

setExactLength

public JsonMessageHandler setExactLength(boolean exactLength)

Sets whether to set the exact length of mail parts.

Parameters:

exactLength - true to set the exact length of mail parts; otherwise use mail system's size estimation

Returns:

This JsonMessageHandler with new behavior applied

setAttachHTMLAlternativePart

public JsonMessageHandler setAttachHTMLAlternativePart(boolean attachHTMLAlternativePart)

Sets whether the HTML part of a multipart/alternative content shall be attached.

Parameters:

attachHTMLAlternativePart - Whether the HTML part of a multipart/alternative content shall be attached

Returns:

This JsonMessageHandler with new behavior applied

setIncludePlainText

public JsonMessageHandler setIncludePlainText(boolean includePlainText)

Sets whether to include raw plain-text in generated JSON object.

Parameters:

includePlainText - true to include raw plain-text; otherwise false

Returns:

This JsonMessageHandler with new behavior applied

setTimeZone

public JsonMessageHandler setTimeZone(java.util.TimeZone timeZone)

Sets the time zone.

Parameters:

timeZone - The time zone

Returns:

This handler with time zone applied

handleAttachment

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

Description copied from interface: MailMessageHandler

Handle an attachment part (any non-inline parts and file attachments)

Specified by:

handleAttachment in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleBccRecipient

public boolean handleBccRecipient(javax.mail.internet.InternetAddress[] recipientAddrs)
                           throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle the 'Bcc' recipient message header

Specified by:

handleBccRecipient in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleCcRecipient

public boolean handleCcRecipient(javax.mail.internet.InternetAddress[] recipientAddrs)
                          throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle the 'Cc' recipient message header

Specified by:

handleCcRecipient in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleColorLabel

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

Description copied from interface: MailMessageHandler

Handle message's color label

Specified by:

handleColorLabel in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleContentId

public boolean handleContentId(java.lang.String contentId)
                        throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle content id

Specified by:

handleContentId in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleFrom

public boolean handleFrom(javax.mail.internet.InternetAddress[] fromAddrs)
                   throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle the 'From' message header

Specified by:

handleFrom in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleHeaders

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

Description copied from interface: MailMessageHandler

Handle those message headers which cannot be handled through a handleXXX method

Specified by:

handleHeaders in interface MailMessageHandler

Parameters:

size - The iterator's size or -1 to use Iterator.hasNext() instead

iter - The header iterator

Returns:

true to continue parsing; otherwise false

Throws:

com.openexchange.exception.OXException

handleImagePart

public boolean handleImagePart(MailPart part,
                      java.lang.String imageCID,
                      java.lang.String baseContentType,
                      boolean isInline,
                      java.lang.String fileName,
                      java.lang.String id)
                        throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle an image part (image/*)

Specified by:

handleImagePart in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleInlineHtml

public boolean handleInlineHtml(java.lang.String htmlContent,
                       ContentType contentType,
                       long size,
                       java.lang.String fileName,
                       java.lang.String id)
                         throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle a html inline part (text/html)

Specified by:

handleInlineHtml in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleInlinePlainText

public boolean handleInlinePlainText(java.lang.String plainTextContentArg,
                            ContentType contentType,
                            long size,
                            java.lang.String fileName,
                            java.lang.String id)
                              throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle a plain text inline part (either text/plain or text/enriched)

Specified by:

handleInlinePlainText in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleInlineUUEncodedAttachment

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

Description copied from interface: MailMessageHandler

Handle a UUEncoded file attachment inline part

Specified by:

handleInlineUUEncodedAttachment in interface MailMessageHandler

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

Description copied from interface: MailMessageHandler

Handle a UUEncoded plain text inline part

Specified by:

handleInlineUUEncodedPlainText in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleMessageEnd

public void handleMessageEnd(MailMessage mail)
                      throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Perform some optional finishing operations

Specified by:

handleMessageEnd in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleMultipart

public boolean handleMultipart(MailPart mp,
                      int bodyPartCount,
                      java.lang.String id)
                        throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle a multipart (multipart/*)

Specified by:

handleMultipart in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleMultipartEnd

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

Description copied from interface: MailMessageHandler

Handle end of a multipart (multipart/*)

Specified by:

handleMultipartEnd in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleNestedMessage

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

Description copied from interface: MailMessageHandler

Handle a nested message (message/rfc822)

Get the message via:

 MailMessage nestedMail = (MailMessage) mailPart.getContent();
 

Specified by:

handleNestedMessage in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handlePriority

public boolean handlePriority(int priority)
                       throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle message's priority

Specified by:

handlePriority in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleMsgRef

public boolean handleMsgRef(java.lang.String msgRef)
                     throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle referenced mail

Specified by:

handleMsgRef in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleDispositionNotification

public boolean handleDispositionNotification(javax.mail.internet.InternetAddress dispositionNotificationTo,
                                    boolean seen)
                                      throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle message's disposition notification

Specified by:

handleDispositionNotification in interface MailMessageHandler

seen - TODO

Throws:

com.openexchange.exception.OXException

handleReceivedDate

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

Description copied from interface: MailMessageHandler

Handle message's received date

Specified by:

handleReceivedDate in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleSentDate

public boolean handleSentDate(java.util.Date sentDate)
                       throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle message's sent date

Specified by:

handleSentDate in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleSpecialPart

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

Description copied from interface: MailMessageHandler

Handle special parts. A special part is either of MIME type message/delivery-status, message/disposition-notification, text/rfc822-headers, text/x-vcard, text/vcard, text/calendar or text/x-vCalendar

Specified by:

handleSpecialPart in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleSubject

public boolean handleSubject(java.lang.String subject)
                      throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle message's subject

Specified by:

handleSubject in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleSystemFlags

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

Description copied from interface: MailMessageHandler

Handle message's system flags (//SEEN, //ANSWERED, ...)

Specified by:

handleSystemFlags in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleToRecipient

public boolean handleToRecipient(javax.mail.internet.InternetAddress[] recipientAddrs)
                          throws com.openexchange.exception.OXException

Description copied from interface: MailMessageHandler

Handle the 'To' recipient message header

Specified by:

handleToRecipient in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

handleUserFlags

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

Description copied from interface: MailMessageHandler

Handle message's user flags

Specified by:

handleUserFlags in interface MailMessageHandler

Throws:

com.openexchange.exception.OXException

getJSONObject

public org.json.JSONObject getJSONObject()

Gets the filled instance of JSONObject

Returns:

The filled instance of JSONObject