org.codemonkey.simplejavamail

Class Email.Builder

java.lang.Object

org.codemonkey.simplejavamail.Email.Builder

Enclosing class:

Email

public static class Email.Builder
extends Object

Fluent interface Builder for Emails

Author:

Jared Stewart

Field Summary

Fields

Modifier and Type	Field and Description
private List<AttachmentResource>	attachments List of AttachmentResource.
private Email	email
private List<AttachmentResource>	embeddedImages List of AttachmentResource.
private Recipient	fromRecipient
private Map<String,String>	headers Map of header name and values, such as X-Priority etc.
private List<Recipient>	recipients List of Recipient.
private Recipient	replyToRecipient The reply-to-address, optional.
private String	subject The subject of the email message.
private String	text The email message body in plain text.
private String	textHTML The email message body in html.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
void	addAttachment(String name, byte[] data, String mimetype) Adds an attachment to the email message and generates the necessary DataSource with the given byte data.
void	addAttachment(String name, DataSource filedata) Overloaded method which sets an attachment on account of name and DataSource.
Email.Builder	addHeader(String name, Object value) Adds a header to the headers list.
Email.Builder	bcc(Recipient recipient) Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.BCC.
Email.Builder	bcc(String name, String address) Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.BCC.
Email	build()
Email.Builder	cc(Recipient recipient) Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.CC.
Email.Builder	cc(String name, String address) Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.CC.
Email.Builder	embedImage(String name, byte[] data, String mimetype) Adds an embedded image (attachment type) to the email message and generates the necessary DataSource with the given byte data.
Email.Builder	embedImage(String name, DataSource imagedata) Overloaded method which sets an embedded image on account of name and DataSource.
Email.Builder	from(String name, String fromAddress) Sets the sender address.
Email.Builder	replyTo(String name, String replyToAddress) Sets the reply-to address (optional).
Email.Builder	subject(String subject) Sets the subject.
Email.Builder	text(String text) Sets the text.
Email.Builder	textHTML(String textHTML) Sets the textHTML.
Email.Builder	to(Recipient recipient) Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.TO.
Email.Builder	to(String name, String address) Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.TO.

Methods inherited from class java.lang.Object

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

Field Detail

fromRecipient

private Recipient fromRecipient

replyToRecipient

private Recipient replyToRecipient

The reply-to-address, optional. Can be used in conjunction with fromRecipient.

text

private String text

The email message body in plain text.

textHTML

private String textHTML

The email message body in html.

subject

private String subject

The subject of the email message.

recipients

private final List<Recipient> recipients

List of Recipient.

embeddedImages

private final List<AttachmentResource> embeddedImages

List of AttachmentResource.

attachments

private final List<AttachmentResource> attachments

List of AttachmentResource.

headers

private final Map<String,String> headers

Map of header name and values, such as X-Priority etc.

email

private Email email

Constructor Detail

Builder

public Builder()

Method Detail

build

public Email build()

from

public Email.Builder from(String name,
                          String fromAddress)

Sets the sender address.

Parameters:

name - The sender's name.

fromAddress - The sender's email address.

replyTo

public Email.Builder replyTo(String name,
                             String replyToAddress)

Sets the reply-to address (optional).

Parameters:

name - The replied-to-receiver name.

replyToAddress - The replied-to-receiver email address.

subject

public Email.Builder subject(String subject)

Sets the subject.

text

public Email.Builder text(String text)

Sets the text.

textHTML

public Email.Builder textHTML(String textHTML)

Sets the textHTML.

to

public Email.Builder to(String name,
                        String address)

Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.TO.

Parameters:

name - The name of the recipient.

address - The emailaddress of the recipient.

See Also:

recipients, Recipient

to

public Email.Builder to(Recipient recipient)

Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.TO.

Parameters:

recipient - The recipent whose name and address to use

See Also:

recipients, Recipient

cc

public Email.Builder cc(String name,
                        String address)

Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.CC.

Parameters:

name - The name of the recipient.

address - The emailaddress of the recipient.

See Also:

recipients, Recipient

cc

public Email.Builder cc(Recipient recipient)

Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.CC.

Parameters:

recipient - The recipent whose name and address to use

See Also:

recipients, Recipient

bcc

public Email.Builder bcc(String name,
                         String address)

Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.BCC.

Parameters:

name - The name of the recipient.

address - The emailaddress of the recipient.

See Also:

recipients, Recipient

bcc

public Email.Builder bcc(Recipient recipient)

Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.BCC.

Parameters:

recipient - The recipent whose name and address to use

See Also:

recipients, Recipient

embedImage

public Email.Builder embedImage(String name,
                                byte[] data,
                                String mimetype)

Adds an embedded image (attachment type) to the email message and generates the necessary DataSource with the given byte data. Then delegates to Email.addEmbeddedImage(String, DataSource). At this point the datasource is actually a ByteArrayDataSource.

Parameters:

name - The name of the image as being referred to from the message content body (eg. '<cid:signature>').

data - The byte data of the image to be embedded.

mimetype - The content type of the given data (eg. "image/gif" or "image/jpeg").

See Also:

ByteArrayDataSource, Email.addEmbeddedImage(String, DataSource)

embedImage

public Email.Builder embedImage(String name,
                                DataSource imagedata)

Overloaded method which sets an embedded image on account of name and DataSource.

Parameters:

name - The name of the image as being referred to from the message content body (eg. '<cid:embeddedimage>').

imagedata - The image data.

addHeader

public Email.Builder addHeader(String name,
                               Object value)

Adds a header to the headers list. The value is stored as a String.

example: email.addHeader("X-Priority", 2)

Parameters:

name - The name of the header.

value - The value of the header, which will be stored using String.valueOf(Object).

addAttachment

public void addAttachment(String name,
                          byte[] data,
                          String mimetype)

Adds an attachment to the email message and generates the necessary DataSource with the given byte data. Then delegates to addAttachment(String, DataSource). At this point the datasource is actually a ByteArrayDataSource.

Parameters:

name - The name of the extension (eg. filename including extension).

data - The byte data of the attachment.

mimetype - The content type of the given data (eg. "plain/text", "image/gif" or "application/pdf").

See Also:

ByteArrayDataSource, addAttachment(String, DataSource)

addAttachment

public void addAttachment(String name,
                          DataSource filedata)

Overloaded method which sets an attachment on account of name and DataSource.

Parameters:

name - The name of the attachment (eg. 'filename.ext').

filedata - The attachment data.