com.openexchange.mail.mime.filler

Class MimeMessageFiller

java.lang.Object

com.openexchange.mail.mime.filler.MimeMessageFiller

public class MimeMessageFiller
extends java.lang.Object

MimeMessageFiller - Provides basic methods to fills an instance of MimeMessage with headers/contents given through an instance of ComposedMailMessage

Author:

Thorben Betten

Constructor Summary

Constructors

Constructor and Description
MimeMessageFiller(com.openexchange.session.Session session, com.openexchange.groupware.contexts.Context ctx) Initializes a new MimeMessageFiller
MimeMessageFiller(com.openexchange.session.Session session, com.openexchange.groupware.contexts.Context ctx, UserSettingMail usm) Initializes a new MimeMessageFiller

Method Summary

Methods

Modifier and Type	Method and Description
static void	addClientIPAddress(javax.mail.internet.MimeMessage mimeMessage, com.openexchange.session.Session session) Add "X-Originating-IP" header.
void	deleteReferencedUploadFiles() Deletes referenced local uploaded files from session and disk after filled instance of MimeMessage is dispatched
void	fillMailBody(ComposedMailMessage mail, javax.mail.internet.MimeMessage mimeMessage, ComposeType type) Fills the body of given instance of MimeMessage with the contents specified through given instance of ComposedMailMessage.
int	getAccountId() Gets the account identifier
static boolean	isCustomOrReplyHeader(java.lang.String headerName) Checks if specified header name is a custom header (starts ignore-case with "X-") or refers to a reply-relevant header.
MimeMessageFiller	setAccountId(int accountId) Sets the account identifier
void	setCommonHeaders(javax.mail.internet.MimeMessage mimeMessage) Sets common headers in given MIME message: X-Mailer and Organization.
MimeMessageFiller	setDiscardReferencedInlinedImages(boolean discardReferencedInlinedImages) Sets whether to discard referenced inlined images.
void	setMessageHeaders(ComposedMailMessage mail, javax.mail.internet.MimeMessage mimeMessage) Sets necessary headers in specified MIME message: From/ Sender, To, Cc, Bcc, Reply-To, Subject, etc.
static void	setReplyHeaders(MailMessage referencedMail, javax.mail.internet.MimeMessage mimeMessage) Sets the appropriate headers In-Reply-To and References in specified MIME message.
void	setSendHeaders(ComposedMailMessage mail, javax.mail.internet.MimeMessage mimeMessage) Sets the appropriate headers before message's transport: Reply-To, Date, and Subject

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeMessageFiller

public MimeMessageFiller(com.openexchange.session.Session session,
                 com.openexchange.groupware.contexts.Context ctx)

Initializes a new MimeMessageFiller

Parameters:

session - The session providing user data

ctx - The context

MimeMessageFiller

public MimeMessageFiller(com.openexchange.session.Session session,
                 com.openexchange.groupware.contexts.Context ctx,
                 UserSettingMail usm)

Initializes a new MimeMessageFiller

Parameters:

session - The session providing user data

ctx - The context

usm - The user's mail settings

Method Detail

setDiscardReferencedInlinedImages

public MimeMessageFiller setDiscardReferencedInlinedImages(boolean discardReferencedInlinedImages)

Sets whether to discard referenced inlined images.

Parameters:

discardReferencedInlinedImages - The flag to set

Returns:

This filler with new behavior applied

setAccountId

public MimeMessageFiller setAccountId(int accountId)

Sets the account identifier

Parameters:

accountId - The account identifier to set

Returns:

This filler with account identifier set

getAccountId

public int getAccountId()

Gets the account identifier

Returns:

The account identifier

deleteReferencedUploadFiles

public void deleteReferencedUploadFiles()

Deletes referenced local uploaded files from session and disk after filled instance of MimeMessage is dispatched

setCommonHeaders

public void setCommonHeaders(javax.mail.internet.MimeMessage mimeMessage)
                      throws javax.mail.MessagingException,
                             com.openexchange.exception.OXException

Sets common headers in given MIME message: X-Mailer and Organization.

Parameters:

mimeMessage - The MIME message

Throws:

javax.mail.MessagingException - If headers cannot be set

com.openexchange.exception.OXException

addClientIPAddress

public static void addClientIPAddress(javax.mail.internet.MimeMessage mimeMessage,
                      com.openexchange.session.Session session)
                               throws javax.mail.MessagingException

Add "X-Originating-IP" header.

Parameters:

mimeMessage - The MIME message

session - The session

Throws:

javax.mail.MessagingException - If an error occurs

setMessageHeaders

public void setMessageHeaders(ComposedMailMessage mail,
                     javax.mail.internet.MimeMessage mimeMessage)
                       throws javax.mail.MessagingException,
                              com.openexchange.exception.OXException

Sets necessary headers in specified MIME message: From/ Sender, To, Cc, Bcc, Reply-To, Subject, etc.

Parameters:

mail - The composed mail

mimeMessage - The MIME message

Throws:

javax.mail.MessagingException - If headers cannot be set

com.openexchange.exception.OXException - If a mail error occurs

isCustomOrReplyHeader

public static boolean isCustomOrReplyHeader(java.lang.String headerName)

Checks if specified header name is a custom header (starts ignore-case with "X-") or refers to a reply-relevant header.

Parameters:

headerName - The header name to check

Returns:

true if specified header name is a custom OR reply-relevant header; otherwise false

setReplyHeaders

public static void setReplyHeaders(MailMessage referencedMail,
                   javax.mail.internet.MimeMessage mimeMessage)
                            throws javax.mail.MessagingException

Sets the appropriate headers In-Reply-To and References in specified MIME message.

Moreover the Reply-To header is set.

Parameters:

referencedMail - The referenced mail

mimeMessage - The MIME message

Throws:

javax.mail.MessagingException - If setting the reply headers fails

setSendHeaders

public void setSendHeaders(ComposedMailMessage mail,
                  javax.mail.internet.MimeMessage mimeMessage)
                    throws com.openexchange.exception.OXException

Sets the appropriate headers before message's transport: Reply-To, Date, and Subject

Parameters:

mail - The source mail

mimeMessage - The MIME message

Throws:

com.openexchange.exception.OXException - If a mail error occurs

fillMailBody

public void fillMailBody(ComposedMailMessage mail,
                javax.mail.internet.MimeMessage mimeMessage,
                ComposeType type)
                  throws javax.mail.MessagingException,
                         com.openexchange.exception.OXException,
                         java.io.IOException

Fills the body of given instance of MimeMessage with the contents specified through given instance of ComposedMailMessage.

Parameters:

mail - The source composed mail

mimeMessage - The MIME message to fill

type - The compose type

Throws:

javax.mail.MessagingException - If a messaging error occurs

com.openexchange.exception.OXException - If a mail error occurs

java.io.IOException - If an I/O error occurs