1
0
Fork 0
mirror of https://github.com/Luzifer/automail.git synced 2024-12-20 13:01:20 +00:00

Explain purpose

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2020-06-27 15:32:16 +02:00
parent 5c0da4c04c
commit fc0f6da629
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E

View file

@ -7,3 +7,7 @@
# 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.