org.mule.extension.email.internal

Class MessageBuilder

java.lang.Object

org.mule.extension.email.internal.MessageBuilder

public final class MessageBuilder
extends Object

an implementation of the builder design pattern to create a new Message instance.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
MessageBuilder	bcc(List<String> bccAddresses) Adds the "bcc" addresses to the Message that is being built.
javax.mail.internet.MimeMessage	build() Builds the Message with all the data provided.
MessageBuilder	cc(List<String> ccAddresses) Adds the "cc" addresses to the Message that is being built.
MessageBuilder	fromAddresses(List<String> fromAddresses) Adds the from addresses to the Message that is being built.
MessageBuilder	fromAddresses(String from) Adds a single from address to the Message that is being built.
static MessageBuilder	newMessage(javax.mail.Session session) Creates a new MessageBuilder instance for the specified session.
MessageBuilder	replyTo(List<String> replyAddresses) Adds the reply to addresses of the Message that is being built.
MessageBuilder	to(List<String> toAddresses) Adds the "to" (primary) addresses to the Message that is being built.
MessageBuilder	withAttachments(List<EmailAttachment> attachments) Adds attachments represented as EmailAttachments to the Message that is being built.
MessageBuilder	withAttachments(Map<String,DataHandler> attachments) Adds attachments represented as a Map of String/DataHandler to the Message that is being built.
MessageBuilder	withBody(String content) Adds the text content the Message that is being built.
MessageBuilder	withBody(String content, org.mule.runtime.api.metadata.MediaType contentType, String charset) Adds the text content the Message that is being built.
MessageBuilder	withHeaders(Map<String,String> headers) Adds custom headers to the Message that is being built.
MessageBuilder	withSentDate(Date date) Adds the sent date to the Message that is being built.
MessageBuilder	withSubject(String subject) Adds the subject to the Message that is being built.

Methods inherited from class java.lang.Object

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

Method Detail

newMessage

public static MessageBuilder newMessage(javax.mail.Session session)

Creates a new MessageBuilder instance for the specified session.

Parameters:

session - the Session for which the message is going to be created

Returns:

a new MessageBuilder instance.

withSubject

public MessageBuilder withSubject(String subject)
                           throws javax.mail.MessagingException

Adds the subject to the Message that is being built.

Parameters:

subject - the subject of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

fromAddresses

public MessageBuilder fromAddresses(List<String> fromAddresses)
                             throws javax.mail.MessagingException

Adds the from addresses to the Message that is being built.

Parameters:

fromAddresses - the from addresses of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

fromAddresses

public MessageBuilder fromAddresses(String from)
                             throws javax.mail.MessagingException

Adds a single from address to the Message that is being built.

Parameters:

from - the from address of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

to

public MessageBuilder to(List<String> toAddresses)
                  throws javax.mail.MessagingException

Adds the "to" (primary) addresses to the Message that is being built.

Parameters:

toAddresses - the primary addresses of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

bcc

public MessageBuilder bcc(List<String> bccAddresses)
                   throws javax.mail.MessagingException

Adds the "bcc" addresses to the Message that is being built.

Parameters:

bccAddresses - the blind carbon copy addresses of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

cc

public MessageBuilder cc(List<String> ccAddresses)
                  throws javax.mail.MessagingException

Adds the "cc" addresses to the Message that is being built.

Parameters:

ccAddresses - the carbon copy addresses of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

withHeaders

public MessageBuilder withHeaders(Map<String,String> headers)
                           throws javax.mail.MessagingException

Adds custom headers to the Message that is being built.

Parameters:

headers - the custom headers of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

withAttachments

public MessageBuilder withAttachments(List<EmailAttachment> attachments)

Adds attachments represented as EmailAttachments to the Message that is being built.

Parameters:

attachments - the attachments that are going to be added to the email.

Returns:

this MessageBuilder

withAttachments

public MessageBuilder withAttachments(Map<String,DataHandler> attachments)

Adds attachments represented as a Map of String/DataHandler to the Message that is being built.

Parameters:

attachments - the attachments that are going to be added to the email.

Returns:

this MessageBuilder

withSentDate

public MessageBuilder withSentDate(Date date)
                            throws javax.mail.MessagingException

Adds the sent date to the Message that is being built.

Parameters:

date - the date in which the email was sent.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

withBody

public MessageBuilder withBody(String content,
                               org.mule.runtime.api.metadata.MediaType contentType,
                               String charset)
                        throws javax.mail.MessagingException

Adds the text content the Message that is being built.

Parameters:

content - the text content of the email. If null is received, StringUtils.EMPTY will be used instead.

contentType - the contentType of the content of the email. One of "text/plain" or "text/html" expected.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

withBody

public MessageBuilder withBody(String content)
                        throws javax.mail.MessagingException

Adds the text content the Message that is being built. The contentType of this content will default to "text/plain".

Parameters:

content - the text content of the email. If null is received, StringUtils.EMPTY will be used instead.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

replyTo

public MessageBuilder replyTo(List<String> replyAddresses)
                       throws javax.mail.MessagingException

Adds the reply to addresses of the Message that is being built.

Parameters:

replyAddresses - the reply to addresses of the email.

Returns:

this MessageBuilder

Throws:

javax.mail.MessagingException

build

public javax.mail.internet.MimeMessage build()
                                      throws javax.mail.MessagingException

Builds the Message with all the data provided.

Returns:

a new MimeMessage instance.

Throws:

javax.mail.MessagingException