email

Documentation

Index

• Constants
• Variables
• type Email
• type MultiProviderOptions
• type Provider
  • func NewMultiProvider(providers []Provider, options MultiProviderOptions) (Provider, error)
• type TemplateData
• type TemplateMetadata

Constants

const (
	// MSOButtonStop is the HTML to stop MSO button spacing.
	MSOButtonStop = `<!--[if mso]>
                          <i style="letter-spacing: 24px">&#8202;</i>
                        <![endif]-->`
	// MSOButtonStart is the HTML to start MSO button spacing.
	MSOButtonStart = `` /* 138-byte string literal not displayed */

	// MSOHead is the HTML to start MSO head.
	MSOHead = `` /* 366-byte string literal not displayed */

)

Variables

var ErrProvider = errors.New("error with email provider")

ErrProvider is returned when there is an error with the email provider.

var HTMLTemplate string

HTMLTemplate is the HTML template for the email.

var TextTemplate string

TextTemplate is the text template for the email.

Types

type Email

type Email struct {
	Subject      string
	TemplateData TemplateData
	To           *mail.Address
}

Email is the model for an email.

type MultiProviderOptions

type MultiProviderOptions struct {
	Logger *slog.Logger
}

MultiProviderOptions are the options for the multi-provider.

type Provider

type Provider interface {
	Send(ctx context.Context, e Email) error
}

Provider is the interface for an email provider.

func NewMultiProvider

func NewMultiProvider(providers []Provider, options MultiProviderOptions) (Provider, error)

NewMultiProvider creates a new multiple email provider.

type TemplateData

type TemplateData struct {
	ButtonText   string
	Expiration   string
	Greeting     string
	MagicLink    string
	Meta         TemplateMetadata
	Subtitle     string
	Title        string
	LogoImageURL string
	LogoClickURL string
	LogoAltText  string
	ReCATPTCHA   bool
}

TemplateData is the data for the email templates.

type TemplateMetadata

type TemplateMetadata struct {
	HTMLInstruction string
	HTMLTitle       string
	MSOButtonStop   template.HTML
	MSOButtonStart  template.HTML
	MSOHead         template.HTML
}

TemplateMetadata contains non-configurable metadata for the email templates.