cz.ues.platform.mail

Class MailReadHelper

java.lang.Object

cz.ues.platform.mail.MailReadHelper

public final class MailReadHelper
extends java.lang.Object

This class should be used to read mail-messages. It simplifies the low-level Java mail API.

Since:

UES6-06

Constructor Summary

Constructors

Constructor and Description
MailReadHelper()

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.String	decodeHeader(javax.mail.Header h)
static java.util.Map<java.lang.String,java.lang.String>	getAllHeaders(javax.mail.internet.MimeMessage mail) Reads and decodes all headers declared on mail message.
static java.util.List<MailResourceHandler>	getAttachedResources(javax.mail.internet.MimeMessage msg) Helper method to obtain list of mail attachments.
private static java.util.List<MailResourceHandler>	getAttachments(javax.mail.internet.MimeMultipart mp)
static java.lang.String	getHtmlText(javax.mail.internet.MimeMessage msg)
private static java.util.Map<java.lang.String,MailResourceHandler>	getInlineObjectsFromPart(javax.mail.Part part)
static java.util.Map<java.lang.String,MailResourceHandler>	getInlineResources(javax.mail.internet.MimeMessage msg) Scans mail message for inlined resources for HTML mails.
(package private) static java.lang.String	getMailInfo(javax.mail.Part part) Used to obtain mail info for exceptions in save way.
static java.lang.String	getPlainText(javax.mail.internet.MimeMessage msg)
private static java.lang.String	getTextFromMultipart(javax.mail.internet.MimeMultipart mp, MailMimeType textType)
private static java.lang.String	getTextFromPart(javax.mail.Part part, MailMimeType textType)
private static boolean	isAttachedObject(javax.mail.Part part) Checks the part if it is attached object.
private static boolean	isInlineObject(javax.mail.Part part) Checks the part if it is inline object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailReadHelper

public MailReadHelper()

Method Detail

getAllHeaders

public static java.util.Map<java.lang.String,java.lang.String> getAllHeaders(javax.mail.internet.MimeMessage mail)
throws MailHelperRTException

Reads and decodes all headers declared on mail message. The headers are decoded from raw - US-ASCII encoding java string - utf encoding, when some problems occurred, the decoding will be ignored and the original raw value is provided.

Parameters:

mail - The MailMessage to be scanned for headers.

Returns:

The Map with header-name:header-value pairs.

Throws:

MailHelperRTException - when some problems with headers reading.

Since:

UES6-06

decodeHeader

private static java.lang.String decodeHeader(javax.mail.Header h)

Parameters:

h - - the header to be decoded.

Returns:

Decoded value or original rawValue when problems occurred in decoding

Since:

UES6-06

getPlainText

public static java.lang.String getPlainText(javax.mail.internet.MimeMessage msg)
throws MailHelperRTException

Parameters:

msg - The Java Mail Message to be scanned to obtain the text.

Returns:

The text of Plain-text part of the mail. NULL when mail is only in HTML format.

Throws:

MailHelperRTException - when some problems occurred for MimeMessage read.

Since:

UES6-06

getHtmlText

public static java.lang.String getHtmlText(javax.mail.internet.MimeMessage msg)
throws MailHelperRTException

Parameters:

msg - The Java Mail Message to be scanned to obtain the html-text.

Returns:

The text of HTML-text part of the mail. NULL when mail is only in PlainText format.

Throws:

MailHelperRTException - when some problems occurred for MimeMessage read.

Since:

UES6-06

getTextFromPart

private static java.lang.String getTextFromPart(javax.mail.Part part,
MailMimeType textType)

getTextFromMultipart

private static java.lang.String getTextFromMultipart(javax.mail.internet.MimeMultipart mp,
MailMimeType textType)
throws javax.mail.MessagingException, java.io.IOException

Throws:

javax.mail.MessagingException

java.io.IOException

getInlineResources

public static java.util.Map<java.lang.String,MailResourceHandler> getInlineResources(javax.mail.internet.MimeMessage msg)
throws MailHelperRTException

Scans mail message for inlined resources for HTML mails.

Parameters:

msg - The message to be scanned for inline resources.

Returns:

The Map of resources, where key=CID, CID is ContentID used as reference in src attributes in HTML tags. Value = Resource handler - usable for read the resource from mail.

Throws:

MailHelperRTException - when some problems occurred for MimeMessage read.

Since:

UES6-06

getInlineObjectsFromPart

private static java.util.Map<java.lang.String,MailResourceHandler> getInlineObjectsFromPart(javax.mail.Part part)

getAttachedResources

public static java.util.List<MailResourceHandler> getAttachedResources(javax.mail.internet.MimeMessage msg)
throws MailHelperRTException

Helper method to obtain list of mail attachments. The INLINE resources are not into result list, use the MailReadHelper.getInlineResources(MimeMessage) to obtain the inlined resources.

Parameters:

msg - The message to be scanned for attachments.

Returns:

The list of ResourceHandlers referring to mail attachments.

Throws:

MailHelperRTException - when some problems occurred for MimeMessage read.

Since:

UES6-06

getAttachments

private static java.util.List<MailResourceHandler> getAttachments(javax.mail.internet.MimeMultipart mp)
throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getMailInfo

static java.lang.String getMailInfo(javax.mail.Part part)

Used to obtain mail info for exceptions in save way.

Parameters:

aMail - The message to be described.

Returns:

The info about mail sender, subject and receive date.

Since:

UES6-06

isInlineObject

private static boolean isInlineObject(javax.mail.Part part)
throws javax.mail.MessagingException

Checks the part if it is inline object. The means of "INLINE" differs from RFC-2183. Here it is about inline images into HTML message content.

Parameters:

part - The Message part to be checked.

Returns:

TRUE - it is INLINE, FALSE otherwise.

Throws:

javax.mail.MessagingException - When could not read the message headers.

Since:

UES6-06

isAttachedObject

private static boolean isAttachedObject(javax.mail.Part part)
throws javax.mail.MessagingException

Checks the part if it is attached object.

Parameters:

part - The Message part to be checked.

Returns:

TRUE - it is INLINE, FALSE otherwise.

Throws:

javax.mail.MessagingException - When could not read the message headers.

Since:

UES6-06