email

Documentation

Overview

Package email provides email sending functionality.

Index

• type ContentLoginToken
• type Email
  • func NewEmail(name string, address string) Email
• type Mailer
  • func NewMailer() (*Mailer, error)
  • func (m *Mailer) LoginToken(name, address string, content ContentLoginToken) error
  • func (m *Mailer) Send(email *message) error
• type MockMailer
  • func (s *MockMailer) LoginToken(n, e string, c ContentLoginToken) error

Types

type ContentLoginToken

type ContentLoginToken struct {
	Email  string
	Name   string
	URL    string
	Token  string
	Expiry time.Time
}

ContentLoginToken defines content for login token email template.

type Email

type Email struct {
	Name    string
	Address string
}

Email struct holds email address and recipient name.

func NewEmail

func NewEmail(name string, address string) Email

NewEmail returns an email address.

type Mailer

type Mailer struct {
	// contains filtered or unexported fields
}

Mailer is a SMTP mailer.

func NewMailer

func NewMailer() (*Mailer, error)

NewMailer returns a configured SMTP Mailer.

func (*Mailer) LoginToken

func (m *Mailer) LoginToken(name, address string, content ContentLoginToken) error

LoginToken creates and sends a login token email with provided template content.

func (*Mailer) Send

func (m *Mailer) Send(email *message) error

Send sends the mail via smtp.

type MockMailer

type MockMailer struct {
	LoginTokenFn      func(name, email string, c ContentLoginToken) error
	LoginTokenInvoked bool
}

MockMailer is a mock Mailer

func (*MockMailer) LoginToken

func (s *MockMailer) LoginToken(n, e string, c ContentLoginToken) error

LoginToken is a mock for LoginToken