{"id":18386489,"url":"https://github.com/stemmlerjs/mail-microservice","last_synced_at":"2025-07-13T07:10:11.486Z","repository":{"id":107362483,"uuid":"142335800","full_name":"stemmlerjs/mail-microservice","owner":"stemmlerjs","description":"📧 Simple mail microservice using AWS SES.","archived":false,"fork":false,"pushed_at":"2018-07-25T21:40:13.000Z","size":35,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T19:23:15.450Z","etag":null,"topics":["aws-ses","email","microservice","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stemmlerjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-25T17:59:00.000Z","updated_at":"2024-03-19T20:20:43.000Z","dependencies_parsed_at":"2023-05-21T11:15:29.300Z","dependency_job_id":null,"html_url":"https://github.com/stemmlerjs/mail-microservice","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stemmlerjs%2Fmail-microservice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stemmlerjs%2Fmail-microservice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stemmlerjs%2Fmail-microservice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stemmlerjs%2Fmail-microservice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stemmlerjs","download_url":"https://codeload.github.com/stemmlerjs/mail-microservice/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248830416,"owners_count":21168271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-ses","email","microservice","nodejs"],"created_at":"2024-11-06T01:22:15.586Z","updated_at":"2025-04-14T05:40:42.341Z","avatar_url":"https://github.com/stemmlerjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mail-microservice\nMail micro service for my node apps.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\n\n- NodeJS\n- Amazon API Key\n\n### Running the example\n\nThe Mailer microservice can be run with:\n\n```\nnpm run start\n```\n\nAnd then to run the mock service registry, run:\n\n```\nnode example/app.js\n```\n\nTo test out an email, send `POST` request to ```http://127.0.0.1:3000/register``` with the body as follows:\n\n```\n{\n   \"email\": \"youremail@gmail.com\",\n   \"password\": \"examplepassword\"\n}\n```\n\n## v2\n### Branch: master\nVersion 2 is an improvement that allows me to plug this into any app backend now.\n\nFeatures:\n- Slack webhook update on exceptions\n- Starts with unique port and announces itself to a service registry.\n- Reusable with any app.\n- Expandable.\n\nUpcoming:\n- Add the ability to use different mail services (mailchimp, mailgun, nodemailer).\n- Add ability to email maintainers if exceptions occur.\n\n## v1\n### Branch: v1\nVersion 1 was quickly created in order to respond to an influx of new users @ Univjobs.\n\nIt served it's purpose but it wasn't very reusable for my other projects. This is mainly due to the fact that it wasn't designed as a service but rather as a separate module to the platform. That being said, here are the pros and cons of this version.\n\nPros:\n- We can re-send failed emails.\n- If there is any downtime, we can be sure that these emails will be attempted to be sent when the services comes back online.\n\nCons:\n- It requires access to the database.\n- It polls the database for work.\n- It's too specific / not generic enough. Can't be plugged into another app.\n- If we were to add more instances, there is a chance that we could in a rare case, send the same email more than once (very bad).\n\nThese cons are why I decided to update the this repo to use a more traditional micro-service architecture.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstemmlerjs%2Fmail-microservice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstemmlerjs%2Fmail-microservice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstemmlerjs%2Fmail-microservice/lists"}