com.screenscraper.util.mail

Class EmailMessage

java.lang.Object

com.screenscraper.util.mail.EmailMessage

Direct Known Subclasses:

SendableEmailMessage

public class EmailMessage
extends java.lang.Object

An email message. This could be modifiable or not

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	bodyMimeType The mime type of the body, as
protected javax.mail.Message	message The actual message
protected javax.mail.BodyPart	messageBody The body for the message
protected javax.mail.Multipart	messageContent The container for the body, attachments, etc...

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmailMessage(javax.mail.Session session) Build a message that is from the specified session

Method Summary

Modifier and Type	Method and Description
java.lang.String	addAttachment(byte[] file, MimeType mimeType, java.lang.String fileName) Adds an attachment to the message.
java.lang.String	addAttachment(byte[] file, MimeType mimeType, java.lang.String contentId, java.lang.String fileName) Adds an attachment to the message.
java.lang.String	addAttachment(byte[] file, java.lang.String mimeType, java.lang.String contentId, java.lang.String fileName) Adds an attachment to the message.
java.lang.String	addAttachment(java.io.File file) Adds an attachment to the message.
java.lang.String	addAttachment(java.io.File file, MimeType mimeType) Adds an attachment to the message.
java.lang.String	addAttachment(java.io.File file, MimeType mimeType, java.lang.String contentId) Adds an attachment to the message.
java.lang.String	addAttachment(java.io.File file, java.lang.String mimeType) Adds an attachment to the message.
java.lang.String	addAttachment(java.io.File file, java.lang.String mimeType, java.lang.String contentId) Adds an attachment to the message.
void	addBccRecipient(java.lang.String emailAddress) Add a recipient in the BCC: field
void	addBccRecipients(java.util.Collection<java.lang.String> addresses) Add a set of recipients in the BCC: field
void	addCcRecipient(java.lang.String emailAddress) Add a recipient in the CC: field
void	addCcRecipients(java.util.Collection<java.lang.String> addresses) Add a set of recipients in the CC: field
void	addHeader(java.lang.String headerName, java.lang.String headerValue) Adds custom headers to the message
void	addReplyTo(java.util.Collection<java.lang.String> emailAddresses) Adds a collection of Reply-To values for the email
void	addReplyTo(java.lang.String emailAddress) Adds a Reply-To value for the email
void	addToRecipient(java.lang.String emailAddress) Add a recipient in the TO: field
void	addToRecipients(java.util.Collection<java.lang.String> addresses) Add a set of recipients in the TO: field
void	appendImageToBody(java.io.File image) Appends an image to the body of the email.
void	appendToBody(java.lang.String addendum) Appends the given text to the current content of the body.
void	attachAllFilesInDirectory(java.io.File directory, boolean includeSubdirectories) Adds all files in the current directory as attachments.
java.lang.String	generateUniqueContentID() Generates a unique content ID value that can be used for attachments
java.util.Set<javax.mail.BodyPart>	getAttachments() Returns a set of the attachments included in this email
java.util.Set<java.lang.String>	getBccRecipients() Returns a set of all the recipients this message was addressed to in the 'BCC' field
java.util.Set<java.lang.String>	getCcRecipients() Returns a set of all the recipients this message was addressed to in the 'CC' field
java.util.List<java.lang.String>	getFrom() Returns a list of addresses this message is from
java.util.List<java.lang.String>	getReplyTo() Returns a list of addresses this message should be replied to at
java.lang.String	getSubject() Returns the subject of the email message
java.util.Set<java.lang.String>	getToRecipients() Returns a set of all the recipients this message was addressed to in the 'TO' field
void	setBody(java.lang.String body) Sets the body content of the message.
void	setBody(java.lang.String body, MimeType mimeType) Sets the body content of the message.
void	setBody(java.lang.String body, java.lang.String mimeType) Sets the body content of the message.
void	setFrom(java.lang.String emailAddress) Sets the From value for the email
void	setSubject(java.lang.String subject) Sets the subject of the message

Methods inherited from class java.lang.Object

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

Field Detail

message

protected javax.mail.Message message

The actual message

messageContent

protected javax.mail.Multipart messageContent

The container for the body, attachments, etc...

messageBody

@Nullable
protected javax.mail.BodyPart messageBody

The body for the message

bodyMimeType

@Nullable
protected java.lang.String bodyMimeType

The mime type of the body, as

Constructor Detail

EmailMessage

protected EmailMessage(javax.mail.Session session)

Build a message that is from the specified session

Parameters:

session - The mail session used for sending email, or the session the message was received on

Method Detail

addHeader

public void addHeader(java.lang.String headerName,
                      java.lang.String headerValue)
               throws javax.mail.MessagingException

Adds custom headers to the message

Parameters:

headerName - The name of the header

headerValue - The value for the header

Throws:

javax.mail.MessagingException - On error adding to the message

