ru.dlabs71.library.email

Class DEmailSender

java.lang.Object

ru.dlabs71.library.email.DEmailSender

public final class DEmailSender
extends Object

This class implements the Facade pattern for sending email messages. This class use the SMTP protocol.

Project name: d-email

Creation date: 2023-09-18

Since:

1.0.0

Author:

Ivanov Danila

Method Summary

Modifier and Type	Method and Description
static DEmailSender	of(SmtpProperties properties) Creates instance of the DEmailSender class.
SendingStatus	send(OutgoingMessage message) The common method for sending OutgoingMessage messages.
SendingStatus	send(Set<EmailParticipant> recipients, String subject, String content, ContentMessageType contentType, Charset charsetContent, List<EmailAttachment> attachments) The common method is sending a text message.
EmailParticipant	sender() Returns information about sender as object of the class EmailParticipant.
SendingStatus	sendHtml(Collection<String> emails, String subject, String content) The method is distributing a message to a group recipients.
SendingStatus	sendHtml(Collection<String> emails, String subject, String content, EmailAttachment... attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendHtml(Collection<String> emails, String subject, String content, List<EmailAttachment> attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendHtml(Set<EmailParticipant> recipients, String subject, String content, List<EmailAttachment> attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendHtml(Set<String> emails, String subject, String content, EmailAttachment... attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendHtml(String email, String subject, String content) The method is sending a message.
SendingStatus	sendHtml(String email, String subject, String content, EmailAttachment... attachments) The method is sending a message with attachments.
SendingStatus	sendHtml(String email, String subject, String content, List<EmailAttachment> attachments) The method is sending a message with attachments.
SendingStatus	sendHtmlTemplated(Collection<String> emails, String subject, String pathToTemplate, Map<String,Object> params) The method is distributing a message to a group recipients.
SendingStatus	sendHtmlTemplated(Collection<String> emails, String subject, String pathToTemplate, Map<String,Object> params, EmailAttachment... attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendHtmlTemplated(Collection<String> emails, String subject, String pathToTemplate, Map<String,Object> params, List<EmailAttachment> attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendHtmlTemplated(Set<EmailParticipant> recipients, String subject, String pathToTemplate, Map<String,Object> params, List<EmailAttachment> attachments) The method is distributing a message to a group of recipients with attachments.
SendingStatus	sendHtmlTemplated(String email, String subject, String pathToTemplate, Map<String,Object> params) The method is sending a message.
SendingStatus	sendHtmlTemplated(String email, String subject, String pathToTemplate, Map<String,Object> params, EmailAttachment... attachments) The method is sending a message with attachments.
SendingStatus	sendHtmlTemplated(String email, String subject, String pathToTemplate, Map<String,Object> params, List<EmailAttachment> attachments) The method is sending a message with attachments.
SendingStatus	sendTemplatedMessage(Set<EmailParticipant> recipients, String subject, String pathToTemplate, Map<String,Object> params, ContentMessageType contentType, Charset charsetContent, List<EmailAttachment> attachments) The common method is sending a templated message.
SendingStatus	sendText(Collection<String> emails, String subject, String content) The method is distributing a message to a group recipients.
SendingStatus	sendText(Collection<String> emails, String subject, String content, EmailAttachment... attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendText(Collection<String> emails, String subject, String content, List<EmailAttachment> attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendText(Set<EmailParticipant> recipients, String subject, String content, List<EmailAttachment> attachments) The method is distributing a message to a group recipients with attachments.
SendingStatus	sendText(String email, String subject, String content) The method is sending a message.
SendingStatus	sendText(String email, String subject, String content, EmailAttachment... attachments) The method is sending a message with attachments.
SendingStatus	sendText(String email, String subject, String content, List<EmailAttachment> attachments) The method is sending a message with attachments.
SendingStatus	sendTextTemplated(Collection<String> emails, String subject, String pathToTemplate, Map<String,Object> params) The method is distributing a message to a group of recipients.
SendingStatus	sendTextTemplated(Collection<String> emails, String subject, String pathToTemplate, Map<String,Object> params, EmailAttachment... attachments) The method is distributing a message to a group of recipients with attachments.
SendingStatus	sendTextTemplated(Collection<String> emails, String subject, String pathToTemplate, Map<String,Object> params, List<EmailAttachment> attachments) The method is distributing a message to a group of recipients with attachments.
SendingStatus	sendTextTemplated(Set<EmailParticipant> recipients, String subject, String pathToTemplate, Map<String,Object> params, List<EmailAttachment> attachments) The method is distributing a message to a group of recipients with attachments.
SendingStatus	sendTextTemplated(String email, String subject, String pathToTemplate, Map<String,Object> params) The method is sending a message.
SendingStatus	sendTextTemplated(String email, String subject, String pathToTemplate, Map<String,Object> params, EmailAttachment... attachments) The method is sending a message with attachments.
SendingStatus	sendTextTemplated(String email, String subject, String pathToTemplate, Map<String,Object> params, List<EmailAttachment> attachments) The method is sending a message with attachments.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static DEmailSender of(SmtpProperties properties)

Creates instance of the DEmailSender class.

Parameters:

properties - properties for connecting to an email server by the SMTP protocol (SmtpProperties)

Returns:

object of the class DEmailSender

sender

public EmailParticipant sender()

Returns information about sender as object of the class EmailParticipant.

Returns:

the object of the class EmailParticipant

sendText

public SendingStatus sendText(String email,
                              String subject,
                              String content)

The method is sending a message.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

Returns:

a sending status SendingStatus

sendText

public SendingStatus sendText(Collection<String> emails,
                              String subject,
                              String content)

The method is distributing a message to a group recipients.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

Returns:

a sending status SendingStatus

sendText

public SendingStatus sendText(Collection<String> emails,
                              String subject,
                              String content,
                              EmailAttachment... attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendText

public SendingStatus sendText(Collection<String> emails,
                              String subject,
                              String content,
                              List<EmailAttachment> attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendText

public SendingStatus sendText(String email,
                              String subject,
                              String content,
                              EmailAttachment... attachments)

The method is sending a message with attachments.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendText

public SendingStatus sendText(String email,
                              String subject,
                              String content,
                              List<EmailAttachment> attachments)

The method is sending a message with attachments.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendText

public SendingStatus sendText(Set<EmailParticipant> recipients,
                              String subject,
                              String content,
                              List<EmailAttachment> attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/plain.

A message body takes from "content" argument. It has a type String.

Parameters:

recipients - the set of information about recipients (EmailParticipant)

subject - a subject of a message

content - a message body

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(String email,
                              String subject,
                              String content)

The method is sending a message.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(Collection<String> emails,
                              String subject,
                              String content)

The method is distributing a message to a group recipients.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(Set<String> emails,
                              String subject,
                              String content,
                              EmailAttachment... attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(Collection<String> emails,
                              String subject,
                              String content,
                              List<EmailAttachment> attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(Collection<String> emails,
                              String subject,
                              String content,
                              EmailAttachment... attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(String email,
                              String subject,
                              String content,
                              EmailAttachment... attachments)

The method is sending a message with attachments.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(String email,
                              String subject,
                              String content,
                              List<EmailAttachment> attachments)

The method is sending a message with attachments.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

content - a message body

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtml

public SendingStatus sendHtml(Set<EmailParticipant> recipients,
                              String subject,
                              String content,
                              List<EmailAttachment> attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/html.

A message body takes from "content" argument. It has a type String.

Parameters:

recipients - the set of information about recipients (EmailParticipant)

subject - a subject of a message

content - a message body

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(String email,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params)

The method is sending a message.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(Collection<String> emails,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params)

The method is distributing a message to a group recipients.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(Collection<String> emails,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       EmailAttachment... attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(Collection<String> emails,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       List<EmailAttachment> attachments)

The method is distributing a message to a group recipients with attachments.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(String email,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       EmailAttachment... attachments)

The method is sending a message with attachments.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(String email,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       List<EmailAttachment> attachments)

The method is sending a message with attachments.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendHtmlTemplated

public SendingStatus sendHtmlTemplated(Set<EmailParticipant> recipients,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       List<EmailAttachment> attachments)

The method is distributing a message to a group of recipients with attachments.

A message body has a content type of text/html.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

recipients - the set of information about recipients (EmailParticipant)

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(String email,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params)

The method is sending a message.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(Collection<String> emails,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params)

The method is distributing a message to a group of recipients.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(Collection<String> emails,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       EmailAttachment... attachments)

The method is distributing a message to a group of recipients with attachments.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(Collection<String> emails,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       List<EmailAttachment> attachments)

The method is distributing a message to a group of recipients with attachments.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

emails - a collection of recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(String email,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       EmailAttachment... attachments)

The method is sending a message with attachments.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - an array of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(String email,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       List<EmailAttachment> attachments)

The method is sending a message with attachments.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

email - a recipient email address. For example: example@mail.com

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendTextTemplated

public SendingStatus sendTextTemplated(Set<EmailParticipant> recipients,
                                       String subject,
                                       String pathToTemplate,
                                       Map<String,Object> params,
                                       List<EmailAttachment> attachments)

The method is distributing a message to a group of recipients with attachments.

A message body has a content type of text/plain.

A message body is created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Parameters:

recipients - the set of information about recipients (EmailParticipant)

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

sendTemplatedMessage

public SendingStatus sendTemplatedMessage(Set<EmailParticipant> recipients,
                                          String subject,
                                          String pathToTemplate,
                                          Map<String,Object> params,
                                          ContentMessageType contentType,
                                          Charset charsetContent,
                                          List<EmailAttachment> attachments)

The common method is sending a templated message.

A message body created using the Apache Velocity Template engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

For simplifying attachment creation, use the AttachmentUtils utility class

Parameters:

recipients - the set of information about recipients (EmailParticipant)

subject - a subject of a message

pathToTemplate - a path to template

params - parameters for the template

contentType - the content type of content

charsetContent - the encoding of content

attachments - a list of attachments (EmailAttachment)

Returns:

a sending status SendingStatus

send

public SendingStatus send(Set<EmailParticipant> recipients,
                          String subject,
                          String content,
                          ContentMessageType contentType,
                          Charset charsetContent,
                          List<EmailAttachment> attachments)

The common method is sending a text message.

For simplifying attachment creation, use the AttachmentUtils utility class

Parameters:

recipients - the set of recipients

subject - the message subject

content - the message body

attachments - a list of attachments

Returns:

a sending status SendingStatus

send

public SendingStatus send(OutgoingMessage message)

The common method for sending OutgoingMessage messages.

Parameters:

message - an outgoing message

Returns:

a sending status SendingStatus