# jensknipper/greenmail-example architecture

> Architecture diagram of the GitHub repository jensknipper/greenmail-example, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jensknipper/greenmail-example
- Repository: https://github.com/jensknipper/greenmail-example

## Overview

##### Main Components

a) Application Layer Components:
- Web Interface (Spring Boot application)
- Management System
- Email Processing System
- Database Layer

b) External Components:
- GreenMail Mock SMTP Server
- RoundCube Webmail Client
- Docker Environment

##### Connection and Flow Representation

**User → Web Interface → Note Management → Database**
**User → RoundCube → GreenMail ⟷ Email System → Note Management**
**MailReceiveScheduler → GreenMail (periodic checking)**

##### Technical Details

Annotations for:
- Port numbers (8080, 8000)
- Key Spring Boot components
- Docker container relationships
- Test components and their interaction

##### The Docker-based infrastructure

Remember to indicate the testing components (in src/test) that verify the email functionality, as this is a crucial aspect of the project's architecture.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Docker Environment"
        subgraph "Presentation Layer"
            WebUI["Web Interface (8080)"]:::web
            RoundCube["RoundCube Webmail (8000)"]:::web
        end

        subgraph "Application Layer"
            subgraph "Note Management"
                ViewController["View Controller"]:::controller
                NoteRepo["Note Repository"]:::repository
                NoteModel["Note Model"]:::model
                WebDTO["Web DTO"]:::dto
            end

            subgraph "Email System"
                MailSend["Mail Send Client"]:::mail
                MailReceive["Mail Receive Client"]:::mail
                MailScheduler["Mail Receive Scheduler"]:::mail
                NoteMailClient["Note Mail Client"]:::mail
                MailMapper["Mail Mapper"]:::mail
                MailModel["Mail Model"]:::model
            end
        end

        subgraph "Infrastructure Layer"
            GreenMail["GreenMail Mock SMTP"]:::infra
            DB[(Database)]:::db
        end
    end

    %% Connections
    WebUI --> ViewController
    ViewController --> NoteRepo
    ViewController --> WebDTO
    NoteRepo --> NoteModel
    RoundCube --> GreenMail
    GreenMail <--> MailReceive
    GreenMail <--> MailSend
    MailScheduler --> MailReceive
    MailReceive --> NoteMailClient
    MailSend --> NoteMailClient
    NoteMailClient --> MailMapper
    MailMapper --> NoteRepo
    NoteRepo --> DB
    MailModel --> MailMapper

    %% Click Events
    click ViewController "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/web/ViewController.java"
    click WebDTO "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/web/dto/NoteDto.java"
    click NoteRepo "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/persistence/NoteRepository.java"
    click NoteModel "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/model/Note.java"
    click MailSend "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/mail/send/MailSendClient.java"
    click MailReceive "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/mail/receive/MailReceiveClient.java"
    click MailScheduler "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/mail/scheduler/MailReceiveScheduler.java"
    click NoteMailClient "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/mail/NoteMailClient.java"
    click MailMapper "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/control/mail/mapper/MailMapper.java"
    click MailModel "https://github.com/JensKnipper/greenmail-example/blob/main/src/main/java/de/jensknipper/greenmailexample/model/Mail.java"

    %% Styles
    classDef web fill:#2196F3,stroke:#1565C0,color:white
    classDef controller fill:#4CAF50,stroke:#2E7D32,color:white
    classDef repository fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef model fill:#FF9800,stroke:#EF6C00,color:white
    classDef dto fill:#00BCD4,stroke:#00838F,color:white
    classDef mail fill:#FFC107,stroke:#FFA000,color:black
    classDef infra fill:#607D8B,stroke:#455A64,color:white
    classDef db fill:#795548,stroke:#4E342E,color:white
```
