Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/virtomize/mail2most
watch emails and send them to mattermost
https://github.com/virtomize/mail2most
docker docker-compose email email-parsing filtering golang golang-application imap integration mattermost mattermost-bot
Last synced: 2 months ago
JSON representation
watch emails and send them to mattermost
- Host: GitHub
- URL: https://github.com/virtomize/mail2most
- Owner: Virtomize
- License: mit
- Created: 2019-06-27T11:10:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T15:12:35.000Z (10 months ago)
- Last Synced: 2024-09-27T02:22:56.277Z (3 months ago)
- Topics: docker, docker-compose, email, email-parsing, filtering, golang, golang-application, imap, integration, mattermost, mattermost-bot
- Language: Go
- Homepage:
- Size: 4.04 MB
- Stars: 74
- Watchers: 9
- Forks: 19
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VBXHBYFU44T5W&source=url)
[](https://godoc.org/github.com/virtomize/mail2most/lib)
[](https://goreportcard.com/report/github.com/virtomize/mail2most)
[](https://github.com/virtomize/mail2most/blob/master/LICENSE)
[](https://magefile.org)
[](https://github.com/Virtomize/mail2most/actions/workflows/test.yml)
[](https://github.com/Virtomize/mail2most/actions/workflows/docker.yaml)
[](https://github.com/Virtomize/mail2most/actions/workflows/trivy.yaml)
# [](https://github.com/virtomize/mail2most)
Filter emails from mail accounts and send them to mattermost.
# Features
- IMAP(S) support
- StartTLS support
- Mattermost v4 API support
- HTML 2 Markdown support
- Filter mails by Folder
- Filter mails by From
- Filter mails by To
- Filter mails by Subject
- Filter mails by TimeRange
- Mattermost broadcasts
- Choose to post Subject and Body or Subject only
- Send to channels and/or users
- Profile management including default profiles
- Mail attachment support
Missing feature or found a bug ? Feel free to open an [issue](https://github.com/virtomize/mail2most/issues) and let us know !
## Donation
If this project helps you, feel free to give us a cup of coffee :).
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VBXHBYFU44T5W&source=url)
# Install
## download
Download [Latest Release Version](https://github.com/virtomize/mail2most/releases/latest)
## build it yourself
You can compile the project yourself using this repo and [mage](https://magefile.org).
Just clone the repo and run `mage build`, you can find the binary under `bin/mail2most`
# Usage
- create a mattermost user
- create or use an existsing email user to connect to your mail server via IMAP
- edit `conf/mail2most.conf` and configure your mail and mattermost credentials
- configure your filters
- run Mail2Most `./mail2most` or with config path `./mail2most -c conf/mail2most.conf`
# Version Info
- run `./mail2most -version` to get current version information
## example conf - filter descriptions
**just configure the filters you need if a filter is not defined it is not used !**
see [example configuration](https://github.com/virtomize/mail2most/blob/master/conf/mail2most.conf) for more details.
# Run Mail2Most as a service
You can run Mail2Most using docker, docker-compose or as a systemd service.
## docker
[docker-hub link](https://hub.docker.com/r/virtomize/mail2most)
Using docker you need to change the path to your mail2most.conf
```
docker run \
-v /path/to/mail2most.conf:/mail2most/conf/mail2most.conf \
virtomize/mail2most:latest
```
e.g. if you are in this repo:
```
docker run \
-v $(pwd)/conf/mail2most.conf:/mail2most/conf/mail2most.conf \
virtomize/mail2most:latest
```
> [!NOTE]
> The `latest` tag image is rebuild on a daily base to get newest OS package updates inside the docker image.
## docker-compose
[docker-hub link](https://hub.docker.com/r/virtomize/mail2most)
Using docker-compose you can just edit the `conf/mail2most.conf` or change the path inside the docker-compose.yml to your config:
```
volumes:
- ./conf/mail2most.conf:/mail2most/conf/mail2most.conf
```
needs to be changed to
```
volumes:
- /path/to/my/mail2most.conf:/mail2most/conf/mail2most.conf
```
then just start a container user
```
docker-compose up -d
```
## Systemd
Systemd allows you to create a background service to run mail2most managed by your system:
- create `/opt/mail2most` and place the mail2most binary into it
- `mkdir -p /opt/mail2most/conf`
- create `/opt/mail2most/conf/mail2most.conf`
- place the following file to `/etc/systemd/system/mail2most.service`
```
# mail2most
[Unit]
Description=mail2most
[Service]
Type=simple
WorkingDirectory=/opt/mail2most
ExecStart=/opt/mail2most/mail2most -c /path/to/mail2most.conf
Restart=always
RestartSec=60
[Install]
WantedBy=multi-user.target
```
enable and start using
```
systemctl enable mail2most
systemctl start mail2most
```
> [!Note]
> Make sure to use the absolute path to your mail2most configuration file.
## Common problems
**Problem: mail2most crashes after profile changes**
Solution: This happens when the data.json is not consistent to the config changes. Delete data.json to solve this problem.
**Problem: Channel contains special characters mattermost can not found the channel**
Solution: Mattermost does not support special characters for channel names, only in display names. To find the correct channel name use the last part of the url found under `view info`
# Contribution to Mail2Most
Thank you for participating to this project.
Please see our [Contribution Guidlines](https://github.com/virtomize/mail2most/blob/master/CONTRIBUTING.md) for more information.