Package org.ametys.core.ui.mail

Class StandardMailBodyHelper.MailBodyBuilder

java.lang.Object

org.ametys.core.ui.mail.StandardMailBodyHelper.MailBodyBuilder

Enclosing class:

StandardMailBodyHelper

public static class StandardMailBodyHelper.MailBodyBuilder
extends Object

Implements the builder pattern for creating and sending emails.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput	Record for an user input from a non-authenticated user
static final record	StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInputsSection	A section of unauthenticated user inputs
static final record	StandardMailBodyHelper.MailBodyBuilder.UserInput	Record for an user input
static final record	StandardMailBodyHelper.MailBodyBuilder.UserInputsSection	A section of user inputs

Method Summary

Modifier and Type	Method	Description
StandardMailBodyHelper.MailBodyBuilder	addMessage(String message)	Add a new message
StandardMailBodyHelper.MailBodyBuilder	addMessage(I18nizableText message)	Add a new message
StandardMailBodyHelper.MailBodyBuilder	addUnauthenticatedUserInput(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs)	Add users inputs from non-authenticated users
StandardMailBodyHelper.MailBodyBuilder	addUnauthenticatedUserInput(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs, I18nizableText userInputHeader)	Add users inputs from non-authenticated users
StandardMailBodyHelper.MailBodyBuilder	addUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs)	Add user inputs
StandardMailBodyHelper.MailBodyBuilder	addUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs, I18nizableText userInputHeader)	Add user inputs
String	build()	Build the body of the email as HTML
Map<String,Object>	toJson()	Get the JSON representation of the email ingredients
StandardMailBodyHelper.MailBodyBuilder	withDetails(I18nizableText detailsTitle, String detailsText, boolean technical)	Set details or additional information to display in the mail
StandardMailBodyHelper.MailBodyBuilder	withDetails(I18nizableText detailsTitle, I18nizableText detailsText, boolean technical)	Set details or additional information to display in the mail
StandardMailBodyHelper.MailBodyBuilder	withFooterBottomText(String footerText)	Set the text to display at footer bottom such as "Autogenerated email.
StandardMailBodyHelper.MailBodyBuilder	withFooterBottomText(I18nizableText footerText)	Set the text to display at footer bottom such as "Autogenerated email.
StandardMailBodyHelper.MailBodyBuilder	withFooterLink(String linkUrl, I18nizableText linkText)	Add a link to be displayed on footer
StandardMailBodyHelper.MailBodyBuilder	withFooterLink(String linkUrl, I18nizableText linkText, String imgPluginName, String imgPath)	Add a link to be displayed on footer
StandardMailBodyHelper.MailBodyBuilder	withLanguage(String lang)	Set the language
StandardMailBodyHelper.MailBodyBuilder	withLink(String linkUrl, I18nizableText linkText)	Add a main link to be displayed as a button
StandardMailBodyHelper.MailBodyBuilder	withMessage(String message)	Set the main message
StandardMailBodyHelper.MailBodyBuilder	withMessage(I18nizableText message)	Set the main message
StandardMailBodyHelper.MailBodyBuilder	withTitle(String title)	Set the title
StandardMailBodyHelper.MailBodyBuilder	withTitle(I18nizableText title)	Set the title
StandardMailBodyHelper.MailBodyBuilder	withUnauthenticatedUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs)	Add an user input from a non-authenticated user
StandardMailBodyHelper.MailBodyBuilder	withUnauthenticatedUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs, I18nizableText userInputHeader)	Add users inputs from non-authenticated users
StandardMailBodyHelper.MailBodyBuilder	withUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs)	Set the user action
StandardMailBodyHelper.MailBodyBuilder	withUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs, I18nizableText userInputHeader)	Set the user action

Methods inherited from class java.lang.Object

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

Method Details

withLanguage

public StandardMailBodyHelper.MailBodyBuilder withLanguage(String lang)

Set the language

Parameters:

lang - the language

Returns:

this builder

withTitle

public StandardMailBodyHelper.MailBodyBuilder withTitle(I18nizableText title)

Set the title

Parameters:

title - the title as I18nizableText

Returns:

this builder

withTitle

public StandardMailBodyHelper.MailBodyBuilder withTitle(String title)

Set the title

Parameters:

title - the title as String

Returns:

this builder

withMessage

public StandardMailBodyHelper.MailBodyBuilder withMessage(I18nizableText message)

Set the main message

Parameters:

message - the message as String or I18nizableText

Returns:

this builder

withMessage

public StandardMailBodyHelper.MailBodyBuilder withMessage(String message)

Set the main message

Parameters:

message - the message as String or I18nizableText

Returns:

this builder

addMessage

public StandardMailBodyHelper.MailBodyBuilder addMessage(I18nizableText message)

Add a new message

Parameters:

message - the message as I18nizableText

Returns:

