mattermost/utils/mail.go

// Copyright (c) 2015 Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

package utils

import (
	"crypto/tls"
	"encoding/base64"
	"fmt"
	l4g "github.com/alecthomas/log4go"
	"github.com/mattermost/platform/model"
	"net"
	"net/mail"
	"net/smtp"
	"time"
)

func encodeRFC2047Word(s string) string {
	// TODO: use `mime.BEncoding.Encode` instead when `go` >= 1.5
	// return mime.BEncoding.Encode("utf-8", s)
	dst := base64.StdEncoding.EncodeToString([]byte(s))
	return "=?utf-8?b?" + dst + "?="
}

func connectToSMTPServer(config *model.Config) (net.Conn, *model.AppError) {
	var conn net.Conn
	var err error

	if config.EmailSettings.ConnectionSecurity == model.CONN_SECURITY_TLS {
		tlsconfig := &tls.Config{
			InsecureSkipVerify: true,
			ServerName:         config.EmailSettings.SMTPServer,
		}

		conn, err = tls.Dial("tcp", config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort, tlsconfig)
		if err != nil {
			return nil, model.NewLocAppError("SendMail", "utils.mail.connect_smtp.open_tls.app_error", nil, err.Error())
		}
	} else {
		conn, err = net.Dial("tcp", config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort)
		if err != nil {
			return nil, model.NewLocAppError("SendMail", "utils.mail.connect_smtp.open.app_error", nil, err.Error())
		}
	}

	return conn, nil
}

func newSMTPClient(conn net.Conn, config *model.Config) (*smtp.Client, *model.AppError) {
	c, err := smtp.NewClient(conn, config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort)
	if err != nil {
		l4g.Error(T("utils.mail.new_client.open.error"), err)
		return nil, model.NewLocAppError("SendMail", "utils.mail.connect_smtp.open_tls.app_error", nil, err.Error())
	}
	// GO does not support plain auth over a non encrypted connection.
	// so if not tls then no auth
	auth := smtp.PlainAuth("", config.EmailSettings.SMTPUsername, config.EmailSettings.SMTPPassword, config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort)
	if config.EmailSettings.ConnectionSecurity == model.CONN_SECURITY_TLS {
		if err = c.Auth(auth); err != nil {
			return nil, model.NewLocAppError("SendMail", "utils.mail.new_client.auth.app_error", nil, err.Error())
		}
	} else if config.EmailSettings.ConnectionSecurity == model.CONN_SECURITY_STARTTLS {
		tlsconfig := &tls.Config{
			InsecureSkipVerify: true,
			ServerName:         config.EmailSettings.SMTPServer,
		}
		c.StartTLS(tlsconfig)
		if err = c.Auth(auth); err != nil {
			return nil, model.NewLocAppError("SendMail", "utils.mail.new_client.auth.app_error", nil, err.Error())
		}
	}
	return c, nil
}

func TestConnection(config *model.Config) {
	if !config.EmailSettings.SendEmailNotifications {
		return
	}

	conn, err1 := connectToSMTPServer(config)
	if err1 != nil {
		l4g.Error(T("utils.mail.test.configured.error"), err1.Message, err1.DetailedError)
		return
	}
	defer conn.Close()

	c, err2 := newSMTPClient(conn, config)
	if err2 != nil {
		l4g.Error(T("utils.mail.test.configured.error"), err2.Message, err2.DetailedError)
		return
	}
	defer c.Quit()
	defer c.Close()
}

func SendMail(to, subject, body string) *model.AppError {
	return SendMailUsingConfig(to, subject, body, Cfg)
}

