spruce-email v1.0.0-alpha.1

Latest (recommended) Beta: Alpha:

spruce

Easily run automations against your email inbox.

Goals of this project

• Infrequent (as much as we can) updates. We do this by being lightweight on dependencies and using dependencies that are stable.
• Portable. Run on GitHub Actions, your own server via cron, Docker, etc.
• Just as easy to setup as it is to create rules. Provide tools for users to be able to easily setup parsing rules for emails.

This tool's current duties include:

• Get emails from an IMAP email address account.
• Parse IMAP emails into a developer friendly format (example: JSON).
• Run custom code against the parsed email to do whatever you want with the email.
• Perform an action on email after processing is complete (mark as read, move to folder, delete).
• Provide developer tools for each of the steps above for easy development. Provide CLI to get a data set. Provide library to run automated tests on data set against your custom code.

We try to keep this tool focused in it's vision and not be bloated with features. If you have a feature you have in mind to provide to this tool, it's recommended to pitch the idea to see if it fits into the vision of the project and would be accepted.

Work in progress

This tool is a work in progress.

Development

• nvm use
• npm install
• cp .env.example .env fill in details to hook into your IMAP server.
• (optional) npm install -g ts-node to easily run typescript files: ts-node index.ts dump --debug --output="/tmp/foo"

Contributors

Thanks goes to these wonderful people (emoji key)