org.simplejavamail.email

Class Email

java.lang.Object

org.simplejavamail.email.Email

public class Email
extends Object

Email message with all necessary data for an effective mailing action, including attachments etc.

Author:

Benny Bottema

Constructor Summary

Constructors

Constructor and Description
Email() Constructor, creates all internal lists.
Email(boolean readFromDefaults)

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.
void	addBccRecipients(String... delimitedEmailAddresses) Delegates to #addRecipients(String, RecipientType, String...), using empty default name and Message.RecipientType.BCC.
void	addCcRecipients(String... delimitedEmailAddresses) Delegates to #addRecipients(String, RecipientType, String...), using empty default name and Message.RecipientType.CC.
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	addNamedBccRecipients(String name, String... delimitedEmailAddresses) Delegates to #addRecipients(String, RecipientType, String...), using Message.RecipientType.BCC.
void	addNamedCcRecipients(String name, String... delimitedEmailAddresses) Delegates to #addRecipients(String, RecipientType, String...), using Message.RecipientType.CC.
void	addNamedToRecipients(String name, String... delimitedEmailAddresses) Delegates to #addRecipients(String, RecipientType, String...), using Message.RecipientType.TO.
void	addRecipients(Recipient... recipientsToAdd) Adds all given Recipient instances to the list (as copies) on account of name, address and recipient type (eg.
void	addRecipients(String recipientName, javax.mail.Message.RecipientType type, String... recipientEmailAddressesToAdd) Adds all given recipients addresses to the list on account of address and recipient type (eg.
void	addToRecipients(String... delimitedEmailAddresses) Delegates to #addRecipients(String, RecipientType, String...), using empty default name and Message.RecipientType.TO.
boolean	equals(Object o)
List<AttachmentResource>	getAttachments() Bean getter for attachments as unmodifiable list.
Recipient	getDispositionNotificationTo() Bean getter for dispositionNotificationTo.
File	getDkimPrivateKeyFile()
InputStream	getDkimPrivateKeyInputStream()
String	getDkimSelector()
String	getDkimSigningDomain()
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.
String	getId() Bean getter for id.
List<Recipient>	getRecipients() Bean getter for recipients as unmodifiable list.
Recipient	getReplyToRecipient() Bean getter for replyToRecipient.
Recipient	getReturnReceiptTo() Bean getter for returnReceiptTo.
String	getSubject() Bean getter for subject.
String	getText() Bean getter for text.
String	getTextHTML() Bean getter for textHTML.
int	hashCode()
boolean	isApplyDKIMSignature()
boolean	isUseDispositionNotificationTo() Bean getter for useDispositionNotificationTo.
boolean	isUseReturnReceiptTo() Bean getter for useReturnReceiptTo.
void	setDispositionNotificationTo(Recipient dispositionNotificationTo) Bean setter for dispositionNotificationTo.
void	setFromAddress(Recipient recipient) Sets the sender address from a preconfigured Recipient object..
void	setFromAddress(String name, String fromAddress) Sets the sender address.
void	setId(String id) Bean setter for id.
void	setReplyToAddress(Recipient recipient) Sets the reply-to address from a preconfigured Recipient object..
void	setReplyToAddress(String name, String replyToAddress) Sets the reply-to address (optional).
void	setReturnReceiptTo(Recipient returnReceiptTo) Bean setter for returnReceiptTo.
void	setSubject(String subject) Bean setter for subject.
void	setText(String text) Bean setter for text.
void	setTextHTML(String textHTML) Bean setter for textHTML.
void	setUseDispositionNotificationTo(boolean useDispositionNotificationTo) Bean setter for useDispositionNotificationTo.
void	setUseReturnReceiptTo(boolean useReturnReceiptTo) Bean setter for useReturnReceiptTo.
void	signWithDomainKey(File dkimPrivateKeyFile, String signingDomain, String dkimSelector) As signWithDomainKey(InputStream, String, String), but with a File reference that is later read as InputStream.
void	signWithDomainKey(InputStream dkimPrivateKeyInputStream, String signingDomain, String dkimSelector) Primes this email for signing with a DKIM domain key.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Email

public Email()

Constructor, creates all internal lists. Populates default from, reply-to, to, cc and bcc if provided in the config file.

Email

public Email(boolean readFromDefaults)

Method Detail

signWithDomainKey

public void signWithDomainKey(@Nonnull
                              File dkimPrivateKeyFile,
                              @Nonnull
                              String signingDomain,
                              @Nonnull
                              String dkimSelector)

As signWithDomainKey(InputStream, String, String), but with a File reference that is later read as InputStream.

signWithDomainKey

public void signWithDomainKey(@Nonnull
                              InputStream dkimPrivateKeyInputStream,
                              @Nonnull
                              String signingDomain,
                              @Nonnull
                              String dkimSelector)

Primes this email for signing with a DKIM domain key. Actual signing is done when sending using a Mailer.

Also see:

     
https://postmarkapp.com/guides/dkim
     
https://github.com/markenwerk/java-utils-mail-dkim
     
http://www.gettingemaildelivered.com/dkim-explained-how-to-set-up-and-use-domainkeys-identified-mail-effectively
     
https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail
 

Parameters:

dkimPrivateKeyInputStream - De key content used to sign for the sending party.

signingDomain - The domain being authorized to send.

dkimSelector - Additional domain specifier.

setId

public void setId(@Nullable
                  String id)

Bean setter for id.

setFromAddress

public void setFromAddress(@Nullable
                           String name,
                           @Nonnull
                           String fromAddress)

Sets the sender address.

Parameters:

name - The sender's name.

fromAddress - The sender's email address, mandatory.

setFromAddress

public void setFromAddress(@Nonnull
                           Recipient recipient)

Sets the sender address from a preconfigured Recipient object..

Parameters:

recipient - The Recipient optional name and mandatory address.

setReplyToAddress

public void setReplyToAddress(@Nullable
                              String name,
                              @Nonnull
                              String replyToAddress)

Sets the reply-to address (optional).

Parameters:

name - The replied-to-receiver name.

replyToAddress - The replied-to-receiver email address.

setReplyToAddress

public void setReplyToAddress(@Nonnull
                              Recipient recipient)

Sets the reply-to address from a preconfigured Recipient object..

Parameters:

recipient - The Recipient optional name and mandatory address.

setSubject

public void setSubject(@Nonnull
                       String subject)

Bean setter for subject.

setUseDispositionNotificationTo

public void setUseDispositionNotificationTo(boolean useDispositionNotificationTo)

Bean setter for useDispositionNotificationTo.

setDispositionNotificationTo

public void setDispositionNotificationTo(Recipient dispositionNotificationTo)

Bean setter for dispositionNotificationTo.

setUseReturnReceiptTo

public void setUseReturnReceiptTo(boolean useReturnReceiptTo)

Bean setter for useReturnReceiptTo.

setReturnReceiptTo

public void setReturnReceiptTo(Recipient returnReceiptTo)

Bean setter for returnReceiptTo.

setText

public void setText(@Nullable
                    String text)

Bean setter for text.

setTextHTML

public void setTextHTML(@Nullable
                        String textHTML)

Bean setter for textHTML.

addToRecipients

public void addToRecipients(@Nonnull
                            String... delimitedEmailAddresses)

Delegates to #addRecipients(String, RecipientType, String...), using empty default name and Message.RecipientType.TO.

addCcRecipients

public void addCcRecipients(@Nonnull
                            String... delimitedEmailAddresses)

Delegates to #addRecipients(String, RecipientType, String...), using empty default name and Message.RecipientType.CC.

addBccRecipients

public void addBccRecipients(@Nonnull
                             String... delimitedEmailAddresses)

Delegates to #addRecipients(String, RecipientType, String...), using empty default name and Message.RecipientType.BCC.

addNamedToRecipients

public void addNamedToRecipients(@Nullable
                                 String name,
                                 @Nonnull
                                 String... delimitedEmailAddresses)

Delegates to #addRecipients(String, RecipientType, String...), using Message.RecipientType.TO.

addNamedCcRecipients

public void addNamedCcRecipients(@Nullable
                                 String name,
                                 @Nonnull
                                 String... delimitedEmailAddresses)

Delegates to #addRecipients(String, RecipientType, String...), using Message.RecipientType.CC.

addNamedBccRecipients

public void addNamedBccRecipients(@Nullable
                                  String name,
                                  @Nonnull
                                  String... delimitedEmailAddresses)

Delegates to #addRecipients(String, RecipientType, String...), using Message.RecipientType.BCC.

addRecipients

public void addRecipients(@Nullable
                          String recipientName,
                          @Nonnull
                          javax.mail.Message.RecipientType type,
                          @Nonnull
                          String... recipientEmailAddressesToAdd)

Adds all given recipients addresses to the list on account of address and recipient type (eg. Message.RecipientType.CC).

Email address can be of format "address@domain.com[,;*]" or "Recipient Name <address@domain.com>[,;*]". Included names would override the default recipientName provided.

Parameters:

recipientName - The optional name to use for each email address in the recipientEmailAddressesToAdd.

recipientEmailAddressesToAdd - List of (preconfigured) recipients (with or without names, overriding the default name if included).

See Also:

recipients, Recipient, Message.RecipientType

addRecipients

public void addRecipients(@Nonnull
                          Recipient... recipientsToAdd)

Adds all given Recipient instances to the list (as copies) on account of name, address and recipient type (eg. Message.RecipientType.CC).

Parameters:

recipientsToAdd - List of preconfigured recipients.

See Also:

recipients, Recipient, Message.RecipientType

addEmbeddedImage

public void addEmbeddedImage(@Nonnull
                             String name,
                             @Nonnull
                             byte[] data,
                             @Nonnull
                             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. '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(@Nullable
                             String name,
                             @Nonnull
                             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. 'embeddedimage').

imagedata - The image data.

addHeader

public void addHeader(@Nonnull
                      String name,
                      @Nonnull
                      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(@Nonnull
                          String name,
                          @Nonnull
                          byte[] data,
                          @Nonnull
                          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(@Nullable
                          String name,
                          @Nonnull
                          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.

getId

public String getId()

Bean getter for id.

getFromRecipient

public Recipient getFromRecipient()

Bean getter for fromRecipient.

getReplyToRecipient

public Recipient getReplyToRecipient()

Bean getter for replyToRecipient.

getSubject

public String getSubject()

Bean getter for subject.

isUseDispositionNotificationTo

public boolean isUseDispositionNotificationTo()

Bean getter for useDispositionNotificationTo.

getDispositionNotificationTo

public Recipient getDispositionNotificationTo()

Bean getter for dispositionNotificationTo.

isUseReturnReceiptTo

public boolean isUseReturnReceiptTo()

Bean getter for useReturnReceiptTo.

getReturnReceiptTo

public Recipient getReturnReceiptTo()

Bean getter for returnReceiptTo.

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.

isApplyDKIMSignature

public boolean isApplyDKIMSignature()

getDkimPrivateKeyInputStream

public InputStream getDkimPrivateKeyInputStream()

getDkimPrivateKeyFile

public File getDkimPrivateKeyFile()

getDkimSigningDomain

public String getDkimSigningDomain()

getDkimSelector

public String getDkimSelector()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object