func SendMailUsingConfig(to, subject, body string, config *model.Config) *model.AppError {
	if !config.EmailSettings.SendEmailNotifications || len(config.EmailSettings.SMTPServer) == 0 {
		return nil
	}

	l4g.Debug(T("utils.mail.send_mail.sending.debug"), to, subject)

	fromMail := mail.Address{config.EmailSettings.FeedbackName, config.EmailSettings.FeedbackEmail}
	toMail := mail.Address{"", to}

	headers := make(map[string]string)
	headers["From"] = fromMail.String()
	headers["To"] = toMail.String()
	headers["Subject"] = encodeRFC2047Word(subject)
	headers["MIME-version"] = "1.0"
	headers["Content-Type"] = "text/html; charset=\"utf-8\""
	headers["Content-Transfer-Encoding"] = "8bit"
	headers["Date"] = time.Now().Format(time.RFC1123Z)

	message := ""
	for k, v := range headers {
		message += fmt.Sprintf("%s: %s\r\n", k, v)
	}
	message += "\r\n<html><body>" + body + "</body></html>"

	conn, err1 := connectToSMTPServer(config)
	if err1 != nil {
		return err1
	}
	defer conn.Close()

	c, err2 := newSMTPClient(conn, config)
	if err2 != nil {
		return err2
	}
	defer c.Quit()
	defer c.Close()

	if err := c.Mail(fromMail.Address); err != nil {
		return model.NewLocAppError("SendMail", "utils.mail.send_mail.from_address.app_error", nil, err.Error())
	}

	if err := c.Rcpt(toMail.Address); err != nil {
		return model.NewLocAppError("SendMail", "utils.mail.send_mail.to_address.app_error", nil, err.Error())
	}

	w, err := c.Data()
	if err != nil {
		return model.NewLocAppError("SendMail", "utils.mail.send_mail.msg_data.app_error", nil, err.Error())
	}

	_, err = w.Write([]byte(message))
	if err != nil {
		return model.NewLocAppError("SendMail", "utils.mail.send_mail.msg.app_error", nil, err.Error())
	}

	err = w.Close()
	if err != nil {
		return model.NewLocAppError("SendMail", "utils.mail.send_mail.close.app_error", nil, err.Error())
	}

	return nil
}
Changing SpinPunch to Mattermost in copyright 2015-10-08 12:27:09 -04:00			`// Copyright (c) 2015 Mattermost, Inc. All Rights Reserved.`
first commit 2015-06-14 23:53:32 -08:00			`// See License.txt for license information.`

			`package utils`

			`import (`
			`"crypto/tls"`
Fix email encoding issue 2015-10-15 21:17:52 +08:00			`"encoding/base64"`
first commit 2015-06-14 23:53:32 -08:00			`"fmt"`
Upgrade logging package 2016-01-11 09:12:51 -06:00			`l4g "github.com/alecthomas/log4go"`
first commit 2015-06-14 23:53:32 -08:00			`"github.com/mattermost/platform/model"`
			`"net"`
			`"net/mail"`
			`"net/smtp"`
missing tab 2015-08-26 20:17:52 +02:00			`"time"`
first commit 2015-06-14 23:53:32 -08:00			`)`

Fix email encoding issue 2015-10-15 21:17:52 +08:00			`func encodeRFC2047Word(s string) string {`
			// TODO: use `mime.BEncoding.Encode` instead when `go` >= 1.5
			`// return mime.BEncoding.Encode("utf-8", s)`
			`dst := base64.StdEncoding.EncodeToString([]byte(s))`
			`return "=?utf-8?b?" + dst + "?="`
			`}`

Adding email to admin console 2015-09-21 15:11:56 -07:00			`func connectToSMTPServer(config model.Config) (net.Conn, model.AppError) {`
Fixing build 2015-06-16 23:05:37 -08:00			`var conn net.Conn`
			`var err error`

Adding image properties 2015-09-21 17:34:13 -07:00			`if config.EmailSettings.ConnectionSecurity == model.CONN_SECURITY_TLS {`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`tlsconfig := &tls.Config{`
			`InsecureSkipVerify: true,`
Adding email to admin console 2015-09-21 15:11:56 -07:00			`ServerName: config.EmailSettings.SMTPServer,`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`}`