addToRecipients

public void addToRecipients(@NotNull
                            java.util.Collection<java.lang.String> addresses)
                     throws javax.mail.MessagingException

Add a set of recipients in the TO: field

Parameters:

addresses - The email addresses to add

Throws:

javax.mail.MessagingException - On invalid address

addToRecipient

public void addToRecipient(@NotNull
                           java.lang.String emailAddress)
                    throws javax.mail.MessagingException

Add a recipient in the TO: field

Parameters:

emailAddress - The email address to add

Throws:

javax.mail.MessagingException - On invalid address

addCcRecipients

public void addCcRecipients(@NotNull
                            java.util.Collection<java.lang.String> addresses)
                     throws javax.mail.MessagingException

Add a set of recipients in the CC: field

Parameters:

addresses - The email addresses to add

Throws:

javax.mail.MessagingException - On invalid address

addCcRecipient

public void addCcRecipient(@NotNull
                           java.lang.String emailAddress)
                    throws javax.mail.MessagingException

Add a recipient in the CC: field

Parameters:

emailAddress - The email address to add

Throws:

javax.mail.MessagingException - On invalid address

addBccRecipients

public void addBccRecipients(@NotNull
                             java.util.Collection<java.lang.String> addresses)
                      throws javax.mail.MessagingException

Add a set of recipients in the BCC: field

Parameters:

addresses - The email addresses to add

Throws:

javax.mail.MessagingException - On invalid address

addBccRecipient

public void addBccRecipient(@NotNull
                            java.lang.String emailAddress)
                     throws javax.mail.MessagingException

Add a recipient in the BCC: field

Parameters:

emailAddress - The email address to add

Throws:

javax.mail.MessagingException - On invalid address

setFrom

public void setFrom(@NotNull
                    java.lang.String emailAddress)
             throws javax.mail.MessagingException

Sets the From value for the email

Parameters:

emailAddress - The email address this message is from

Throws:

javax.mail.MessagingException - On an invalid address

addReplyTo

public void addReplyTo(@NotNull
                       java.util.Collection<java.lang.String> emailAddresses)
                throws javax.mail.MessagingException

Adds a collection of Reply-To values for the email

Parameters:

emailAddresses - The collection of email address to add

Throws:

javax.mail.MessagingException - On an invalid address

addReplyTo

public void addReplyTo(@NotNull
                       java.lang.String emailAddress)
                throws javax.mail.MessagingException

Adds a Reply-To value for the email

Parameters:

emailAddress - The email address to add

Throws:

javax.mail.MessagingException - On an invalid address

setSubject

public void setSubject(java.lang.String subject)
                throws javax.mail.MessagingException

Sets the subject of the message

Parameters:

subject - The subject of the message

Throws:

javax.mail.MessagingException - On any error setting the message field

setBody

public void setBody(java.lang.String body)
             throws javax.mail.MessagingException

Sets the body content of the message. If previous content was set, this will override it.

Parameters:

body - The content of the body, in HTML

Throws:

javax.mail.MessagingException - On any error setting the message field

setBody

public void setBody(java.lang.String body,
                    @NotNull
                    MimeType mimeType)
             throws javax.mail.MessagingException

Sets the body content of the message. If previous content was set, this will override it.

Parameters:

body - The content of the body, in the given type

mimeType - The Mime Type of the body content

Throws:

javax.mail.MessagingException - On any error setting the message field

setBody

public void setBody(java.lang.String body,
                    java.lang.String mimeType)
             throws javax.mail.MessagingException

Sets the body content of the message. If previous content was set, this will override it.

Parameters:

body - The content of the body, in the given type

mimeType - The Mime Type of the body content

Throws:

javax.mail.MessagingException - On any error setting the message field

appendImageToBody

public void appendImageToBody(@NotNull
                              java.io.File image)
                       throws java.io.IOException,
                              javax.mail.MessagingException

Appends an image to the body of the email. "Technically" this is an image, but it will in fact just attach the file, and add an image tag for it at the end of the current body content.

Parameters:

image - The image to add

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On an error reading the file, or reading the current email body

appendToBody

public void appendToBody(java.lang.String addendum)
                  throws java.io.IOException,
                         javax.mail.MessagingException

Appends the given text to the current content of the body. This new content should be the same Mime Type as the original content, and will be set to text/html if no content was set previous to this call

Parameters:

addendum - The text to append to the current message body

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On an error reading the current email body

attachAllFilesInDirectory

public void attachAllFilesInDirectory(@NotNull
                                      java.io.File directory,
                                      boolean includeSubdirectories)
                               throws java.io.IOException,
                                      javax.mail.MessagingException

Adds all files in the current directory as attachments. Optionally includes the subdirectories. It is up to the caller to ensure there are no files in the subdirectories with the same name as another file being attached, as the directory name is not prepended to the files

