it-at-m · simonhir · Sep 3, 2024 · Aug 6, 2024 · Aug 6, 2024 · Aug 6, 2024
@@ -6,6 +6,8 @@ Collection of different integration which can be used as is in RefArch projects.
 
 - [s3-integration](./refarch-s3-integration/README.md): For CRUD operations on a s3 storage. Also used for file handling
   in other integrations.
+- [email-integration](./refarch-email-integration/README.md): For sending text and html emails with attachments. Uses
+  s3-integration for file handling.
 
 ## Naming conventions
 

@@ -19,6 +19,7 @@
 
     <modules>
         <module>refarch-s3-integration</module>
+        <module>refarch-email-integration</module>
     </modules>
 
     <properties>

@@ -0,0 +1,34 @@
+# RefArch email integration
+
+Integration for sending text and html emails with attachments. Uses [s3-integration](../refarch-s3-integration) for file
+handling.
+
+## Usage
+
+```xml
+
+<dependencies>
+    <dependency>
+        <groupId>de.muenchen.refarch</groupId>
+        <artifactId>refarch-email-integration-starter</artifactId>
+        <version>...</version>
+    </dependency>
+</dependencies>
+```
+
+and a [s3-integration starter](../refarch-s3-integration/README.md#usage).
+
+## Configuration
+
+### refarch-email-integration-starter
+
+| Property                                | Description                                       | Example                |
+|-----------------------------------------|---------------------------------------------------|------------------------|
+| `spring.mail.host`                      | Host of smtp server used for sending mails.       | `mail.example.com`     |
+| `spring.mail.port`                      | Host of smtp server used for sending mails.       | `1025`                 |
+| `spring.mail.username`                  | Username of smtp server.                          |                        |
+| `spring.mail.password`                  | Password of smtp server.                          |                        |
+| `refarch.mail.from-address`             | Default from address used when sending mails.     | `test@example.com`     |
+| `refarch.mail.default-reply-to-address` | Default reply to address used when sending mails. | `no_reply@example.com` |
+
+In addition, properties of selected [s3-integration starter](../refarch-s3-integration/README.md#usage).
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>de.muenchen.refarch</groupId>
+        <artifactId>refarch-integrations</artifactId>
+        <version>1.1.0-SNAPSHOT</version>
+    </parent>
+
+    <name>refarch-email-integration</name>
+    <artifactId>refarch-email-integration</artifactId>
+    <version>1.1.0-SNAPSHOT</version>
+    <packaging>pom</packaging>
+
+    <properties>
+        <jbig2-imageio.version>3.0.4</jbig2-imageio.version>
+        <jai-imageio-jpeg2000.version>1.4.0</jai-imageio-jpeg2000.version>
+    </properties>
+
+    <modules>
+        <module>refarch-email</module>
+        <module>refarch-email-integration-core</module>
+        <module>refarch-email-integration-starter</module>
+        <module>refarch-email-integration-rest-example</module>
+        <module>refarch-email-integration-java-example</module>
+    </modules>
+</project>
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <artifactId>refarch-email-integration</artifactId>
+        <groupId>de.muenchen.refarch</groupId>
+        <version>1.1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>refarch-email-integration-core</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>de.muenchen.refarch</groupId>
+            <artifactId>refarch-s3-integration-client-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>de.muenchen.refarch</groupId>
+            <artifactId>refarch-email-starter</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.pdfbox</groupId>
+            <artifactId>jbig2-imageio</artifactId>
+            <version>${jbig2-imageio.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.github.jai-imageio</groupId>
+            <artifactId>jai-imageio-jpeg2000</artifactId>
+            <version>${jai-imageio-jpeg2000.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>
@@ -0,0 +1,26 @@
+package de.muenchen.refarch.email.integration.adapter.out.mail;
+
+import de.muenchen.refarch.email.api.EmailApi;
+import de.muenchen.refarch.email.integration.application.port.out.MailOutPort;
+import de.muenchen.refarch.email.model.Mail;
+import freemarker.template.TemplateException;
+import jakarta.mail.MessagingException;
+import java.io.IOException;
+import java.util.Map;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+public class MailAdapter implements MailOutPort {
+
+    private final EmailApi emailApi;
+
+    @Override
+    public void sendMail(Mail mail, String logoPath) throws MessagingException {
+        this.emailApi.sendMail(mail, logoPath);
+    }
+
+    @Override
+    public String getBodyFromTemplate(String templateName, Map<String, Object> content) throws TemplateException, IOException {
+        return this.emailApi.getBodyFromTemplate(templateName, content);
+    }
+}
@@ -0,0 +1,73 @@
+package de.muenchen.refarch.email.integration.adapter.out.s3;
+
+import de.muenchen.refarch.email.integration.application.port.out.LoadMailAttachmentOutPort;
+import de.muenchen.refarch.email.integration.domain.exception.LoadAttachmentError;
+import de.muenchen.refarch.email.model.FileAttachment;
+import de.muenchen.refarch.integration.s3.client.exception.DocumentStorageClientErrorException;
+import de.muenchen.refarch.integration.s3.client.exception.DocumentStorageException;
+import de.muenchen.refarch.integration.s3.client.exception.DocumentStorageServerErrorException;
+import de.muenchen.refarch.integration.s3.client.repository.DocumentStorageFileRepository;
+import de.muenchen.refarch.integration.s3.client.repository.DocumentStorageFolderRepository;
+import de.muenchen.refarch.integration.s3.client.service.FileValidationService;
+import jakarta.mail.util.ByteArrayDataSource;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.io.FilenameUtils;
+
+@Slf4j
+@RequiredArgsConstructor
+public class S3Adapter implements LoadMailAttachmentOutPort {
+
+    private final DocumentStorageFileRepository documentStorageFileRepository;
+    private final DocumentStorageFolderRepository documentStorageFolderRepository;
+    private final FileValidationService fileValidationService;
+
+    @Override
+    public List<FileAttachment> loadAttachments(final List<String> filePaths) {
+        final List<FileAttachment> attachments = new ArrayList<>();
+        filePaths.forEach(path -> {
+            if (path.endsWith("/")) {
+                attachments.addAll(getFilesFromFolder(path));
+            } else {
+                attachments.add(getFile(path));
+            }
+        });
+        return attachments;
+    }
+
+    private List<FileAttachment> getFilesFromFolder(final String folderPath) {
+        try {
+            final List<FileAttachment> contents = new ArrayList<>();
+            final Set<String> filepath;
+            filepath = documentStorageFolderRepository.getAllFilesInFolderRecursively(folderPath);
+            if (Objects.isNull(filepath))
+                throw new LoadAttachmentError("An folder could not be loaded from url: " + folderPath);
+            filepath.forEach(file -> contents.add(getFile(file)));
+            return contents;
+        } catch (final DocumentStorageException | DocumentStorageServerErrorException | DocumentStorageClientErrorException e) {
+            throw new LoadAttachmentError("An folder could not be loaded from path: " + folderPath);
+        }
+    }
+
+    private FileAttachment getFile(final String filePath) {
+        try {
+            final byte[] bytes;
+            bytes = this.documentStorageFileRepository.getFile(filePath, 3);
+            final String mimeType = fileValidationService.detectFileType(bytes);
+            final String filename = FilenameUtils.getName(filePath);
+            final ByteArrayDataSource file = new ByteArrayDataSource(bytes, mimeType);
+
+            // check if mimeType exists
+            if (!fileValidationService.isSupported(mimeType))
+                throw new LoadAttachmentError("The type of this file is not supported: " + filePath);
+
+            return new FileAttachment(filename, file);
+        } catch (final DocumentStorageException | DocumentStorageServerErrorException | DocumentStorageClientErrorException e) {
+            throw new LoadAttachmentError("An file could not be loaded from path: " + filePath);
+        }
+    }
+}
@@ -0,0 +1,13 @@
+package de.muenchen.refarch.email.integration.application.port.in;
+
+import de.muenchen.refarch.email.integration.domain.model.TemplateMail;
+import de.muenchen.refarch.email.integration.domain.model.TextMail;
+import jakarta.validation.Valid;
+
+public interface SendMailInPort {
+
+    void sendMailWithText(@Valid final TextMail mail);
+
+    void sendMailWithTemplate(@Valid final TemplateMail mail);
+
+}
@@ -0,0 +1,8 @@
+package de.muenchen.refarch.email.integration.application.port.out;
+
+import de.muenchen.refarch.email.model.FileAttachment;
+import java.util.List;
+
+public interface LoadMailAttachmentOutPort {
+    List<FileAttachment> loadAttachments(final List<String> filePaths);
+}
@@ -0,0 +1,15 @@
+package de.muenchen.refarch.email.integration.application.port.out;
+
+import de.muenchen.refarch.email.model.Mail;
+import freemarker.template.TemplateException;
+import jakarta.mail.MessagingException;
+import java.io.IOException;
+import java.util.Map;
+
+public interface MailOutPort {
+
+    void sendMail(Mail mail, String logoPath) throws MessagingException;
+
+    String getBodyFromTemplate(String templateName, Map<String, Object> content) throws TemplateException, IOException;
+
+}
@@ -0,0 +1,89 @@
+package de.muenchen.refarch.email.integration.application.usecase;
+
+import de.muenchen.refarch.email.integration.application.port.in.SendMailInPort;
+import de.muenchen.refarch.email.integration.application.port.out.LoadMailAttachmentOutPort;
+import de.muenchen.refarch.email.integration.application.port.out.MailOutPort;
+import de.muenchen.refarch.email.integration.domain.exception.TemplateError;
+import de.muenchen.refarch.email.integration.domain.model.BasicMail;
+import de.muenchen.refarch.email.integration.domain.model.TemplateMail;
+import de.muenchen.refarch.email.integration.domain.model.TextMail;
+import de.muenchen.refarch.email.model.FileAttachment;
+import freemarker.template.TemplateException;
+import jakarta.mail.MessagingException;
+import jakarta.validation.Valid;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.mail.MailSendException;
+import org.springframework.validation.annotation.Validated;
+
+@Slf4j
+@RequiredArgsConstructor
+@Validated
+public class SendMailUseCase implements SendMailInPort {
+
+    private final LoadMailAttachmentOutPort loadAttachmentOutPort;
+    private final MailOutPort mailOutPort;
+
+    /**
+     * Send a mail.
+     *
+     * @param mail mail that is sent
+     */
+    @Override
+    public void sendMailWithText(@Valid final TextMail mail) {
+        de.muenchen.refarch.email.model.Mail mailModel = createMail(mail);
+        mailModel.setBody(mail.getBody());
+
+        this.sendMail(mailModel, null);
+    }
+
+    @Override
+    public void sendMailWithTemplate(@Valid final TemplateMail mail) throws TemplateError {
+        // get body from template
+        try {
+            Map<String, Object> content = new HashMap<>(mail.getContent());
+            content.put("footer", "DigiWF 2.0<br>IT-Referat der Stadt München");
+            String body = this.mailOutPort.getBodyFromTemplate(mail.getTemplate(), content);
+
+            de.muenchen.refarch.email.model.Mail mailModel = createMail(mail);
+            mailModel.setBody(body);
+            mailModel.setHtmlBody(true);
+
+            this.sendMail(mailModel, "templates/email-logo.png");
+
+        } catch (IOException ioException) {
+            throw new TemplateError("The template " + mail.getTemplate() + " could not be loaded");
+        } catch (TemplateException templateException) {
+            throw new TemplateError(templateException.getMessage());
+        }
+    }
+
+    private de.muenchen.refarch.email.model.Mail createMail(BasicMail mail) {
+        // load Attachments
+        List<FileAttachment> attachments = loadAttachmentOutPort.loadAttachments(mail.getFilePaths());
+
+        // send mail
+        return de.muenchen.refarch.email.model.Mail.builder()
+                .receivers(mail.getReceivers())
+                .subject(mail.getSubject())
+                .replyTo(mail.getReplyTo())
+                .receiversCc(mail.getReceiversCc())
+                .receiversBcc(mail.getReceiversBcc())
+                .attachments(attachments)
+                .build();
+    }
+
+    private void sendMail(de.muenchen.refarch.email.model.Mail mailModel, String logoPath) throws MailSendException {
+        try {
+            this.mailOutPort.sendMail(mailModel, logoPath);
+        } catch (final MessagingException ex) {
+            log.error("Sending mail failed with exception: {}", ex.getMessage());
+            throw new MailSendException(ex.getMessage());
+        }
+    }
+
+}
@@ -0,0 +1,7 @@
+package de.muenchen.refarch.email.integration.domain.exception;
+
+public class LoadAttachmentError extends Error {
+    public LoadAttachmentError(final String message) {
+        super(message);
+    }
+}
@@ -0,0 +1,7 @@
+package de.muenchen.refarch.email.integration.domain.exception;
+
+public class TemplateError extends Error {
+    public TemplateError(final String message) {
+        super(message);
+    }
+}