Adding email to admin console 2015-09-21 15:11:56 -07:00			`conn, err = tls.Dial("tcp", config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort, tlsconfig)`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`if err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return nil, model.NewLocAppError("SendMail", "utils.mail.connect_smtp.open_tls.app_error", nil, err.Error())`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`}`
Fixing build 2015-06-16 23:05:37 -08:00			`} else {`
Adding email to admin console 2015-09-21 15:11:56 -07:00			`conn, err = net.Dial("tcp", config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort)`
Fixing build 2015-06-16 23:05:37 -08:00			`if err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return nil, model.NewLocAppError("SendMail", "utils.mail.connect_smtp.open.app_error", nil, err.Error())`
Fixing build 2015-06-16 23:05:37 -08:00			`}`
first commit 2015-06-14 23:53:32 -08:00			`}`

Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`return conn, nil`
			`}`
first commit 2015-06-14 23:53:32 -08:00
Adding email to admin console 2015-09-21 15:11:56 -07:00			`func newSMTPClient(conn net.Conn, config model.Config) (smtp.Client, *model.AppError) {`
			`c, err := smtp.NewClient(conn, config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort)`
first commit 2015-06-14 23:53:32 -08:00			`if err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`l4g.Error(T("utils.mail.new_client.open.error"), err)`
			`return nil, model.NewLocAppError("SendMail", "utils.mail.connect_smtp.open_tls.app_error", nil, err.Error())`
first commit 2015-06-14 23:53:32 -08:00			`}`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`// GO does not support plain auth over a non encrypted connection.`
			`// so if not tls then no auth`
Adding email to admin console 2015-09-21 15:11:56 -07:00			`auth := smtp.PlainAuth("", config.EmailSettings.SMTPUsername, config.EmailSettings.SMTPPassword, config.EmailSettings.SMTPServer+":"+config.EmailSettings.SMTPPort)`
Adding image properties 2015-09-21 17:34:13 -07:00			`if config.EmailSettings.ConnectionSecurity == model.CONN_SECURITY_TLS {`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`if err = c.Auth(auth); err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return nil, model.NewLocAppError("SendMail", "utils.mail.new_client.auth.app_error", nil, err.Error())`
Modifying sendmail to allow for non-encrypted connection for ease setup of local mail sender 2015-06-15 11:14:26 -04:00			`}`
Adding image properties 2015-09-21 17:34:13 -07:00			`} else if config.EmailSettings.ConnectionSecurity == model.CONN_SECURITY_STARTTLS {`
Add support for SMTP servers with StartTLS 2015-08-19 09:03:55 +02:00			`tlsconfig := &tls.Config{`
			`InsecureSkipVerify: true,`
Adding email to admin console 2015-09-21 15:11:56 -07:00			`ServerName: config.EmailSettings.SMTPServer,`
Add support for SMTP servers with StartTLS 2015-08-19 09:03:55 +02:00			`}`
			`c.StartTLS(tlsconfig)`
Add SMTP auth to STARTTLS connections 2015-08-23 22:13:07 -07:00			`if err = c.Auth(auth); err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return nil, model.NewLocAppError("SendMail", "utils.mail.new_client.auth.app_error", nil, err.Error())`
Add SMTP auth to STARTTLS connections 2015-08-23 22:13:07 -07:00			`}`
first commit 2015-06-14 23:53:32 -08:00			`}`
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`return c, nil`
			`}`

PLT-470 Adding STMP server connection check 2015-09-29 11:59:26 -07:00			`func TestConnection(config *model.Config) {`
			`if !config.EmailSettings.SendEmailNotifications {`
			`return`
			`}`

			`conn, err1 := connectToSMTPServer(config)`
			`if err1 != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`l4g.Error(T("utils.mail.test.configured.error"), err1.Message, err1.DetailedError)`
PLT-470 Adding STMP server connection check 2015-09-29 11:59:26 -07:00			`return`
			`}`
			`defer conn.Close()`

			`c, err2 := newSMTPClient(conn, config)`
			`if err2 != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`l4g.Error(T("utils.mail.test.configured.error"), err2.Message, err2.DetailedError)`
