lumis.service.emailtemplaterepository

Interface IEmailTemplate

@StableMinor(version="12.0",
             sinceVersion="11.2")
public interface IEmailTemplate

Represents an email template.

Since:

11.2.0

Version:

$Revision: 23035 $ $Date: 2019-08-05 19:55:10 +0000 (Mon, 05 Aug 2019) $

Method Summary

Modifier and Type	Method and Description
ISingleMail	format(String to, IEmailTemplateVariableResolver variableResolver) Returns the formated email.
String	getBodyTemplate() Returns the body template.
String	getId() Returns the identifier of the template.
Locale	getLocale() Returns the locale of the template.
Set<String>	getRequiredVariables() Returns the variables this template needs to be fully filled.
String	getSenderAddress() Returns the senderAddress of the template.
String	getServiceInstanceId() Returns the identifier of the service instance in witch the template was created on.
String	getSubjectTemplate() Returns the subject template.
String	getTitle() Returns the (informative only) title of the template.

Method Detail

getId

String getId()

Returns the identifier of the template.

Returns:

the identifier of the template.

Since:

11.2.0

getSubjectTemplate

String getSubjectTemplate()

Returns the subject template.

Returns:

the subject template.

Since:

11.2.0

getTitle

String getTitle()

Returns the (informative only) title of the template.

Returns:

the (informative only) title of the template.

Since:

11.2.0

getBodyTemplate

String getBodyTemplate()

Returns the body template.

Returns:

the HTML source of the body template.

Since:

11.2.0

getSenderAddress

String getSenderAddress()

Returns the senderAddress of the template.

Returns:

the senderAddress of the template.

Since:

11.2.0

getLocale

Locale getLocale()

Returns the locale of the template.

Returns:

the locale of the template.

Since:

11.2.0

getServiceInstanceId

String getServiceInstanceId()

Returns the identifier of the service instance in witch the template was created on.

Returns:

the identifier of the service instance in witch the template was created on.

Since:

11.2.0

getRequiredVariables

Set<String> getRequiredVariables()

Returns the variables this template needs to be fully filled.

Returns:

the variables this template needs to be fully filled.

Since:

11.2.0

format

ISingleMail format(String to,
                   IEmailTemplateVariableResolver variableResolver)
            throws UnresolvedVariableException,
                   PortalException

Returns the formated email.

Parameters:

to - the receipt of the email.

variableResolver - the variable resolver.

Returns:

the formated email.

Throws:

UnresolvedVariableException - if some variable couldn't be resolved.

PortalException - if some other error occur.

Since:

11.2.0