greenmail-example

About

This is an example application in which you can create notes and send them via mail. Notes can also be created by incoming mails to the address specified in the application.config file. All the mails will remain local due to GreenMail running in the background as a mock SMTP server. You can use the included RoundCube instance to read and send mails. Mail sending and receiving is tested with integration tests using GreenMail.

Further reading

I held a talk about testing email notifications. This application is used for demonstration purposes in this talk. You can watch the talk online on my website.

I wrote a detailed article about the dev setup with GreenMail. The results can be read in this article.

Running the application

Setup

• start up the docker dependencies: docker-compose up -d
• run the application: ./mvnw spring-boot:run

Prerequisites

• the following programmes are required on your machine
  • docker
  • docker-compose
  • firefox (for testing only)

Usage

• call http://localhost:8080/ to access the application
• call http://localhost:8000/ to read and send emails locally
  • login with username and password - password is equal to username
  • greenmail automatically creates new users on login or receiving mails

Further improvements

• unit test emails
  • include templating engine?
• edit notes by sending mails
• test for html and attachment mails

Thanks

I would like to thank my former employer OVSoftware and my current employer OpenValue for allowing me to publish the results of my research.