Categorygithub.com/ory/mail/v3
modulepackage
3.0.0
Repository: https://github.com/ory/mail.git
Documentation: pkg.go.dev

# README

ory/mail

This is a fork of the abandoned go-mail/mail which is an abandoned fork of go-gomail/gomail

Introduction

ory/mail is a simple and efficient package to send emails. It is well tested and documented.

ory/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.

Features

ory/mail 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

Use

$ go get github.com/ory/mail/v3

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 ory/mail. 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"

	"github.com/ory/mail"
)

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.

Contribute

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

# Functions

NewDialer returns a new SMTP Dialer.
NewMessage creates a new message.
NewPlainDialer returns a new SMTP Dialer.
Rename is a file setting to set the name of the attachment if the name is different than the filename on disk.
Send sends emails using the given Sender.
SetCharset is a message setting to set the charset of the email.
SetCopyFunc is a file setting to replace the function that runs when the message is sent.
SetEncoding is a message setting to set the encoding of the email.
SetHeader is a file setting to set the MIME header of the message part that contains the file content.
SetPartEncoding sets the encoding of the part added to the message.

# Constants

Base64 represents the base64 encoding as defined in RFC 2045.
MandatoryStartTLS means that SMTP transactions must be encrypted.
NoStartTLS means encryption is disabled and messages are sent in the clear.
OpportunisticStartTLS means that SMTP transactions are encrypted if STARTTLS is supported by the SMTP server.
QuotedPrintable represents the quoted-printable encoding as defined in RFC 2045.
Unencoded can be used to avoid encoding the body of an email.

# Variables

NetDialTimeout specifies the DialTimeout function to establish a connection to the SMTP server.

# Structs

A Dialer is a dialer to an SMTP server.
Message represents an email.
A SendError represents the failure to transmit a Message, detailing the cause of the failure and index of the Message within a batch.
StartTLSUnsupportedError is returned by Dial when connecting to an SMTP server that does not support STARTTLS.

# Interfaces

SendCloser is the interface that groups the Send and Close methods.
Sender is the interface that wraps the Send method.

# Type aliases

Encoding represents a MIME encoding scheme like quoted-printable or base64.
A FileSetting can be used as an argument in Message.Attach or Message.Embed.
A MessageSetting can be used as an argument in NewMessage to configure an email.
A PartSetting can be used as an argument in Message.SetBody, Message.SetBodyWriter, Message.AddAlternative or Message.AddAlternativeWriter to configure the part added to a message.
A SendFunc is a function that sends emails to the given addresses.
StartTLSPolicy constants are valid values for Dialer.StartTLSPolicy.