luzifer/automail
1
0
Fork 0
mirror of https://github.com/Luzifer/automail.git synced 2024-12-20 13:01:20 +00:00
Code Issues Releases Wiki Activity
Utility to periodically fetch mails from an IMAP mailbox and execute commands based on matched headers
13 commits 1 branch 2 tags 66 KiB
Go 96.1%
Dockerfile 3.9%
Find a file
Knut Ahlers c2687bc39f
Add additional storage provider redis 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2023-02-25 15:00:48 +01:00
.gitignore Initial version 2020-06-27 15:25:16 +02:00
commands.go Add get_attachment command 2020-06-27 15:48:20 +02:00
config.go Initial version 2020-06-27 15:25:16 +02:00
Dockerfile Add dockerized version 2020-06-27 15:36:11 +02:00
go.mod Add additional storage provider redis 2023-02-25 15:00:48 +01:00
go.sum Add additional storage provider redis 2023-02-25 15:00:48 +01:00
handler.go Fix: Use AND matching for match-rules 2020-06-29 14:06:03 +02:00
History.md prepare release v0.1.0 2023-02-25 14:12:31 +01:00
LICENSE Add basic meta 2020-06-27 15:27:14 +02:00
main.go Add additional storage provider redis 2023-02-25 15:00:48 +01:00
README.md Add additional storage provider redis 2023-02-25 15:00:48 +01:00
store.go Add additional storage provider redis 2023-02-25 15:00:48 +01:00
transport.go Add get_attachment command 2020-06-27 15:48:20 +02:00

README.md

Go Report Card

Luzifer / automail

automail is an utility to periodically fetch mails from an IMAP mailbox and execute commands based on matched headers.

One of my personal use-cases for this is to automatically parse payment receipts received from Twitch and enter the corresponding transactions into my accounting software.

In the end this software provides you with a possibility to match any mail you receive by their headers and execute a script which is able to act on those mails. The script is provided with a JSON representation of the mail on stdin and can yield commands (for example "mark as read", "move to mailbox", ...) to stdout which then will be executed on the mail.

Storage types

  • Local File
    • --storage-type=file
    • --storage-dsn=path/to/file.yaml
  • Redis
    • --storage-type=redis
    • --storage-dsn=redis://<user>:<password>@<host>:<port>/<db_number>
    • REDIS_KEY_PREFIX=myprefix (default: io.luzifer.automail)