ru.dlabs71.library.email.dto.message.outgoing

Class TemplatedOutgoingMessage

java.lang.Object

ru.dlabs71.library.email.dto.message.common.BaseMessage

ru.dlabs71.library.email.dto.message.outgoing.DefaultOutgoingMessage

ru.dlabs71.library.email.dto.message.outgoing.TemplatedOutgoingMessage

All Implemented Interfaces:

Message, OutgoingMessage

public class TemplatedOutgoingMessage
extends DefaultOutgoingMessage

This class describes a templated outgoing email message. It extends the DefaultOutgoingMessage.

The template will be created using the Apache Velocity Project.

Project name: d-email

Creation date: 2023-08-27

Since:

1.0.0

Author:

Ivanov Danila

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplatedOutgoingMessage.TemplatedMessageBuilder Builder of this class.

Nested classes/interfaces inherited from class ru.dlabs71.library.email.dto.message.outgoing.DefaultOutgoingMessage

DefaultOutgoingMessage.Builder

Constructor Summary

Constructors

Constructor and Description
TemplatedOutgoingMessage(String subject, String pathToTemplate, Map<String,Object> params, Charset charsetContent, ContentMessageType contentType, Set<EmailParticipant> recipientEmail) The constructor if this message.
TemplatedOutgoingMessage(String subject, String pathToTemplate, Map<String,Object> params, Charset charsetContent, ContentMessageType contentType, Set<EmailParticipant> recipientEmail, List<EmailAttachment> attachments, TransferEncoder transferEncoder) The constructor if this message.
TemplatedOutgoingMessage(String subject, String pathToTemplate, Map<String,Object> params, Set<EmailParticipant> recipientEmail) The constructor if this message.
TemplatedOutgoingMessage(String subject, String pathToTemplate, Map<String,Object> params, Set<EmailParticipant> recipientEmail, List<EmailAttachment> attachments) The constructor if this message.

Method Summary

Modifier and Type	Method and Description
static TemplatedOutgoingMessage.TemplatedMessageBuilder	builder() Returns an instance of the builder for this class.
protected String	constructContent(String path, Map<String,Object> params) Creates text content from a path to a templated file and parameters for this one.
String	toString()

Methods inherited from class ru.dlabs71.library.email.dto.message.outgoing.DefaultOutgoingMessage

outgoingMessageBuilder

Methods inherited from class ru.dlabs71.library.email.dto.message.common.BaseMessage

addAllContent, addContent, getAllContentsAsString, getAllContentsAsString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ru.dlabs71.library.email.dto.message.common.Message

getAttachments, getContents, getId, getReceivedDate, getRecipients, getSender, getSentDate, getSize, getSubject, getTransferEncoder, isSeen

Constructor Detail

TemplatedOutgoingMessage

public TemplatedOutgoingMessage(String subject,
                                String pathToTemplate,
                                Map<String,Object> params,
                                Set<EmailParticipant> recipientEmail)
                         throws TemplateCreationException

The constructor if this message. Creates an instance with a html content. Html content will be created using Apache Velocity Template.

Parameters:

subject - a subject of a message

pathToTemplate - a path to template. See TemplateUtils.createTemplate(String).

params - parameters of a template

recipientEmail - message recipients

Throws:

TemplateCreationException - if content from the template wasn't can construct.

TemplatedOutgoingMessage

public TemplatedOutgoingMessage(String subject,
                                String pathToTemplate,
                                Map<String,Object> params,
                                Set<EmailParticipant> recipientEmail,
                                List<EmailAttachment> attachments)
                         throws TemplateCreationException

The constructor if this message. Creates an instance with a html content. Html content will be created using Apache Velocity Template.

Parameters:

subject - a subject of a message

pathToTemplate - a path to template. See TemplateUtils.createTemplate(String).

params - parameters of a template

recipientEmail - message recipients

attachments - message attached files

Throws:

TemplateCreationException - if content from the template wasn't can construct.

TemplatedOutgoingMessage

public TemplatedOutgoingMessage(String subject,
                                String pathToTemplate,
                                Map<String,Object> params,
                                Charset charsetContent,
                                ContentMessageType contentType,
                                Set<EmailParticipant> recipientEmail)
                         throws TemplateCreationException

The constructor if this message. Creates an instance with a html content. Html content will be created using Apache Velocity Template.

Parameters:

subject - a subject of a message

pathToTemplate - a path to template. See TemplateUtils.createTemplate(String).

params - parameters of a template

charsetContent - a charset of the content

contentType - a value of a Content-Type header for content

recipientEmail - message recipients

Throws:

TemplateCreationException - if content from the template wasn't can construct.

TemplatedOutgoingMessage

public TemplatedOutgoingMessage(String subject,
                                String pathToTemplate,
                                Map<String,Object> params,
                                Charset charsetContent,
                                ContentMessageType contentType,
                                Set<EmailParticipant> recipientEmail,
                                List<EmailAttachment> attachments,
                                TransferEncoder transferEncoder)
                         throws TemplateCreationException

The constructor if this message. Creates an instance with a html content. Html content will be created using Apache Velocity Template.

Parameters:

subject - a subject of a message

pathToTemplate - a path to template. See TemplateUtils.createTemplate(String).

params - parameters of a template

charsetContent - a charset of the content

contentType - a value of a Content-Type header for content

recipientEmail - message recipients

attachments - message attached files

transferEncoder - a value for a Content-Transfer-Encoding header

Throws:

TemplateCreationException - if content from the template wasn't can construct.

Method Detail

builder

public static TemplatedOutgoingMessage.TemplatedMessageBuilder builder()

Returns an instance of the builder for this class.

constructContent

protected String constructContent(String path,
                                  Map<String,Object> params)
                           throws TemplateCreationException

Creates text content from a path to a templated file and parameters for this one.

Throws:

TemplateCreationException

toString

public String toString()

Overrides:

toString in class DefaultOutgoingMessage