mitchell/tmail
1
0
Fork 0
mirror of https://github.com/mgerb/tmail synced 2026-01-09 01:12:47 +00:00
Code Issues Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Mitchell Gerber
2022-01-23 22:49:05 -06:00
committed by mg
parent 38f23970de
commit d76fa683ef
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
readme.md
View File

@@ -1,14 +1,14 @@
# TMail # TMail
A throwaway smtp mail server with an API to retrieve emails. A throwaway smtp mail server with an API to retrieve emails.
[Download the latest release here.](https://github.com/mgerb/tmail/releases)
- set up an MX record on your domain. - set up an MX record on your domain.
- point it at your server - point it at your server
- start tmail - start tmail
- all emails sent to *@<your domain> are stored in `mail.db` - all emails sent to *@<your domain> are stored in `mail.db`
- hit these end points to check the email - hit these end points to check the email
[Download the latest release here.](https://github.com/mgerb/tmail/releases)
``` ```
All mail: All mail:
http://host:8090/api/mail http://host:8090/api/mail
@@ -16,3 +16,8 @@ http://host:8090/api/mail
Specific mail: Specific mail:
http://host:8090/api/mail?to=<address> http://host:8090/api/mail?to=<address>
``` ```
## Server Configuration
[See this comment for additional information on configuring a server for tmail](https://github.com/mgerb/tmail/issues/2#issue-1112156904) - thanks @mrbluecoat