53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
# Postmoogle [](https://matrix.to/#/#postmoogle:etke.cc)[](https://ko-fi.com/etkecc) [](https://gitlab.com/etke.cc/postmoogle/-/commits/main) [](https://goreportcard.com/report/gitlab.com/etke.cc/postmoogle) [](https://pkg.go.dev/gitlab.com/etke.cc/postmoogle)
|
|
|
|
> [more about that name](https://finalfantasy.fandom.com/wiki/The_Little_Postmoogle_That_Could)
|
|
|
|
An Email to Matrix bridge
|
|
|
|
## Roadmap
|
|
|
|
### Receive
|
|
|
|
- [x] SMTP server
|
|
- [x] Matrix bot
|
|
- [x] Configuration in room's account data
|
|
- [x] Receive emails to matrix rooms
|
|
- [x] Receive attachments
|
|
- [ ] Map email threads to matrix threads
|
|
|
|
### Send
|
|
|
|
- [ ] SMTP client
|
|
- [ ] Reply to matrix thread sends reply into email thread
|
|
- [ ] Send a message to matrix room with special format to send a new email
|
|
|
|
## Configuration
|
|
|
|
env vars
|
|
|
|
### mandatory
|
|
|
|
* **POSTMOOGLE_HOMESERVER** - homeserver url, eg: `https://matrix.example.com`
|
|
* **POSTMOOGLE_LOGIN** - user login/localpart, eg: `moogle`
|
|
* **POSTMOOGLE_PASSWORD** - user password
|
|
* **POSTMOOGLE_DOMAIN** - SMTP domain to listen for new emails
|
|
* **POSTMOOGLE_PORT** - SMTP port to listen for new emails
|
|
|
|
### optional
|
|
|
|
* **POSTMOOGLE_NOOWNER** - allow change room settings by any room partisipant
|
|
* **POSTMOOGLE_FEDERATION** - allow usage of Postmoogle by users from others homeservers
|
|
* **POSTMOOGLE_NOENCRYPTION** - disable encryption support
|
|
* **POSTMOOGLE_SENTRY_DSN** - sentry DSN
|
|
* **POSTMOOGLE_SENTRY_RATE** - sentry sample rate, from 0 to 100 (default: 20)
|
|
* **POSTMOOGLE_LOGLEVEL** - log level
|
|
* **POSTMOOGLE_DB_DSN** - database connection string
|
|
* **POSTMOOGLE_DB_DIALECT** - database dialect (postgres, sqlite3)
|
|
* **POSTMOOGLE_MAXSIZE** - max email size (including attachments) in megabytes
|
|
|
|
You can find default values in [config/defaults.go](config/defaults.go)
|
|
|
|
## Where to get
|
|
|
|
[docker registry](https://gitlab.com/etke.cc/postmoogle/container_registry), [etke.cc](https://etke.cc)
|