Package lumis.service.emailtemplaterepository

Interface IEmailTemplate

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

Represents an email template.

Since:

11.2.0

Version:

$Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

Method Summary

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

Method Detail

getId

java.lang.String getId()

Returns the identifier of the template.

Returns:

the identifier of the template.

Since:

11.2.0

getSubjectTemplate

java.lang.String getSubjectTemplate()

Returns the subject template.

Returns:

the subject template.

Since:

11.2.0

getTitle

java.lang.String getTitle()

Returns the (informative only) title of the template.

Returns:

the (informative only) title of the template.

Since:

11.2.0

getBodyTemplate

java.lang.String getBodyTemplate()

Returns the body template.

Returns:

the HTML source of the body template.

Since:

11.2.0

getSenderAddressTemplate

java.lang.String getSenderAddressTemplate()

Returns the sender address template.

Returns:

the sender address template.

Since:

11.2.0

getServiceInstanceId

java.lang.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

java.util.Set<java.lang.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(IEmailTemplateVariableResolver variableResolver)
            throws UnresolvedVariableException,
                   PortalException

Returns the formated email.

Parameters:

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