Giter VIP home page Giter VIP logo

greenmail-example's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.