com.communote.server.core.mail

Class MailMessageHelper

java.lang.Object

com.communote.server.core.mail.MailMessageHelper

public final class MailMessageHelper
extends Object

Helper class for mail messages

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_EMAIL_ADDRESS_SUFFIX Suffix of an email address (starting with @) of an anonymized user.

Method Summary

Modifier and Type	Method and Description
static void	assertNonAnonymousRecipients(javax.mail.Message message) Verifies that no email address in TO, BCC and CC headers ends with ANONYMOUS_EMAIL_ADDRESS_SUFFIX.
static String	createMessageIdHeaderValue(String identifier) Creates a value for the Message-ID header.
static String	extractMessageIdentifierFromReplyHeaders(javax.mail.Message message) Extracts the message identifier from the reply headers.
static Map<String,javax.mail.Part>	extractMessagePartsMatchingMimeTypes(javax.mail.Message message, String... mimeTypes) Extracts all parts (especially in case of a multipart message) of a message that have one of the supplied MIME types.
static Collection<User>	filterAnonymousUsers(Collection<User> receivers)
static String[]	getAllRecipients(javax.mail.Message message) Shorthand for calling getAllRecipients(Message, boolean, boolean, String) with arguments message, true, true, null
static String[]	getAllRecipients(javax.mail.Message message, boolean evaluateBoth, boolean startWithStandardHeaders, String suffixFilter) Gets all recipients found in X-Original-To header field and/or the standard recipient headers (TO,CC,Delivered-To - where the latter is useful for emails received because of a Bcc header).
static Collection<AttachmentTO>	getAttachments(javax.mail.Message message) Extracts the attachments from the mail.
static String	getMessageText(javax.mail.Message message, boolean plainTextOnly, boolean cleanup) Returns the text content of a email message.
static String[]	getRecipients(javax.mail.Message message, javax.mail.Message.RecipientType recipientType) Returns the recipients found by evaluating the provided header.
static boolean	isAnonymousEmailAddress(String email)
static boolean	isOutlookMessage(javax.mail.Message message) Tries to determine whether a message was created using a MS Outlook Mail-Client.
static void	sendMessage(Collection<User> receivers, String template, Map<String,Object> model) Sends a mail message to the defined receivers with the correct locale.
static void	sendMessage(Collection<User> receivers, String messageKey, Map<String,Object> model, String replyToAddress, String replyToName) Sends a mail message to the defined receivers with the correct locale.
static void	sendMessageToManagers(String template, Map<String,Object> model) Sends a message to all Managers.
static void	sendMessageToManagers(String template, Map<String,Object> model, String replyToAddress, String replyToName) Sends a message to all Managers.

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS_EMAIL_ADDRESS_SUFFIX

public static final String ANONYMOUS_EMAIL_ADDRESS_SUFFIX

Suffix of an email address (starting with @) of an anonymized user.

See Also:

Constant Field Values

Method Detail

assertNonAnonymousRecipients

public static void assertNonAnonymousRecipients(javax.mail.Message message)
                                         throws javax.mail.MessagingException,
                                                InvalidRecipientMailAddressException

Verifies that no email address in TO, BCC and CC headers ends with ANONYMOUS_EMAIL_ADDRESS_SUFFIX. In case such an email address is encountered an InvalidRecipientMailAddressException will be thrown.

Parameters:

message - the message to check

Throws:

javax.mail.MessagingException - in case the message has no recipients or getting the recipients failed

InvalidRecipientMailAddressException - in case an anonymous recipient is encountered

createMessageIdHeaderValue

public static String createMessageIdHeaderValue(String identifier)

Creates a value for the Message-ID header.

Parameters:

identifier - the identifier to convert to the header value. The identifier must be in dot-atom-text format as defined in RFC 2822

Returns:

the header value

extractMessageIdentifierFromReplyHeaders

public static String extractMessageIdentifierFromReplyHeaders(javax.mail.Message message)
                                                       throws javax.mail.MessagingException

Extracts the message identifier from the reply headers. The returned value is the identifier passed to createMessageIdHeaderValue(String).

Parameters:

message - the message to evaluate

Returns:

the identifier or null if none of the reply headers is set or the found value does not adhere to the msg-id format specification of RFC 822

Throws:

javax.mail.MessagingException - in case of an error while reading the email headers

extractMessagePartsMatchingMimeTypes

public static Map<String,javax.mail.Part> extractMessagePartsMatchingMimeTypes(javax.mail.Message message,
                                                                               String... mimeTypes)
                                                                        throws javax.mail.MessagingException,
                                                                               IOException

Extracts all parts (especially in case of a multipart message) of a message that have one of the supplied MIME types.

Parameters:

message - the message to process

mimeTypes - the MIME types to search for

Returns:

a possibly empty mapping from MIME type to message part

Throws:

