josdem / jmailer-spring-boot

Send email from everywhere!

Jmailer Spring Boot

Send email from everywhere!

Features

• You can send an email using curl, httpie, or using a script
• You can send an email using a mobile application
• You can send an email using a form in your website
• You can send an email using a file with an email list addresses

Swagger

https://jmailer.josdem.io/swagger-ui.html

Go here for more information

• https://jmailer.josdem.io/

To Run, Call and Configuration

• https://github.com/josdem/jmailer-spring-boot/wiki

jmailer-spring-boot's Issues

Split email model

Todo

• Message model is mixed with form model, split to have a better structure
• Make sure you can send emails from form websites

Activate blacklist

Todo

• Create a blacklist to filter spam emails
• Create filters to identify spam

Create a Jenkins pipeline to deploy automatically the service

Todo

• Create SSH key to authenticate jenkins server to the jmailer host server
• Create a Jenkins job to build and deploy
• Create Jenkins pipeline file to define stages, see this project as reference: jugoterapia-services-pipeline

Update Spring Boot to the latest version

Fix Thymeleaf templates

Todo

• Fix Thymeleaf templates
• Add requred header to the forms

Move redirect from server to client

Move test cases from Spock to Junit5

Todo

• Move unit test cases to Junit5

Update Swagger

Todo

• Update Swagger from 2.4.0 to 3.0.0
• Update Swagger UI from 2.4.0 to 2.9.2
• Update Swagger annotations

Fix misspell in confirmation email

Configure Embeddable Build Status

Todo

Currently, in the README.md file in the repository, we have an image as a job build badge, configure Embeddable Build Status instead.

Acceptance Criteria

I am able to see the badge status when I run a new build in Jenkins

Create template to send adoption message

Add npm dependencies

Todo

• Fix Bower plugin to grab JavaScript dependencies

Migrate from Groovy to Kotlin Gradle build scripts

Todo
Since April 2023, Kotlin DSL is the default for new Gradle builds; therefore, we want to migrate our build scripts from Groovy to Gradle.

Reference

• Kotlin DSL for Gradle
• Migrating build Groovy to Kotlin guide

Acceptance Criteria

• Kotlin DSL is the build.gradle language
• Able to run service and web test cases
• Able to build the project
• Able to execute JacocoReports

Move to Google cloud

Create simple Github Actions CI that will run application tests

https://docs.github.com/en/actions/quickstart

Add forgot password template

Update command/script command-line page documentation

Todo

• Add ask for token information
• Add Swagger documentation

Fixing some imports

Create entity `EmailValidator` to validate email content business logic

Todo

• Create a service interface EmailValidatorService with public method validate
• Create service implementation EmailValidatorServiceImpl to validate:
  • If the email body contains spam
  • If the email subject contains spam
• Move this logic from CommandValidator to email validator service implementation

`EmailController` is not filtering messages using custom validator

Steps to Reproduce

• Add a token in the Yaml configuration file under spamTokens example:

spamTokens:
    - thisIsSpam

• Send an email using Swagger POST /emailer/form
• Make sure you add the previous token in the message body

Expected result

• Email is not sent due to containing spam

Actual result

• Email sent even though it contains spam messages

Update form page information

Todo

• Form page information is not clear about your email field. We need to specify is the target email

Move logic to filter messages from controller to validator

Currently, the logic to handle filters for spam messages is in EmailController let's move that logic to the DTO validator.

Configure Jacoco reports

Todo
We want to know jmailer project coverage, therefore we would like to incorporate and configure Jococo reports so that we can generate a coverage report.

Acceptance Criteria

• Jococo plugin is added in the build.gradle file
• We can run a gradle command to generate a jacoco HTML directory with reports

Notes

• Example of configuration here: Vetlog configuration

Add analytics to the site

Update Bootstrap

Todo

• Update Bootstrap version to 5.1.1
• Update
  • Index
  • contact
  • command line
  • form

Fix broken link in command-line page

Update year license

Todo

• Vetlog has an Apache 2.0 license 2022, let's update it for 2023

Activate a new template for vetlog (adoption)

Todo

• After a user adopt a pet it is expected to send an email to the owner with the information adoption.ftl is missing
• See: https://github.com/josdem/jmailer-spring-boot/blob/feature/15/web/src/main/resources/templates/adoption.ftl

Update Spring Boot

Todo

• Update Spring version to 2.7.0

Change web module to Java

Todo

Moving from Groovy to Java in web module

Add Google drive identifier to the spam filter

Todo

• Add a filter with drive.google.com filter to identify spam

Add a filter by name

Spam has a particular email sender name; let's filter those unwanted messages.

Activate a new template for vetlog (forgot password)

Todo

• After a user creates an account, create a template to send a token to the registered email so that they can activate the account
• See: https://github.com/josdem/jmailer-spring-boot/blob/feature/15/web/src/main/resources/templates/forgotPassword.ftl

Migrate from springfox to springdoc

todo

• SpringFox is not supported in Spring3, for more information go here
• Therefore, we want to migrate to SpringDoc

Acceptance Criteria

• Services and Web tests should pass
• Swagger documentation should be available in the project: https://jmailer.josdem.io/swagger-ui.html

Change services module to Java

Todo

Currently we have services and web modules written in Groovy, change services module to Java 16th version.

Update to Spring Boot 1.5.11 release

Add Lombok to inject dependencies

Todo

• Add Lombok dependency
• Inject beans using Lombok and delete @Value.

Adding an error template

Todo

• Add an error template when Jmailer throws an exception

Activate a new template for vetlog (register)

Todo

• After a user creates an account, create a template to send a token to the registered email so that they can activate the account
• See: https://github.com/josdem/jmailer-spring-boot/blob/feature/15/web/src/main/resources/templates/register.ftl

Add an interceptor to catch request

Adding blacklist to the project

Add Viafe emails to spam

Todo

• Add Viafe emails to the black list

Integrate Spring actuator

Todo

• Add Spring Actuator dependency to monitor the health endpoint along with other production metrics.

Acceptance Criteria
I am able to hit the health endpoint within Jmailer URL.

Change package names

Todo

• Change package name from com.jos.dem.jmailer to com.josdem.jmailer

Adding register template

Create a filter for spam messages

Todo

• Spams are coming in the format:
  • Name: LWOJGyldmM
  • Message: SEKWdgPxTV

Let's create a filter for them
Source: https://drive.google.com/drive/folders/1Eiiuw_BBAt5HyJTi0JOq6tIQ0KAz3pTG

Move integration test cases form Spock to Junit5

Todo

• Add MockMvc dependency
• Move integration test cases to Junit5

Upgrade to Spring 3

Would be great to update project from spring boot 2 to spring boot 3

Filter auto-generated messages as spam

Todo

• User reported receiving messages with body:
  • BYZGaKygTxwzPMqo
  • FLnCfulwxEksqzM

Let's filter those messages as spam

Adding controller to Softtek