fr.sii.ogham.template.thymeleaf.common.configure

Class AbstractDefaultThymeleafEmailConfigurer

java.lang.Object

fr.sii.ogham.template.thymeleaf.common.configure.AbstractDefaultThymeleafEmailConfigurer

All Implemented Interfaces:

Configurer<MessagingBuilder>, MessagingConfigurer

Direct Known Subclasses:

DefaultThymeleafV2EmailConfigurer.ThymeleafV2EmailConfigurer, DefaultThymeleafV3EmailConfigurer.ThymeleafV3EmailConfigurer

public abstract class AbstractDefaultThymeleafEmailConfigurer
extends Object
implements MessagingConfigurer

Default configurer for Thymeleaf template engine that is automatically applied every time a MessagingBuilder instance is created through MessagingBuilder.standard() or MessagingBuilder.minimal().

The configurer has a priority of 90000 in order to be applied after global configurer but before any sender implementation.

This configurer is applied only if org.thymeleaf.TemplateEngine is present in the classpath. If not present, template engine is not registered at all.

This configurer inherits environment configuration (see EnvironmentBuilder)

It also copies resource resolution configuration of DefaultMessagingConfigurer to inherit resource resolution lookups (see ResourceResolutionBuilder).

This configurer applies the following configuration:

• Configures template prefix/suffix paths:
  • Uses the first property that has a value for classpath resolution prefix:
    1. "ogham.email.thymeleaf.classpath.path-prefix"
    2. "ogham.email.template.classpath.path-prefix"
    3. "ogham.email.thymeleaf.path-prefix"
    4. "ogham.email.template.path-prefix"
    5. "ogham.template.path-prefix"
  • Uses the first property that has a value for classpath resolution suffix:
    1. "ogham.email.thymeleaf.classpath.path-suffix"
    2. "ogham.email.template.classpath.path-suffix"
    3. "ogham.email.thymeleaf.path-suffix"
    4. "ogham.email.template.path-suffix"
    5. "ogham.template.path-suffix"
  • Uses the first property that has a value for file resolution prefix:
    1. "ogham.email.thymeleaf.file.path-prefix"
    2. "ogham.email.template.file.path-prefix"
    3. "ogham.email.thymeleaf.path-prefix"
    4. "ogham.email.template.path-prefix"
    5. "ogham.template.path-prefix"
  • Uses the first property that has a value for file resolution suffix:
    1. "ogham.email.thymeleaf.file.path-suffix"
    2. "ogham.email.template.file.path-suffix"
    3. "ogham.email.thymeleaf.path-suffix"
    4. "ogham.email.template.path-suffix"
    5. "ogham.template.path-suffix"
• Configures email alternative content:
  • Automatically loads HTML template if extension is .html
  • Automatically loads text template if extension is .txt
• Configures template detection:
  • Uses ThymeleafTemplateDetector to detect if templates are parseable by Thymeleaf

Author:

Aurélien Baudet

Constructor Summary

Constructors

Constructor and Description
AbstractDefaultThymeleafEmailConfigurer(org.slf4j.Logger log)
AbstractDefaultThymeleafEmailConfigurer(org.slf4j.Logger log, MessagingConfigurerAdapter delegate)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	canUseThymeleaf()
void	configure(MessagingBuilder msgBuilder) Apply configuration on the provided builder
protected abstract Class<? extends AbstractThymeleafMultiContentBuilder<?,?,?>>	getBuilderClass()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDefaultThymeleafEmailConfigurer

public AbstractDefaultThymeleafEmailConfigurer(org.slf4j.Logger log)

AbstractDefaultThymeleafEmailConfigurer

public AbstractDefaultThymeleafEmailConfigurer(org.slf4j.Logger log,
                                               MessagingConfigurerAdapter delegate)

Method Detail

configure

public void configure(MessagingBuilder msgBuilder)

Description copied from interface: Configurer

Apply configuration on the provided builder

Specified by:

configure in interface Configurer<MessagingBuilder>

Parameters:

msgBuilder - the builder to configure

getBuilderClass

protected abstract Class<? extends AbstractThymeleafMultiContentBuilder<?,?,?>> getBuilderClass()

canUseThymeleaf

protected abstract boolean canUseThymeleaf()