https://github.com/imrany/open-email
Microservice that send mail to clients
https://github.com/imrany/open-email
Last synced: 3 months ago
JSON representation
Microservice that send mail to clients
- Host: GitHub
- URL: https://github.com/imrany/open-email
- Owner: imrany
- License: mit
- Created: 2023-03-21T11:13:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T08:28:43.000Z (about 2 years ago)
- Last Synced: 2025-01-19T23:20:14.845Z (4 months ago)
- Language: TypeScript
- Homepage: https://open-email-delivery.onrender.com
- Size: 94.7 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# open-email
A microservice that sents mail to clients. You can use this api to automate email sending in your application or project.
If you have clients or running an online business and you would like your clients to get email notifications when you bring out a new project in the market then this api is for you.
You can easily connect you website or app with this api, follow the step below, and __it's free__
## How to use this service
You can send an email using this api by sending a `POST` request to [https://open-email-delivery.onrender.com/send](https://open-email-delivery.onrender.com/send) with the following body:
* __mailfrom__ - _the sent of the email, in this case it will be your email address_.
* __mailto__ -_the recipient or receiver, in this case it will be email address you are sent the notice to._
* __subject__ - _subject of the email i.e topic/title associate with the email._
* __message__ - _the message/text you would like to sent._
# Examples:
## Used as in HTML in a form submit
```html
Send email
```
## Used as in vanilla javascript (fetch api)
```javascript
async function send(){
try{
const url =`https://open-email-delivery.onrender.com/send`;
const response=await fetch(url,{
method:"POST",
header:{
"content-type":"application/json"
},
body:JSON.stringify({
mailfrom:"[email protected]",
mailto:"[email protected]",
subject:"Any Subject",
message:"How are you friend"
})
})
const parseRes=await response.json();
console.log(parseRes);
}catch(err){
console.log(err.message);
}
}
//invoke the function above
send();
```
This javascript function will send a `POST` to the open-email then will return a json response.
```json
{
"msg":"Mail sent"
}
```
Otherwise you would receive an error
```json
{
"error":"Mail wasn't sent, try again!"
}
```
## Used as in Python (Python Requests library)
```python
import requests
r = requests.post('https://open-email-delivery.onrender.com/send', json={
"mailfrom": "[email protected]",
"mailto": "[email protected]",
"subject": "Any Subject",
"message":"Hello there"
})
print(f"Status Code: {r.status_code}, Response: {r.json()}")
```
## Used as in Curl
```bash
curl -X POST https://open-email-delivery.onrender.com/send -H "Content-Type: application/json" -d '{"mailfrom": "[email protected]","mailto": "[email protected]", "subject": "Any Subject","message": "Hello there"}'
```
Response should be
```json
{"msg":"Mail sent"}
```
Otherwise you would receive an error
```json
{"error":"Mail wasn't sent, try again!"}
```
You can test the api by placing your email address on both the `mailfrom` and the `mailto` fields and the response, after sending the request check your email inbox.
## License
[MIT License](./LICENSE)