drivers

Documentation

Index

• func NewMailgun(cfg mail.Config) (mail.Mailer, error)
• func NewPostal(cfg mail.Config) (mail.Mailer, error)
• func NewPostmark(cfg mail.Config) (mail.Mailer, error)
• func NewSMTP(cfg mail.Config) (mail.Mailer, error)
• func NewSendGrid(cfg mail.Config) (mail.Mailer, error)
• func NewSparkPost(cfg mail.Config) (mail.Mailer, error)

Examples

• NewMailgun
• NewPostal
• NewPostmark
• NewSendGrid
• NewSparkPost

Functions

func NewMailgun

func NewMailgun(cfg mail.Config) (mail.Mailer, error)

NewMailgun creates a new Mailgun client. Configuration is validated before initialisation.

Example

cfg := mail.Config{
	URL:         "https://api.eu.mailgun.net", // Or https://api.mailgun.net
	APIKey:      "my-key",
	FromAddress: "hello@gophers.com",
	FromName:    "Gopher",
	Domain:      "my-domain.com",
}

_, err := NewMailgun(cfg)
if err != nil {
	log.Fatalln(err)
}

func NewPostal

func NewPostal(cfg mail.Config) (mail.Mailer, error)

NewPostal creates a new Postal client. Configuration is validated before initialisation.

Example

cfg := mail.Config{
	URL:         "https://postal.example.com",
	APIKey:      "my-key",
	FromAddress: "hello@gophers.com",
	FromName:    "Gopher",
}

_, err := NewPostal(cfg)
if err != nil {
	log.Fatalln(err)
}

func NewPostmark

func NewPostmark(cfg mail.Config) (mail.Mailer, error)

NewPostmark creates a new Postmark client. Configuration is validated before initialisation.

Example

cfg := mail.Config{
	URL:         "https://postal.example.com",
	APIKey:      "my-key",
	FromAddress: "hello@gophers.com",
	FromName:    "Gopher",
}

_, err := NewPostal(cfg)
if err != nil {
	log.Fatalln(err)
}

func NewSMTP

func NewSMTP(cfg mail.Config) (mail.Mailer, error)

NewSMTP creates a new smtp client. Configuration is validated before initialisation.

func NewSendGrid

func NewSendGrid(cfg mail.Config) (mail.Mailer, error)

NewSendGrid creates a new sendGrid client. Configuration is validated before initialisation.

Example

cfg := mail.Config{
	APIKey:      "my-key",
	FromAddress: "hello@gophers.com",
	FromName:    "Gopher",
}

_, err := NewSendGrid(cfg)
if err != nil {
	log.Fatalln(err)
}

func NewSparkPost

func NewSparkPost(cfg mail.Config) (mail.Mailer, error)

NewSparkPost creates a new SparkPost client. Configuration is validated before initialisation.

Example

cfg := mail.Config{
	URL:         "https://api.eu.sparkpost.com", // Or https://api.sparkpost.com/api/v1
	APIKey:      "my-key",
	FromAddress: "hello@gophers.com",
	FromName:    "Gopher",
}

_, err := NewSparkPost(cfg)
if err != nil {
	log.Fatalln(err)
}