this builder

addMessage

public StandardMailBodyHelper.MailBodyBuilder addMessage(String message)

Add a new message

Parameters:

message - the message as String

Returns:

this builder

withLink

public StandardMailBodyHelper.MailBodyBuilder withLink(String linkUrl,
 I18nizableText linkText)

Add a main link to be displayed as a button

Parameters:

linkUrl - the link url

linkText - the link text

Returns:

this builder

withFooterLink

public StandardMailBodyHelper.MailBodyBuilder withFooterLink(String linkUrl,
 I18nizableText linkText)

Add a link to be displayed on footer

Parameters:

linkUrl - the link url

linkText - the link text

Returns:

this builder

withFooterLink

public StandardMailBodyHelper.MailBodyBuilder withFooterLink(String linkUrl,
 I18nizableText linkText,
 String imgPluginName,
 String imgPath)

Add a link to be displayed on footer

Parameters:

linkUrl - the link url

linkText - the link text

imgPluginName - the plugin name that constains the image

imgPath - the path of the image in the plugin

Returns:

this builder

withFooterBottomText

public StandardMailBodyHelper.MailBodyBuilder withFooterBottomText(String footerText)

Set the text to display at footer bottom such as "Autogenerated email. Please do not answser"

Parameters:

footerText - The footer text as String

Returns:

this builder

withFooterBottomText

public StandardMailBodyHelper.MailBodyBuilder withFooterBottomText(I18nizableText footerText)

Set the text to display at footer bottom such as "Autogenerated email. Please do not answser"

Parameters:

footerText - The footer text as I18nizableText

Returns:

this builder

withUserInputs

public StandardMailBodyHelper.MailBodyBuilder withUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs)

Set the user action

Parameters:

userInputs - the users actions such as comments

Returns:

this builder

withUserInputs

public StandardMailBodyHelper.MailBodyBuilder withUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs,
 I18nizableText userInputHeader)

Set the user action

Parameters:

userInputs - the users actions such as comments

userInputHeader - The header text for user input

Returns:

this builder

addUserInputs

public StandardMailBodyHelper.MailBodyBuilder addUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs)

Add user inputs

Parameters:

userInputs - the users inputs such as comments

Returns:

this builder

addUserInputs

public StandardMailBodyHelper.MailBodyBuilder addUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UserInput> userInputs,
 I18nizableText userInputHeader)

Add user inputs

Parameters:

userInputs - the users inputs such as comments

userInputHeader - The header text for user input

Returns:

this builder

withUnauthenticatedUserInputs

public StandardMailBodyHelper.MailBodyBuilder withUnauthenticatedUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs)

Add an user input from a non-authenticated user

Parameters:

unauthenticatedUserInputs - the inputs such as comments

Returns:

this builder

withUnauthenticatedUserInputs

public StandardMailBodyHelper.MailBodyBuilder withUnauthenticatedUserInputs(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs,
 I18nizableText userInputHeader)

Add users inputs from non-authenticated users

Parameters:

unauthenticatedUserInputs - the inputs such as comments

userInputHeader - The header text for user input as String or I18nizableText

Returns:

this builder

addUnauthenticatedUserInput

public StandardMailBodyHelper.MailBodyBuilder addUnauthenticatedUserInput(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs)

Add users inputs from non-authenticated users

Parameters:

unauthenticatedUserInputs - the inputs such as comments

Returns:

this builder

addUnauthenticatedUserInput

public StandardMailBodyHelper.MailBodyBuilder addUnauthenticatedUserInput(List<StandardMailBodyHelper.MailBodyBuilder.UnauthenticatedUserInput> unauthenticatedUserInputs,
 I18nizableText userInputHeader)

Add users inputs from non-authenticated users

Parameters:

unauthenticatedUserInputs - the inputs such as comments

userInputHeader - The header text for user input as String or I18nizableText

Returns:

this builder

withDetails

public StandardMailBodyHelper.MailBodyBuilder withDetails(I18nizableText detailsTitle,
 String detailsText,
 boolean technical)

Set details or additional information to display in the mail

Parameters:

detailsTitle - the details title

detailsText - the details text

technical - true if details are technical details (such as an error stack trace, script result, ...)

Returns:

this builder

withDetails

public StandardMailBodyHelper.MailBodyBuilder withDetails(I18nizableText detailsTitle,
 I18nizableText detailsText,
 boolean technical)

Set details or additional information to display in the mail

Parameters:

detailsTitle - the details title

detailsText - the details text

technical - true if details are technical details (such as an error stack trace, script result, ...)

Returns:

this builder

build

public String build()
             throws IOException

Build the body of the email as HTML

Returns:

the HTML body

Throws:

IOException - if an error occurred when building the email

toJson

public Map<String,Object> toJson()

Get the JSON representation of the email ingredients

Returns:

the JSON ingredients