Skip to content

vorktanamobay/mattermail

 
 

Repository files navigation

mattermail icon MatterMail

MatterMail is an integration service for Mattermost, MatterMail listen an email box and publish all received emails in a channel or private group in Mattermost.

mattermail screenshot

Install

  • For Mattermost 3.0:

Linux / OSX

  • For Mattermost 2.2:

Linux / OSX

Usage

  1. You need to create a user in Mattermost server, you can use MatterMail icon as profile picture.

  2. Get the Channel Handle of the channel and check if the user has permission to post in this channel mattermail channel_handle

  3. Edit the file conf.json, e.g.:

[
	{
		"Name":          "Orders",
		"Server":        "https://mattermost.example.com",
		"Team":          "team1",
		"Channel":       "orders",
		"MattermostUser":"mattermail@example.com",
		"MattermostPass":"password",
		"ImapServer":    "imap.example.com:143",
		"Email":         "orders@example.com",
		"EmailPass":     "password",
		"MailTemplate":  ":incoming_envelope: _From: **%v**_\n>_%v_\n\n%v",
		"StartTLS":      true,   /*Optional default false*/
		"Disabled":      false,  /*Optional default false*/
		"Debug":         false   /*Optional default false*/
	},
	{
		"Name":          "Bugs",
		"Server":        "https://mattermost.example.com",
		"Team":          "team1",
		"Channel":       "bugs",
		"MattermostUser":"mattermail@example.com",
		"MattermostPass":"password",
		"ImapServer":    "imap.gmail.com:993",
		"Email":         "bugs@gmail.com",
		"EmailPass":     "password",
		"MailTemplate":  ":incoming_envelope: _From: **%v**_\n>_%v_\n\n%v",
		"StartTLS":      false,  /*Optional default false*/
		"Disabled":      false,  /*Optional default false*/
		"Debug":         true    /*Optional default false*/
	},
	{
		/*.... other if you want ....*/
	}
]
  1. Execute the command to put in background
$ ./mattermail > /var/log/mattermail.log 2>&1 &

Options

$ ./mattermail --help
Options:
    -c, --config  Sets the file location for config.json
                  Default: ./config.json 
    -h, --help    Show this help
    -v, --version Print current version

Building

You need Go to build this project

$ go get github.com/rodrigocorsi2/mattermail

If you want to build MatterMail to Mattermost 2.2 you need to use release-2.2 branch

About

Email Integration for Mattermost

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 94.1%
  • Makefile 5.9%