Popularity
5.3
Growing
Activity
6.2
Growing
161
4
34

Programming language: Go
License: MIT License
Tags: Email    
Latest version: v2.6.0

go-simple-mail alternatives and similar packages

Based on the "Email" category.
Alternatively, view go-simple-mail alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of go-simple-mail or a related project?

Add another 'Email' Package

README

Go Simple Mail

The best way to send emails in Go with SMTP Keep Alive and Timeout for Connect and Send.

IMPORTANT

Examples in this README are for v2.2.0 and above. Examples for older versions can be found here.

The minimum Go version is 1.13, for Go 1.12 and older use branch go1.12.

Breaking change in 2.2.0: The signature of SetBody and AddAlternative used to accept strings ("text/html" and "text/plain") and not require on of the contentType constants (TextHTML or TextPlain). Upgrading, while not quite following semantic versioning, is quite simple:

  email := mail.NewMSG()
- email.SetBody("text/html", htmlBody)
- email.AddAlternative("text/plain", plainBody)
+ email.SetBody(mail.TextHTML, htmlBody)
+ email.AddAlternative(mail.TextPlain, plainBody)

Introduction

Go Simple Mail is a simple and efficient package to send emails. It is well tested and documented.

Go Simple Mail 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.

This package contains (and is based on) two packages by Joe Grasse:

A lot of changes in Go Simple Mail were sent with not response.

Features

Go Simple Mail supports:

  • Multiple Attachments with path
  • Multiple Attachments in base64
  • Multiple Attachments from bytes (since v2.6.0)
  • Inline attachments from file, base64 and bytes (bytes since v2.6.0)
  • Multiple Recipients
  • Priority
  • Reply to
  • Set sender
  • Set from
  • Allow sending mail with different envelope from (since v2.7.0)
  • Embedded images
  • HTML and text templates
  • Automatic encoding of special characters
  • SSL/TLS and STARTTLS
  • Unencrypted connection (not recommended)
  • Sending multiple emails with the same SMTP connection (Keep Alive or Persistent Connection)
  • Timeout for connect to a SMTP Server
  • Timeout for send an email
  • Return Path
  • Alternative Email Body
  • CC and BCC
  • Add Custom Headers in Message
  • Send NOOP, RESET, QUIT and CLOSE to SMTP client
  • PLAIN, LOGIN and CRAM-MD5 Authentication (since v2.3.0)
  • Custom TLS Configuration (since v2.5.0)
  • Send a RFC822 formatted message (since v2.8.0)
  • Send from localhost (yes, Go standard SMTP package cannot do that because... WTF Google!)

Documentation

https://pkg.go.dev/github.com/xhit/go-simple-mail/v2?tab=doc

Download

This package uses go modules.

$ go get github.com/xhit/go-simple-mail/v2

Usage

package main

import (
    "log"

    "github.com/xhit/go-simple-mail/v2"
)

const htmlBody = `<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title>Hello Gophers!</title>
    </head>
    <body>
        <p>This is the <b>Go gopher</b>.</p>
        <p><img src="cid:Gopher.png" alt="Go gopher" /></p>
        <p>Image created by Renee French</p>
    </body>
</html>`

func main() {
    server := mail.NewSMTPClient()

    // SMTP Server
    server.Host = "smtp.example.com"
    server.Port = 587
    server.Username = "[email protected]"
    server.Password = "examplepass"
    server.Encryption = mail.EncryptionSTARTTLS

    // Since v2.3.0 you can specified authentication type:
    // - PLAIN (default)
    // - LOGIN
    // - CRAM-MD5
    // server.Authentication = mail.AuthPlain

    // Variable to keep alive connection
    server.KeepAlive = false

    // Timeout for connect to SMTP Server
    server.ConnectTimeout = 10 * time.Second

    // Timeout for send the data and wait respond
    server.SendTimeout = 10 * time.Second

    // Set TLSConfig to provide custom TLS configuration. For example,
    // to skip TLS verification (useful for testing):
    server.TLSConfig = &tls.Config{InsecureSkipVerify: true}

    // SMTP client
    smtpClient,err := server.Connect()

    if err != nil{
        log.Fatal(err)
    }

    // New email simple html with inline and CC
    email := mail.NewMSG()
    email.SetFrom("From Example <[email protected]>").
        AddTo("[email protected]").
        AddCc("[email protected]").
        SetSubject("New Go Email")

    email.SetBody(mail.TextHTML, htmlBody)

    email.AddInline("/path/to/image.png", "Gopher.png")

    // Call Send and pass the client
    err = email.Send(smtpClient)
    if err != nil {
        log.Println(err)
    } else {
        log.Println("Email Sent")
    }
}

Send multiple emails in same connection

    //Set your smtpClient struct to keep alive connection
    server.KeepAlive = true

    for _, to := range []string{
        "[email protected]",
        "[email protected]",
        "[email protected]",
    } {
        // New email simple html with inline and CC
        email := mail.NewMSG()
        email.SetFrom("From Example <[email protected]>").
            AddTo(to).
            SetSubject("New Go Email")

        email.SetBody(mail.TextHTML, htmlBody)
        email.AddInline("/path/to/image.png", "Gopher.png")

        // Call Send and pass the client
        err = email.Send(smtpClient)
        if err != nil {
            log.Println(err)
        } else {
            log.Println("Email Sent")
        }
    }

More examples

See [example/example_test.go](example/example_test.go).