Skip to content

Commit

Permalink
Updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
hyper-prog committed Feb 18, 2021
1 parent e877c18 commit 160722c
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# RestGoMail
HTTP-REST Mail gateway written in Go
![RestGoMail logo](https://raw.githubusercontent.com/hyper-prog/restgomail/main/images/restgomail.png)

RestGoMail - HTTP-REST Mail gateway in Go
==========================================

RestGoMail is a small daemon/container which able to receive HTML e-mail forward requests
as HTTP POST in a JSON data, queue the requests, and sends the specified
mails to a SMTP server according to the settings.


Compile / Install
-----------------
Server config file (JSON) - Have to pass in command line argument

{
"restgomail": {
"httpsListenPort": "443",
"smtpHost": "smtp.gmail.com",
"smtpPort": "587",
"smtpAuthRequired": true,
"smtpAuthPassword": "gmailpasswordsample",
"smtpAllowedFromAddressOnly": "sampleuser@gmail.com",
"tlsKeyFile": "restgomail.key",
"tlsCertFile": "restgomail.crt",
"allowOnlyKnownCertificates": true,
"knownCertificates": {
"clientOneContainer": "@one_client.crt",
"clientTwoContainer": "MIdjr6RfjfuESwekjEDffg..."
},
"debugMode": false
}
}

E-mail send request (JSON) - Have to send as POST request to the 443 port (configured above)

{
"sendmail": {
"from": "sampleuser@gmail.com",
"to": "tomyfriend@postmail.com",
"subject": "This is a test message",
"bodyhtml": "Probably <i>I can say</i> this thing is <h1>WORK'S FLAWLESS!</h1>!"
}
}

0 comments on commit 160722c

Please sign in to comment.