mailer

Documentation

Index

• type Mailer
  • func New(host, port, user, password, from, baseURL string) *Mailer
  • func (m *Mailer) SendInvitationEmail(toEmail, token string) error
  • func (m *Mailer) SendTOTPRecoveryEmail(toEmail, token string) error
  • func (m *Mailer) SendVerificationEmail(toEmail, token string) error

Types

type Mailer

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

Mailer sends transactional emails via SMTP. Port 587 uses STARTTLS; port 465 uses implicit TLS (SMTPS).

func New

func New(host, port, user, password, from, baseURL string) *Mailer

func (*Mailer) SendInvitationEmail

func (m *Mailer) SendInvitationEmail(toEmail, token string) error

SendInvitationEmail sends an invitation with a link to the web app's registration screen, pre-filled with the invitation token and email.

func (*Mailer) SendTOTPRecoveryEmail

func (m *Mailer) SendTOTPRecoveryEmail(toEmail, token string) error

SendTOTPRecoveryEmail sends a one-time link that disables two-factor authentication for the account (used when the authenticator is lost).

func (*Mailer) SendVerificationEmail

func (m *Mailer) SendVerificationEmail(toEmail, token string) error

SendVerificationEmail sends a one-time email-verification link to toEmail.