Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devatherock/email-sender
REST API to send emails
https://github.com/devatherock/email-sender
email email-sender rest-api smtp
Last synced: 2 months ago
JSON representation
REST API to send emails
- Host: GitHub
- URL: https://github.com/devatherock/email-sender
- Owner: devatherock
- License: mit
- Created: 2018-10-01T15:59:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T13:01:37.000Z (8 months ago)
- Last Synced: 2024-04-22T13:44:01.289Z (8 months ago)
- Topics: email, email-sender, rest-api, smtp
- Language: Groovy
- Homepage: https://email-sender-44uh.onrender.com/swagger-ui.html
- Size: 336 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![CircleCI](https://circleci.com/gh/devatherock/email-sender.svg?style=svg)](https://circleci.com/gh/devatherock/email-sender)
[![Version](https://img.shields.io/docker/v/devatherock/email-sender?sort=date)](https://hub.docker.com/r/devatherock/email-sender/)
[![Docker Pulls](https://img.shields.io/docker/pulls/devatherock/email-sender.svg)](https://hub.docker.com/r/devatherock/email-sender/)
[![Docker Image Size](https://img.shields.io/docker/image-size/devatherock/email-sender.svg?sort=date)](https://hub.docker.com/r/devatherock/email-sender/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
# email-sender
REST API to send emails. Sends the email using the configured SMTP server or an embedded [aspirin](https://github.com/masukomi/aspirin) server## API Reference
Refer the swagger [spec](https://email-sender-44uh.onrender.com/v3/api-docs) or the swagger
[UI](https://email-sender-44uh.onrender.com/swagger-ui.html)### Sample YAML request payload
```yaml
to:
- email: [email protected]
subject: Test email
html: |
Hello, World!
text: This is a test email
```## Configurable properties
| Name | Type | Default | Description |
|---------------------------------------|--------------|------------------|-----------------------------------------------------------------------------------|
| emailsender.smtp.embedded | boolean | false | Indicates if an embedded SMTP server should be used. Turned off by default |
| emailsender.smtp.username | String | (None) | The SMTP username |
| emailsender.smtp.password | String | (None) | The SMTP password |
| emailsender.smtp.host | String | (None) | The SMTP server name |
| emailsender.smtp.port | int | 587 | The SMTP port. Defaults to 587 |
| emailsender.smtp.from-address.name | String | (None) | The from name to use in outbound emails |
| emailsender.smtp.from-address.email | String | (None) | The from email address to use in outbound emails |