Skip to content
Actively maintained fork of gomail. The best way to send emails in Go.
Go
Branch: v2
Clone or download
#64 Compare This branch is 50 commits ahead of go-gomail:v2.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.travis.yml
CHANGELOG.md Prepare to release v2.3.1 Nov 12, 2018
CONTRIBUTING.md Updated CONTRIBUTING.md Jul 29, 2015
LICENSE Initial commit Oct 15, 2014
README.md
auth.go Rename package to mail Dec 7, 2017
auth_test.go Rename package to mail Dec 7, 2017
doc.go Rename package to mail Dec 7, 2017
errors.go Add SendError struct implementing the error interface Mar 16, 2018
example_test.go
message.go
message_test.go Accept io.Reader for Attach and Embed Nov 10, 2018
mime.go Rename package to mail Dec 7, 2017
mime_go14.go Fix missing import in mime_go14.go Dec 7, 2017
send.go
send_test.go
smtp.go Add Dialer.StartTLSPolicy for securing STARTTLS Mar 1, 2018
smtp_test.go Add Dialer.StartTLSPolicy for securing STARTTLS Mar 1, 2018
writeto.go messageWriter: don't ignore error in writeString Jul 31, 2018

README.md

Gomail

Build Status Code Coverage Documentation

This is an actively maintained fork of Gomail and includes fixes and improvements for a number of outstanding issues. The current progress is as follows:

  • Timeouts and retries can be specified outside of the 10 second default.
  • Proxying is supported through specifying a custom NetDialTimeout.
  • Filenames are properly encoded for non-ASCII characters.
  • Email addresses are properly encoded for non-ASCII characters.
  • Embedded files and attachments are tested for their existence.
  • An io.Reader can be supplied when embedding and attaching files.

See Transitioning Existing Codebases for more information on switching.

Introduction

Gomail is a simple and efficient package to send emails. It is well tested and documented.

Gomail can only send emails using an SMTP server. But the API is flexible and it is easy to implement other methods for sending emails using a local Postfix, an API, etc.

It requires Go 1.2 or newer. With Go 1.5, no external dependencies are used.

Features

Gomail supports:

  • Attachments
  • Embedded images
  • HTML and text templates
  • Automatic encoding of special characters
  • SSL and TLS
  • Sending multiple emails with the same SMTP connection

Documentation

https://godoc.org/github.com/go-mail/mail

Download

If you're already using a dependency manager, like dep, use the following import path:

github.com/go-mail/mail

If you aren't using vendoring, go get the Gopkg.in import path:

gopkg.in/mail.v2

Examples

See the examples in the documentation.

FAQ

x509: certificate signed by unknown authority

If you get this error it means the certificate used by the SMTP server is not considered valid by the client running Gomail. As a quick workaround you can bypass the verification of the server's certificate chain and host name by using SetTLSConfig:

package main

import (
	"crypto/tls"

	"gopkg.in/mail.v2"
)

func main() {
	d := mail.NewDialer("smtp.example.com", 587, "user", "123456")
	d.TLSConfig = &tls.Config{InsecureSkipVerify: true}

	// Send emails using d.
}

Note, however, that this is insecure and should not be used in production.

Transitioning Existing Codebases

If you're already using the original Gomail, switching is as easy as updating the import line to:

import gomail "gopkg.in/mail.v2"

Contribute

Contributions are more than welcome! See CONTRIBUTING.md for more info.

Change log

See CHANGELOG.md.

License

MIT

Support & Contact

You can ask questions on the Gomail thread in the Go mailing-list.

You can’t perform that action at this time.