org.ezlibs.ezmail

Class TemplateEmail

java.lang.Object

org.ezlibs.ezmail.TemplateEmail

All Implemented Interfaces:

Email

public abstract class TemplateEmail
extends java.lang.Object
implements Email

A HTML email using a Thymeleaf template from the resources folder. Must be extended to instantiate. Provides helper methods for loading a template, loading images for use in the email, and populating the HTML template.

Constructor Summary

Constructors

Constructor and Description
TemplateEmail()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	loadHtmlTemplate(java.lang.String templatePath) Load a Thymeleaf HTML template from the application's resource folder and return it's content as a string.
protected static javax.activation.DataSource	loadImageDataSource(java.lang.String resourcePath, java.lang.String extension, java.lang.String mimeType) Load an image from the application's resources folder and open it as a data source.
protected static java.lang.String	populateHtmlTemplate(java.lang.String template, java.util.Map<java.lang.String,java.lang.Object> varMap) Populate a Thymeleaf HTML template with the values provided in the context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ezlibs.ezmail.Email

getHtmlContent, getImages, getSubject

Constructor Detail

TemplateEmail

public TemplateEmail()

Method Detail

populateHtmlTemplate

protected static java.lang.String populateHtmlTemplate(java.lang.String template,
                                                       java.util.Map<java.lang.String,java.lang.Object> varMap)

Populate a Thymeleaf HTML template with the values provided in the context.

Parameters:

template - the HTML template to populate with values

varMap - a map of template variable names and their corresponding values

Returns:

the populate HTML content as a String

loadImageDataSource

protected static javax.activation.DataSource loadImageDataSource(java.lang.String resourcePath,
                                                                 java.lang.String extension,
                                                                 java.lang.String mimeType)

Load an image from the application's resources folder and open it as a data source.

Parameters:

resourcePath - the relative path to the image resource

extension - the file extension

mimeType - the MIME type of the file

Returns:

the image as a DataSource object, or null if loading the image failed

loadHtmlTemplate

protected static java.lang.String loadHtmlTemplate(java.lang.String templatePath)
                                            throws java.io.IOException

Load a Thymeleaf HTML template from the application's resource folder and return it's content as a string.

Parameters:

templatePath - the relative path to the HTML template

Returns:

the HTML template's content as a String

Throws:

java.io.IOException - if the file has an extension other than '.html'

java.io.FileNotFoundException - if the file does not exist