Email (Simple Java Mail API)

java.lang.Object
- org.codemonkey.simplejavamail.Email

```
public class Email
extends Object
```
Email message with all necessary data for an effective mailing action, including attachments etc.

Author:

Benny Bottema

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Email.Builder
Fluent interface Builder for Emails

Nested Classes
Modifier and Type	Class and Description
`static class`	`Email.Builder` Fluent interface Builder for Emails

Field Summary

Fields
Modifier and Type	Field and Description
`private List<AttachmentResource>`	`attachments` List of `AttachmentResource`.
`private List<AttachmentResource>`	`embeddedImages` List of `AttachmentResource`.
`private Recipient`	`fromRecipient` The sender of the email.
`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
Modifier Constructor and Description

Email()
Constructor, creates all internal lists.

private Email(Email.Builder builder)
Constructor for the Builder class

Constructors
Modifier	Constructor and Description
	`Email()` Constructor, creates all internal lists.
`private`	`Email(Email.Builder builder)` Constructor for the Builder class

Method Summary

All Methods Instance Methods Concrete Methods
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`.
`void`	`addEmbeddedImage(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.
`void`	`addEmbeddedImage(String name, DataSource imagedata)` Overloaded method which sets an embedded image on account of name and `DataSource`.
`void`	`addHeader(String name, Object value)` Adds a header to the `headers` list.
`void`	`addRecipient(String name, String address, javax.mail.Message.RecipientType type)` Adds a new `Recipient` to the list on account of name, address and recipient type (eg.
`List<AttachmentResource>`	`getAttachments()` Bean getter for `attachments` as unmodifiable list.
`List<AttachmentResource>`	`getEmbeddedImages()` Bean getter for `embeddedImages` as unmodifiable list.
`Recipient`	`getFromRecipient()` Bean getter for `fromRecipient`.
`Map<String,String>`	`getHeaders()` Bean getter for `headers` as unmodifiable map.
`List<Recipient>`	`getRecipients()` Bean getter for `recipients` as unmodifiable list.
`Recipient`	`getReplyToRecipient()` Bean getter for `replyToRecipient`.
`String`	`getSubject()` Bean getter for `subject`.
`String`	`getText()` Bean getter for `text`.
`String`	`getTextHTML()` Bean getter for `textHTML`.
`void`	`setFromAddress(String name, String fromAddress)` Sets the sender address.
`void`	`setReplyToAddress(String name, String replyToAddress)` Sets the reply-to address (optional).
`void`	`setSubject(String subject)` Bean setters for `subject`.
`void`	`setText(String text)` Bean setters for `text`.
`void`	`setTextHTML(String textHTML)` Bean setters for `textHTML`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fromRecipient
```
private Recipient fromRecipient
```
    The sender of the email. Can be used in conjunction with replyToRecipient.
  - 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.
- Constructor Detail
  - Email
```
public Email()
```
    Constructor, creates all internal lists.
  - Email
```
private Email(Email.Builder builder)
```
    Constructor for the Builder class
    
    Parameters:
    
    builder - The builder from which to create the email.
- Method Detail
  - setFromAddress
```
public void setFromAddress(String name,
                           String fromAddress)
```
    Sets the sender address.
    
    Parameters:
    
    name - The sender's name.
    
    fromAddress - The sender's email address.
  - setReplyToAddress
```
public void setReplyToAddress(String name,
                              String replyToAddress)
```
    Sets the reply-to address (optional).
    
    Parameters:
    
    name - The replied-to-receiver name.
    
    replyToAddress - The replied-to-receiver email address.
  - setSubject
```
public void setSubject(String subject)
```
    Bean setters for subject.
  - setText
```
public void setText(String text)
```
    Bean setters for text.
  - setTextHTML
```
public void setTextHTML(String textHTML)
```
    Bean setters for textHTML.
  - addRecipient
```
public void addRecipient(String name,
                         String address,
                         javax.mail.Message.RecipientType type)
```
    Adds a new Recipient to the list on account of name, address and recipient type (eg. Message.RecipientType.CC).
    
    Parameters:
    
    name - The name of the recipient.
    
    address - The emailadres of the recipient.
    
    type - The type of receiver (eg. Message.RecipientType.CC).
    
    See Also:
    
    recipients, Recipient, Message.RecipientType
  - addEmbeddedImage
```
public void addEmbeddedImage(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 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, addEmbeddedImage(String, DataSource)
  - addEmbeddedImage
```
public void addEmbeddedImage(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 void 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.
  - getFromRecipient
```
public Recipient getFromRecipient()
```
    Bean getter for fromRecipient.
  - getReplyToRecipient
```
public Recipient getReplyToRecipient()
```
    Bean getter for replyToRecipient.
  - getSubject
```
public String getSubject()
```
    Bean getter for subject.
  - getText
```
public String getText()
```
    Bean getter for text.
  - getTextHTML
```
public String getTextHTML()
```
    Bean getter for textHTML.
  - getAttachments
```
public List<AttachmentResource> getAttachments()
```
    Bean getter for attachments as unmodifiable list.
  - getEmbeddedImages
```
public List<AttachmentResource> getEmbeddedImages()
```
    Bean getter for embeddedImages as unmodifiable list.
  - getRecipients
```
public List<Recipient> getRecipients()
```
    Bean getter for recipients as unmodifiable list.
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Bean getter for headers as unmodifiable map.

Class Email

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fromRecipient

replyToRecipient

text

textHTML

subject

recipients

embeddedImages

attachments

headers

Constructor Detail

Email

Email

Method Detail

setFromAddress

setReplyToAddress

setSubject

setText

setTextHTML

addRecipient

addEmbeddedImage

addEmbeddedImage

addHeader

addAttachment

addAttachment

getFromRecipient

getReplyToRecipient

getSubject

getText

getTextHTML

getAttachments

getEmbeddedImages

getRecipients

getHeaders