mailer

Documentation

Index

• type Mailer
  • func New(config *config.Config) *Mailer
  • func (mailer *Mailer) Send(options SendOptions) error
• type SendOptions

Types

type Mailer

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

Interface between the server and the service it uses to send emails.

func New

func New(config *config.Config) *Mailer

Creates and initializes a new Mailer based on the specified config.

func (*Mailer) Send

func (mailer *Mailer) Send(options SendOptions) error

Sends an email with the specified contents to the specified email address.

type SendOptions

type SendOptions struct {
	// Body of the email to be sent.
	Message string
	// Subject of the email to be sent.
	Subject string
	// Email address of the receipient of the email to be sent.
	ToEmailAddress string
}

Options configuring Mailer#Send(...).