javax.mail.MessagingException - in case of an error while reading the email data

IOException - if accessing the content of the part failed

filterAnonymousUsers

public static Collection<User> filterAnonymousUsers(Collection<User> receivers)

Parameters:

receivers -

Returns:

all users which do not have an anonymous email

getAllRecipients

public static String[] getAllRecipients(javax.mail.Message message)
                                 throws javax.mail.MessagingException

Shorthand for calling getAllRecipients(Message, boolean, boolean, String) with arguments message, true, true, null

Parameters:

message - the message to check

Returns:

the addresses found or null if there were no

Throws:

javax.mail.MessagingException - in case of an error while reading the recipients

getAllRecipients

public static String[] getAllRecipients(javax.mail.Message message,
                                        boolean evaluateBoth,
                                        boolean startWithStandardHeaders,
                                        String suffixFilter)
                                 throws javax.mail.MessagingException

Gets all recipients found in X-Original-To header field and/or the standard recipient headers (TO,CC,Delivered-To - where the latter is useful for emails received because of a Bcc header).

Parameters:

message - the message to check

evaluateBoth - whether to check both header types. If false the other header type will only be evaluated if the first header type was empty.

startWithStandardHeaders - when true the TO/CC/BCC headers will be evaluated first, otherwise the X-Original-To header

suffixFilter - optional filter to restrict results to email addresses that end with the suffix. If null all values will be accepted.

Returns:

the addresses found or null if there were no

Throws:

javax.mail.MessagingException - in case of an error while reading the recipients

getAttachments

public static Collection<AttachmentTO> getAttachments(javax.mail.Message message)
                                               throws javax.mail.MessagingException,
                                                      IOException

Extracts the attachments from the mail.

Parameters:

message - The message.

Returns:

Collection of attachments as AttachmentTO.

Throws:

IOException - Exception.

javax.mail.MessagingException - Exception.

getMessageText

public static String getMessageText(javax.mail.Message message,
                                    boolean plainTextOnly,
                                    boolean cleanup)
                             throws javax.mail.MessagingException,
                                    IOException

Returns the text content of a email message.

Parameters:

message - the message to process

plainTextOnly - when false this method will first look for an HTML message part and return it. If there is no such part a plain text part is searched and returned. In case this parameter is true this method will first search for a plain text message part and return it. If none exists a HTML message part is searched and cleaned from HTML markup before it is returned.

cleanup - if true some cleanup operations will be done before returning. This only applies when returning HTML from an HTML part or plain text from a HTML part (here the cleanup will replace paragraphs with newlines).

Returns:

the text part or null if there is no plain text or HTML part

Throws:

javax.mail.MessagingException - in case of an error while reading the email data

IOException - if accessing the content of the part failed

getRecipients

public static String[] getRecipients(javax.mail.Message message,
                                     javax.mail.Message.RecipientType recipientType)
                              throws javax.mail.MessagingException

Returns the recipients found by evaluating the provided header.

Parameters:

message - the message to check

recipientType - the recipient header to evaluate

Returns:

the found recipients

Throws:

javax.mail.MessagingException - in case of an error while reading the recipients

isAnonymousEmailAddress

public static boolean isAnonymousEmailAddress(String email)

Parameters:

email - true if it is an anonymous email and hence no mail should be send here

Returns:

isOutlookMessage

public static boolean isOutlookMessage(javax.mail.Message message)
                                throws javax.mail.MessagingException

Tries to determine whether a message was created using a MS Outlook Mail-Client. This is done by inspecting the X-Mailer and the X-MimeOLE header.

Parameters:

message - the message to check

Returns:

whether the message was created using MS Outlook

Throws:

javax.mail.MessagingException - in case of an error while reading the email data

sendMessage

public static void sendMessage(Collection<User> receivers,
                               String template,
                               Map<String,Object> model)

Sends a mail message to the defined receivers with the correct locale.

Parameters:

receivers - List of receivers.

template - The template.

model - The model.

sendMessage

public static void sendMessage(Collection<User> receivers,
                               String messageKey,
                               Map<String,Object> model,
                               String replyToAddress,
                               String replyToName)

Sends a mail message to the defined receivers with the correct locale.

Parameters:

receivers - List of receivers.

messageKey - The message key of the template.

model - The model.

replyToAddress - Address for reply to (optional).

replyToName - Name for reply to (optional).

sendMessageToManagers

public static void sendMessageToManagers(String template,
                                         Map<String,Object> model)

Sends a message to all Managers.

Parameters:

template - The template.

model - The model.

sendMessageToManagers

public static void sendMessageToManagers(String template,
                                         Map<String,Object> model,
                                         String replyToAddress,
                                         String replyToName)

Sends a message to all Managers.

Parameters:

template - The template.

model - The model.

replyToAddress - Address for reply to (optional).

replyToName - Name for reply to (optional).