rmanach/mailsrv
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
rmanach 2023-09-10 22:07:47 +02:00
parent 3c4b740849
commit dd9018bcef
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -3,7 +3,7 @@ A little service to send e-mail.
## Build ## Build
```bash ```bash
make make build
``` ```
## Configuration ## Configuration
@ -25,15 +25,22 @@ outbox_path = "<dir_path>" # directory used to retrieve `.json` e-mail format to
``` ```
## How to send a mail ? ## How to send a mail ?
### JSON file
* create a JSON file like: * create a JSON file like:
```json ```json
{ {
"sender":"<email>", "sender":"<email>",
"receivers": ["<email_1>","<email_2>", ..., "<email_n>"], "receivers": "<email_1>,<email_2>, ..., <email_n>",
"subject": "<subject>", "subject": "<subject>",
"content": "<mail_content>" "content": "<mail_content>"
} }
``` ```
* put the JSON file in the `outbox` directory define in the `.ini` file * put the JSON file in the `outbox` directory defined in the `.ini` file.
**NOTE**: HTML is interpreted for the e-mail content ### HTTP
An http server is embedded inside `mailsrv` and is listening on port **1212**. To send an email you can post a JSON to **/mail**:
```
curl http://localhost:1212/mail -d '{"sender":"test@test.com","receivers":"test1@test.com,test2@test.com","subject":"test","content":"<h1>test</h1>"}'
```
**NOTE**: HTML is interpreted for the e-mail content.