Mail2slack

Simple tool that scans an IMAP inbox and posts every incoming email to a Slack channel, so self-hosters can surface mailbox alerts in their team chat.

  • Automation
  • Cloud
  • Communication
  • Productivity
  • Tools & Utilities
Simple tool that scans an IMAP inbox and posts every incoming email to a Slack channel, so self-hosters can surface mailbox alerts in their team chat.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

11/100 Low

Maintained
0last commit 981 days ago
Popular
102 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked 25 days ago

GitHub stars
2
Open issues
0
Last commit
2024-03-15
Latest release
1.0.4
License
GPL-3.0
Activity
stale

Checked 8 days ago - source: GitHub (corgan2222/mail2slack)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Configuration Copy mail2slack.conf.sample to mail2slack.conf, edit your IMAP credentials and Slack channel settings, then run pip3 install -r requirements.txt and python mail2slack.py. source
  • Docker The README provides a docker-compose.yml.sample to edit and start with docker-compose up -d, or a docker run option after changing the settings. source

Fetched 45 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

How can I deploy mail2slack with Docker Compose?

Create a folder, download the sample docker-compose.yml, change the settings, and run docker-compose up -d. The README also shows a docker run command using the stefanknaak/mail2slack:latest image and environment variables.

How do I run the native Python version?

Clone the repository, copy mail2slack.conf.sample to mail2slack.conf, edit it, install requirements with pip3, and run python mail2slack.py. You can also start it with PM2 using ecosystem.config.js.

Which environment variables specify the Slack channel and message fields?

Set SLACK_CHANNEL for the destination channel, along with SLACK_END_POINT, SLACK_TOKEN, SLACK_SLACK_SENDER, SLACK_ICON_URL, and SLACK_SLACK_FALLBACK. The sample shows these as the Slack-related settings.

Can it scan an IMAP folder other than Inbox?

Yes, set MAIL_FOLDER to the desired IMAP folder. The sample uses Inbox and also requires MAIL_MAILSERVER, MAIL_MAIL_LOGIN, and MAIL_MAIL_PW.

How can I keep it running after I start it?

Use PM2 for the Python setup or Docker restart options such as --restart unless-stopped in the docker run example. The README does not provide a reverse proxy or web interface configuration.

Answers sourced from github.com

Community

Collected 48 days ago - public community threads