DigiWF E-Mail Integration

This is a Spring Boot Starter library to send e-mails in the DigiWF environment. It can be used to send mails asynchronously through a spring cloud stream compatible event broker.
For attachments to not clutter the EventBus, paths to file locations on the S3-Filer are expected. The file is then grabbed by this library to avoid sending large files repeatedly through the EventBus.
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Roadmap
3. Getting Started
4. Documentation
5. Contributing
6. License
7. Contact

About The Project

The goal of this library is enabling async mail dispatching with a EventBus and a S3-Filer as your environment.

Features:

• Can be used to dispatch emails asynchronously through an eventbus.
• Can inform the receiver through an eventbus if the email has been sent or if there was a problem.
• Can get attachment files from an S3-Filer, no need to get them yourself and send it through the EventBus several times. Less clutter in your EventBus!

(back to top)

Built With

This project is built with:

• Spring Boot
• Spring Cloud Stream
• DigiWF Spring Cloudstream Utils
• DigiWF S3 Integration

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Getting started

For an explanation on how to get started, please refer to the quickstart doc.

(back to top)

Documentation

For all further documentation, please refer to the documentations doc.

(back to top)

Architecture

For a small impression of the architecture, please refer to the architecture doc.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement", fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Open an issue with the tag "enhancement"
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

More about this in the CODE_OF_CONDUCT file.

(back to top)

License

Distributed under the MIT License. See LICENSE file for more information.

(back to top)

Contact

it@m - opensource@muenchen.de

(back to top)