Parameters:

directory - The directory to search for files to attach

includeSubdirectories - True to also include subdirectories, false to only include files in the immediate directory

Throws:

java.io.IOException - On an error reading any of the files or directories

javax.mail.MessagingException - On an error attaching one of the files to the message

addAttachment

public java.lang.String addAttachment(@NotNull
                                      java.io.File file)
                               throws javax.mail.MessagingException,
                                      java.io.IOException

Adds an attachment to the message. The Mime type will be determine by the file extension.

Parameters:

file - The file to attach

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On error reading the given file

addAttachment

public java.lang.String addAttachment(@NotNull
                                      java.io.File file,
                                      @NotNull
                                      MimeType mimeType)
                               throws javax.mail.MessagingException,
                                      java.io.IOException

Adds an attachment to the message.

Parameters:

file - The file to attach

mimeType - The Mime type of the file

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On error reading the given file

addAttachment

public java.lang.String addAttachment(@NotNull
                                      java.io.File file,
                                      java.lang.String mimeType)
                               throws javax.mail.MessagingException,
                                      java.io.IOException

Adds an attachment to the message.

Parameters:

file - The file to attach

mimeType - The Mime type of the file

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On error reading the given file

addAttachment

public java.lang.String addAttachment(@NotNull
                                      java.io.File file,
                                      @NotNull
                                      MimeType mimeType,
                                      java.lang.String contentId)
                               throws javax.mail.MessagingException,
                                      java.io.IOException

Adds an attachment to the message.

Parameters:

file - The file to attach

mimeType - The Mime type of the file

contentId - The content ID to use for the attached file. This will match the value returned by the method

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On error reading the given file

addAttachment

public java.lang.String addAttachment(@NotNull
                                      java.io.File file,
                                      java.lang.String mimeType,
                                      java.lang.String contentId)
                               throws javax.mail.MessagingException,
                                      java.io.IOException

Adds an attachment to the message.

Parameters:

file - The file to attach

mimeType - The Mime type of the file

contentId - The content ID to use for the attached file. This will match the value returned by the method

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

java.io.IOException - On error reading the given file

addAttachment

public java.lang.String addAttachment(byte[] file,
                                      @NotNull
                                      MimeType mimeType,
                                      java.lang.String fileName)
                               throws javax.mail.MessagingException

Adds an attachment to the message.

Parameters:

file - The bytes that represent the file

mimeType - The Mime type of the file

fileName - The name to give the attached file

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

addAttachment

public java.lang.String addAttachment(byte[] file,
                                      @NotNull
                                      MimeType mimeType,
                                      java.lang.String contentId,
                                      java.lang.String fileName)
                               throws javax.mail.MessagingException

Adds an attachment to the message.

Parameters:

file - The bytes that represent the file

mimeType - The Mime type of the file

contentId - The content ID to use for the attached file. This will match the content ID returned by this method

fileName - The name to give the attached file

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

addAttachment

public java.lang.String addAttachment(byte[] file,
                                      java.lang.String mimeType,
                                      java.lang.String contentId,
                                      java.lang.String fileName)
                               throws javax.mail.MessagingException

Adds an attachment to the message.

Parameters:

file - The bytes that represent the file

mimeType - The Mime type of the file

contentId - The content ID to use for the attached file. This will match the content ID returned by this method

fileName - The name to give the attached file

Returns:

The content ID of the attached file

Throws:

javax.mail.MessagingException - On any error setting the message field

generateUniqueContentID

@NotNull
public java.lang.String generateUniqueContentID()

Generates a unique content ID value that can be used for attachments

Returns:

The unique content ID

getToRecipients

@NotNull
public java.util.Set<java.lang.String> getToRecipients()

Returns a set of all the recipients this message was addressed to in the 'TO' field

Returns:

A Set of all the TO recipients

getCcRecipients

@NotNull
public java.util.Set<java.lang.String> getCcRecipients()

Returns a set of all the recipients this message was addressed to in the 'CC' field

Returns:

A Set of all the CC recipients

getBccRecipients

@NotNull
public java.util.Set<java.lang.String> getBccRecipients()

Returns a set of all the recipients this message was addressed to in the 'BCC' field

Returns:

A Set of all the BCC recipients

getFrom

@NotNull
public java.util.List<java.lang.String> getFrom()

Returns a list of addresses this message is from

Returns:

A list of addresses this message is from

getReplyTo

@NotNull
public java.util.List<java.lang.String> getReplyTo()

Returns a list of addresses this message should be replied to at

Returns:

A list of addresses this message should be replied to at

getSubject

@Nullable
public java.lang.String getSubject()

Returns the subject of the email message

Returns:

The subject of the message

getAttachments

@NotNull
public java.util.Set<javax.mail.BodyPart> getAttachments()

Returns a set of the attachments included in this email

Returns:

A set of attachments on this email