PLT-470 Adding STMP server connection check 2015-09-29 11:59:26 -07:00			`return`
			`}`
			`defer c.Quit()`
			`defer c.Close()`
			`}`

Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`func SendMail(to, subject, body string) *model.AppError {`
Adding email to admin console 2015-09-21 15:11:56 -07:00			`return SendMailUsingConfig(to, subject, body, Cfg)`
			`}`

			`func SendMailUsingConfig(to, subject, body string, config model.Config) model.AppError {`
PLT-470 Adding STMP server connection check 2015-09-29 11:59:26 -07:00			`if !config.EmailSettings.SendEmailNotifications \|\| len(config.EmailSettings.SMTPServer) == 0 {`
Fixes mm-1415 adding email bypass flag 2015-07-12 23:36:52 -08:00			`return nil`
			`}`

PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`l4g.Debug(T("utils.mail.send_mail.sending.debug"), to, subject)`
PLT-1607 adding more debugging info for email and push notifications 2016-01-05 20:35:36 -06:00
Adding email to admin console 2015-09-21 15:11:56 -07:00			`fromMail := mail.Address{config.EmailSettings.FeedbackName, config.EmailSettings.FeedbackEmail}`
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`toMail := mail.Address{"", to}`

			`headers := make(map[string]string)`
			`headers["From"] = fromMail.String()`
			`headers["To"] = toMail.String()`
Fix email encoding issue 2015-10-15 21:17:52 +08:00			`headers["Subject"] = encodeRFC2047Word(subject)`
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`headers["MIME-version"] = "1.0"`
Fix email encoding issue 2015-10-15 21:17:52 +08:00			`headers["Content-Type"] = "text/html; charset=\"utf-8\""`
			`headers["Content-Transfer-Encoding"] = "8bit"`
Use better format for date, as RFC1123 re-defined it over RFC822, and states 'implementations SHOULD use numeric timezones instead of timezone names' 2015-08-27 15:02:50 +02:00			`headers["Date"] = time.Now().Format(time.RFC1123Z)`
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00
			`message := ""`
			`for k, v := range headers {`
			`message += fmt.Sprintf("%s: %s\r\n", k, v)`
			`}`
			`message += "\r\n<html><body>" + body + "</body></html>"`

Adding email to admin console 2015-09-21 15:11:56 -07:00			`conn, err1 := connectToSMTPServer(config)`
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`if err1 != nil {`
			`return err1`
			`}`
			`defer conn.Close()`

Adding email to admin console 2015-09-21 15:11:56 -07:00			`c, err2 := newSMTPClient(conn, config)`
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`if err2 != nil {`
			`return err2`
			`}`
			`defer c.Quit()`
			`defer c.Close()`
first commit 2015-06-14 23:53:32 -08:00
Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`if err := c.Mail(fromMail.Address); err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return model.NewLocAppError("SendMail", "utils.mail.send_mail.from_address.app_error", nil, err.Error())`
first commit 2015-06-14 23:53:32 -08:00			`}`

Adding check of email configuation settings when config file is loaded 2015-06-17 11:50:51 -04:00			`if err := c.Rcpt(toMail.Address); err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return model.NewLocAppError("SendMail", "utils.mail.send_mail.to_address.app_error", nil, err.Error())`
first commit 2015-06-14 23:53:32 -08:00			`}`

			`w, err := c.Data()`
			`if err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return model.NewLocAppError("SendMail", "utils.mail.send_mail.msg_data.app_error", nil, err.Error())`
first commit 2015-06-14 23:53:32 -08:00			`}`

			`_, err = w.Write([]byte(message))`
			`if err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return model.NewLocAppError("SendMail", "utils.mail.send_mail.msg.app_error", nil, err.Error())`
first commit 2015-06-14 23:53:32 -08:00			`}`

			`err = w.Close()`
			`if err != nil {`
PLT-7: Refactoring manuatesting & utils to use translations (chunk 5) - Add spanish translations - Skip tests 2016-01-25 00:49:19 -03:00			`return model.NewLocAppError("SendMail", "utils.mail.send_mail.close.app_error", nil, err.Error())`
first commit 2015-06-14 23:53:32 -08:00			`}`

			`return nil`
			`}`