Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

DiJester/gomail

 
 

Repository files navigation

Gomail

Build Status Code Coverage Documentation

Why This Version

Problem

When an email's recipient list contains invalid email addresses (wrong format, inactive account, etc), the email could not be delivered successfully. So the other recipients won't receive the email.

Solution

This version introduces a flag SkipErrRcpt. When the flag is set, the send function will ignore the invalid email addresses in recipient list.

How to use

After initing the dialer d, call d.SetSkipErrRcpt(true) to enable the feature.

    package main

    import (
    	"crypto/tls"
        "go.uber.org/zap"
        "github.com/pingcap/log"
    	"github.com/dijester/gomail"
    )

    func main() {
    	d := gomail.NewDialer("smtp.example.com", 587, "user", "123456")
    	d.TLSConfig = &tls.Config{InsecureSkipVerify: true}
        d.SetSkipErrRcpt(true)
        // Send emails using d.
        m := yourBuildMessageFunc()
        err := d.DialAndSend(m)
        if err != nil {
            if !gomail.IsSkipRcptErr(err) {
                 panic(err)
            }
            // if error is SkipRcptErr, you can ignore the error or do some log
            log.Info("email sent with skipped recipients", zap.String("details", err.Error()))
        }
    }

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 is versioned using gopkg.in so I promise there will never be backward incompatible changes within each version.

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/gopkg.in/gomail.v2

Download

go get gopkg.in/gomail.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/gomail.v2"
)

func main() {
	d := gomail.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.

Contribute

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

Change log

See CHANGELOG.md.

License

MIT

Contact

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

About

The best way to send emails in Go.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%