https://github.com/tyiu/emailservice

RESTful service that sends emails
https://github.com/tyiu/emailservice

Last synced: about 1 hour ago
JSON representation

RESTful service that sends emails

• Host: GitHub
• URL: https://github.com/tyiu/emailservice
• Owner: tyiu
• License: gpl-3.0
• Created: 2014-09-12T07:33:20.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-17T09:37:52.000Z (about 10 years ago)
• Last Synced: 2024-10-12T20:30:58.006Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 156 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
EmailService

============

RESTful backend service that sends emails via an arbitrary email service provider from a set of providers.

Tech Stack

==========

Java 8

Dropwizard - https://dropwizard.github.io/dropwizard/

Dropwizard includes the following:

* Jetty for HTTP

* Jersey for REST

* Jackson for JSON

Maven for packaging

Why Dropwizard?

===============

Dropwizard compiles powerful and widely used Java libraries used for developing RESTful web services.

They are well documented and I have some experience with them from working on previous Java web services.

How to Deploy

=============

* Checkout source code

* Type: mvn package

* Type: java -jar target/emailservice-0.0.1-SNAPSHOT.jar server email-config.yml

/email/send Endpoint

====================

* HTTP POST

* Expects application/json payload

* Example: {"subject":"", "message":"", "from":{"name":"", "emailAddress":""}, "to":[{"name":"", "emailAddress":""}, {"name":"", "emailAddress":""}], "cc":[{"name":"", "emailAddress":""}, {"name":"", "emailAddress":""}], "bcc":[{"name":"", "emailAddress":""}, {"name":"", "emailAddress":""}]}

* Note: You can have multiple to, cc, and bcc recipients

* Note: cc and bcc are optional. Everything else is required.

What Works And What Doesn't

===========================

This service can receive HTTP POST requests to the /email/send endpoint and will attempt to forward it

to an actual email service provider.

However, none of the forwarded requests work at this current time due to either incorrect configured

account settings on their sites or incorrect requests sent to their services.

There are no health checks to determine the availability of the service.

There is also a lack of unit tests and validation tests. 

Contact

=======

https://www.linkedin.com/in/terryyiu