Class EMailService

java.lang.Object

de.gustavblass.fsu.fmi.roombooking.service.EMailService

@Service
public class EMailService
extends Object

Sends e-mails to Actors when something of relevance happens.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EMailService.Template	Represents the templates available for e-mails to be sent to end users.

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull org.springframework.core.env.Environment	environment	Used by certain e-mail templates.
private final @NonNull org.springframework.mail.javamail.JavaMailSender	mailSender	Used to actually send the e-mails.
private final @NonNull org.springframework.context.MessageSource	messageSource	Used to translate the e-mail subject.
private final @NonNull String	senderAddress	The e-mail address of the account from which the e-mails are sent.
private final @NonNull org.thymeleaf.TemplateEngine	templateEngine	Used to construct the actual content s of the e-mails.

Constructor Summary

Constructors

Constructor	Description
EMailService(@NonNull org.springframework.mail.javamail.JavaMailSender mailSender, @NonNull String senderAddress, @NonNull org.springframework.context.MessageSource messageSource, @NonNull org.thymeleaf.TemplateEngine eMailTemplateEngine, @NonNull org.springframework.core.env.Environment environment)	Constructs a new EMailService.

Method Summary

Modifier and Type	Method	Description
void	onEMailChange(@NonNull EMailChangeEvent event)	Sends an e-mail to the EMailChangeEvent.EMailChange.actor asking them to open the link with the EMailChangeEvent.EMailChange.verificationToken, in order to verify their new e-mail address.
void	onRegistration(@NonNull UnconfirmedRegistrationEvent event)	Sends an e-mail to the new ActorCreatedEvent.actor asking them to open the link with the UnconfirmedRegistrationEvent.verificationToken, in order to verify their Actor.eMailAddress.
void	onReservationConfirmation(@NonNull ReservationConfirmedEvent event)	Sends an e-mail to the Reservation.applicant telling them that their new Reservation was just accepted by the server.
private void	prepareMail(@NonNull org.springframework.mail.javamail.MimeMessageHelper mail, @NonNull String recipient, @NonNull String subject, @NonNull Locale locale)	Adds the given recipient and subject to the given MimeMessageHelper in the given Locale.
private void	sendEMail(@NonNull String recipientAddress, @NonNull String subject, @NonNull EMailService.Template template, @NonNull org.thymeleaf.context.Context context, @NonNull Locale locale)	Sends an e-mail to the given recipient's address, with the given subject and content in the given language.

Methods inherited from class Object

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

Field Details

mailSender

@NonNull
private final @NonNull org.springframework.mail.javamail.JavaMailSender mailSender

Used to actually send the e-mails.

senderAddress

@NonNull
private final @NonNull String senderAddress

The e-mail address of the account from which the e-mails are sent.

messageSource

@NonNull
private final @NonNull org.springframework.context.MessageSource messageSource

Used to translate the e-mail subject.

templateEngine

@NonNull
private final @NonNull org.thymeleaf.TemplateEngine templateEngine

Used to construct the actual content s of the e-mails.

environment

@NonNull
private final @NonNull org.springframework.core.env.Environment environment

Used by certain e-mail templates.

Constructor Details

EMailService

public EMailService(@NonNull
 @NonNull org.springframework.mail.javamail.JavaMailSender mailSender,
 @NonNull @Value("${spring.mail.username:}")
 @NonNull String senderAddress,
 @NonNull
 @NonNull org.springframework.context.MessageSource messageSource,
 @NonNull
 @NonNull org.thymeleaf.TemplateEngine eMailTemplateEngine,
 @NonNull
 @NonNull org.springframework.core.env.Environment environment)

Constructs a new EMailService.

Parameters:

mailSender - The mailSender.

senderAddress - The senderAddress.

messageSource - The messageSource.

eMailTemplateEngine - The templateEngine.

environment - The environment.

Method Details

onRegistration

@Async
@EventListener
public void onRegistration(@NonNull
 @NonNull UnconfirmedRegistrationEvent event)
                    throws IllegalStateException,
IOException

Sends an e-mail to the new ActorCreatedEvent.actor asking them to open the link with the UnconfirmedRegistrationEvent.verificationToken, in order to verify their Actor.eMailAddress.

Parameters:

event - The event when the new Actor signed up.

Throws:

IllegalStateException - If the senderAddress or Actor.eMailAddress is invalid for some reason or if the e-mail subject or text cannot be generated.

IOException - If the e-mail could not be sent.

onEMailChange

@Async
@EventListener
public void onEMailChange(@NonNull
 @NonNull EMailChangeEvent event)
                   throws IllegalStateException,
IOException

Sends an e-mail to the EMailChangeEvent.EMailChange.actor asking them to open the link with the EMailChangeEvent.EMailChange.verificationToken, in order to verify their new e-mail address.

Parameters:

event - The event when the Actor requested to have their e-mail address updated.

Throws:

IllegalStateException - If the senderAddress or the new e-mail address is invalid for some reason or if the e-mail subject or text cannot be generated.

IOException - If the e-mail could not be sent.

onReservationConfirmation

@Async
@EventListener
public void onReservationConfirmation(@NonNull
 @NonNull ReservationConfirmedEvent event)
                               throws IllegalStateException,
IOException

Sends an e-mail to the Reservation.applicant telling them that their new Reservation was just accepted by the server. The e-mail includes useful information, especially the Reservation's details.

Parameters:

event - The event when the Actor's Reservation was confirmed.

Throws:

IllegalStateException - If the senderAddress or the new e-mail address is invalid for some reason or if the e-mail subject or text cannot be generated.

IOException - If the e-mail could not be sent.

sendEMail

private void sendEMail(@NonNull
 @NonNull String recipientAddress,
 @NonNull
 @NonNull String subject,
 @NonNull
 @NonNull EMailService.Template template,
 @NonNull
 @NonNull org.thymeleaf.context.Context context,
 @NonNull
 @NonNull Locale locale)
                throws IllegalStateException,
IOException

Sends an e-mail to the given recipient's address, with the given subject and content in the given language.

Parameters:

recipientAddress - The e-mail address to which the e-mail shall be sent.

subject - What the e-mail is about. Must only be a one-liner.

template - The EMailService.Template that shall be used to format the message.

context - The content with which the template shall be filled.

locale - The language in which the e-mail shall be sent.

Throws:

IllegalStateException - If the senderAddress or the new e-mail address is invalid for some reason or if the e-mail subject or text cannot be generated.

IOException - If the e-mail could not be sent.

prepareMail

private void prepareMail(@NonNull
 @NonNull org.springframework.mail.javamail.MimeMessageHelper mail,
 @NonNull
 @NonNull String recipient,
 @NonNull
 @NonNull String subject,
 @NonNull
 @NonNull Locale locale)
                  throws IllegalStateException,
de.gustavblass.commons.exceptions.IllegalArgumentException

Adds the given recipient and subject to the given MimeMessageHelper in the given Locale.

Parameters:

mail - The e-mail that shall be prepared.

recipient - The e-mail address to which the mail will be sent at some point (not by this method).

subject - The MimeMessage.getSubject().

locale - The language in which the e-mail will be.

Throws:

IllegalStateException - If the senderAddress is invalid or if the subject cannot be built.

de.gustavblass.commons.exceptions.IllegalArgumentException - If the given recipient's e-mail address is invalid.