com.googlecode.kevinarpe.papaya.java_mail

Class EmailMessageBuilderImp

java.lang.Object

com.googlecode.kevinarpe.papaya.java_mail.EmailMessageBuilderImp

All Implemented Interfaces:

EmailMessageBuilder

public final class EmailMessageBuilderImp
extends Object
implements EmailMessageBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
EmailMessageBuilderImp(JavaMailSession javaMailSession)

Method Summary

Modifier and Type	Method and Description
EmailMessageBuilder	address(EmailMessageAddressType addressType, EmailMessageAddress nullableAddress) Sets an email address.
LinkedHashSet<EmailMessageAddress>	addressSet(EmailMessageAddressListType addressListType) Access an address set.
ArrayList<EmailMessageAttachment>	attachmentList() Optional: Directly access list of attachments.
EmailMessageBuilder	body(TextMimeSubType textMimeSubType, String text) Required: Sets the email body.
javax.mail.internet.MimeMessage	build() Constructs a new instance of MimeMessage.
EmailMessageBinaryAttachmentBuilder	builderForBinaryAttachment() Optional: Creates a builder for binary attachments.
EmailMessageTextAttachmentBuilder	builderForTextAttachment() Optional: Creates a builder for text attachments.
com.google.common.collect.LinkedHashMultimap<String,String>	headers() Optional: Access custom headers multi-map.
JavaMailSession	javaMailSession()
EmailMessageBuilder	subject(String subject) Required: Sets the email subject.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Constructor Detail

EmailMessageBuilderImp

public EmailMessageBuilderImp(JavaMailSession javaMailSession)

Method Detail

javaMailSession

public JavaMailSession javaMailSession()

Specified by:

javaMailSession in interface EmailMessageBuilder

Returns:

access parent Java mail Session object

address

public EmailMessageBuilder address(EmailMessageAddressType addressType,
                                   @Nullable
                                   EmailMessageAddress nullableAddress)

Sets an email address.

Required: EmailMessageAddressType.FROM

Optional: EmailMessageAddressType.SENDER

Specified by:

address in interface EmailMessageBuilder

nullableAddress - use null to clear the address

Returns:

self for fluent interface / method chaining

addressSet

public LinkedHashSet<EmailMessageAddress> addressSet(EmailMessageAddressListType addressListType)

Access an address set. Callers may add or remove addresses from the set.

Important: An email message must have at least one recipient in To:, Cc:, or Bcc: lists.

Why return LinkedHashSet? It is an ordered unique collection of addresses.

Specified by:

addressSet in interface EmailMessageBuilder

headers

public com.google.common.collect.LinkedHashMultimap<String,String> headers()

Optional: Access custom headers multi-map. Callers may add or remove entries from the multi-map.

Specified by:

headers in interface EmailMessageBuilder

subject

public EmailMessageBuilder subject(String subject)

Required: Sets the email subject.

Specified by:

subject in interface EmailMessageBuilder

Parameters:

subject - must not be empty or all whitespace

Returns:

self for fluent interface / method chaining

body

public EmailMessageBuilder body(TextMimeSubType textMimeSubType,
                                String text)

Required: Sets the email body.

Specified by:

body in interface EmailMessageBuilder

Parameters:

textMimeSubType - initial release will only support plain text or HTML email body

text - must not be empty or all whitespace

Returns:

self for fluent interface / method chaining

builderForTextAttachment

public EmailMessageTextAttachmentBuilder builderForTextAttachment()

Optional: Creates a builder for text attachments. Callers may reuse this builder for multiple attachments, or may create a new builder for each attachment. There are no restrictions on its usage.

For binary attachments, see: EmailMessageBuilder.builderForBinaryAttachment().

Specified by:

builderForTextAttachment in interface EmailMessageBuilder

Returns:

new builder for text attachments

See Also:

EmailMessageBuilder.builderForBinaryAttachment(), EmailMessageBuilder.attachmentList()

builderForBinaryAttachment

public EmailMessageBinaryAttachmentBuilder builderForBinaryAttachment()

Optional: Creates a builder for binary attachments. Callers may reuse this builder for multiple attachments, or may create a new builder for each attachment. There are no restrictions on its usage.

For text attachments, see: EmailMessageBuilder.builderForTextAttachment().

Specified by:

builderForBinaryAttachment in interface EmailMessageBuilder

Returns:

new builder for binary attachments

See Also:

EmailMessageBuilder.builderForTextAttachment(), EmailMessageBuilder.attachmentList()

attachmentList

public ArrayList<EmailMessageAttachment> attachmentList()

Optional: Directly access list of attachments. Callers may add or remove entries from the list.

Specified by:

attachmentList in interface EmailMessageBuilder

See Also:

EmailMessageBuilder.builderForTextAttachment(), EmailMessageBuilder.builderForBinaryAttachment()

build

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

Constructs a new instance of MimeMessage. Throws if any required values are unset.

Specified by:

build in interface EmailMessageBuilder

Throws:

Exception - if any required value is missing
or if MimeMessage throws on construction

See Also:

JavaMailSessionBuilder, JavaMailSession.session(), JavaMailSession.sendMessage(Message)