com.googlecode.kevinarpe.papaya.java_mail

Interface EmailMessageBuilder

All Known Implementing Classes:

EmailMessageBuilderImp

public interface EmailMessageBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

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.

Method Detail

javaMailSession

JavaMailSession javaMailSession()

Returns:

access parent Java mail Session object

address

EmailMessageBuilder address(EmailMessageAddressType addressType,
                            @Nullable
                            EmailMessageAddress nullableAddress)

Sets an email address.

Required: EmailMessageAddressType.FROM

Optional: EmailMessageAddressType.SENDER

Parameters:

nullableAddress - use null to clear the address

Returns:

self for fluent interface / method chaining

addressSet

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.

headers

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

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

subject

EmailMessageBuilder subject(String subject)

Required: Sets the email subject.

Parameters:

subject - must not be empty or all whitespace

Returns:

self for fluent interface / method chaining

Throws:

IllegalArgumentException - if subject is empty or all whitespace

body

EmailMessageBuilder body(TextMimeSubType textMimeSubType,
                         String text)

Required: Sets the email body.

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

Throws:

IllegalArgumentException - if text is empty or all whitespace

builderForTextAttachment

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: builderForBinaryAttachment().

Returns:

new builder for text attachments

See Also:

builderForBinaryAttachment(), attachmentList()

builderForBinaryAttachment

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: builderForTextAttachment().

Returns:

new builder for binary attachments

See Also:

builderForTextAttachment(), attachmentList()

attachmentList

ArrayList<EmailMessageAttachment> attachmentList()

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

See Also:

builderForTextAttachment(), builderForBinaryAttachment()

build

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

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

Throws:

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

See Also:

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