Package org.ametys.web.mail

Class ReportActivitiesMailBodyHelper.MailBodyBuilder

java.lang.Object

org.ametys.web.mail.ReportActivitiesMailBodyHelper.MailBodyBuilder

Enclosing class:

ReportActivitiesMailBodyHelper

public static class ReportActivitiesMailBodyHelper.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	ReportActivitiesMailBodyHelper.MailBodyBuilder.Activity	Record for an activity

Method Summary

Modifier and Type	Method	Description
ReportActivitiesMailBodyHelper.MailBodyBuilder	addActivity(ReportActivitiesMailBodyHelper.MailBodyBuilder.Activity activity)	Add an activity
ReportActivitiesMailBodyHelper.MailBodyBuilder	addMessage(Object message)	Add a new message
String	build()	Build the body of the email as HTML
Map<String,Object>	toJson()	Get the JSON representation of the email ingredients
ReportActivitiesMailBodyHelper.MailBodyBuilder	withActivities(List<ReportActivitiesMailBodyHelper.MailBodyBuilder.Activity> activities)	Set the activities
ReportActivitiesMailBodyHelper.MailBodyBuilder	withFooterLink(String linkUrl, I18nizableText linkText)	Add a link to be displayed on footer
ReportActivitiesMailBodyHelper.MailBodyBuilder	withFooterLink(String linkUrl, I18nizableText linkText, String imgPluginName, String imgPath)	Add a link to be displayed on footer
ReportActivitiesMailBodyHelper.MailBodyBuilder	withLanguage(String lang)	Set the language
ReportActivitiesMailBodyHelper.MailBodyBuilder	withLink(String linkUrl, I18nizableText linkText)	Add a main link to be displayed as a button
ReportActivitiesMailBodyHelper.MailBodyBuilder	withMessage(Object message)	Set the main message
ReportActivitiesMailBodyHelper.MailBodyBuilder	withTitle(Object title)	Set the title

Methods inherited from class java.lang.Object

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

Method Details

withLanguage

public ReportActivitiesMailBodyHelper.MailBodyBuilder withLanguage(String lang)

Set the language

Parameters:

lang - the language

Returns:

this builder

withTitle

public ReportActivitiesMailBodyHelper.MailBodyBuilder withTitle(Object title)

Set the title

Parameters:

title - the title as String or I18nizableText

Returns:

this builder

withMessage

public ReportActivitiesMailBodyHelper.MailBodyBuilder withMessage(Object message)

Set the main message

Parameters:

message - the message as String or I18nizableText

Returns:

this builder

addMessage

public ReportActivitiesMailBodyHelper.MailBodyBuilder addMessage(Object message)

Add a new message

Parameters:

message - the message as String or I18nizableText

Returns:

this builder

withActivities

public ReportActivitiesMailBodyHelper.MailBodyBuilder withActivities(List<ReportActivitiesMailBodyHelper.MailBodyBuilder.Activity> activities)

Set the activities

Parameters:

activities - the activities

Returns:

this builder

addActivity

public ReportActivitiesMailBodyHelper.MailBodyBuilder addActivity(ReportActivitiesMailBodyHelper.MailBodyBuilder.Activity activity)

Add an activity

Parameters:

activity - the activity

Returns:

this builder

withLink

public ReportActivitiesMailBodyHelper.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 ReportActivitiesMailBodyHelper.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 ReportActivitiesMailBodyHelper.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

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