ses

Documentation

Index

• type Config
  • func (c Config) DefaultsAndValidate() (Config, error)
• type InitializedConfig
• type SES
  • func NewProvider(conf Config) (SES, error)
  • func NewProviderInitialized(conf InitializedConfig, svc *ses.SES) (SES, error)
  • func (s SES) SendMagicLink(ctx context.Context, e email.Email) error
  • func (s SES) SendOTP(ctx context.Context, e email.Email) error

Types

type Config

type Config struct {
	AWSRegion   string                         `json:"awsRegion"`
	AccessKeyID string                         `json:"accessKeyID"`
	FromEmail   *jt.JSONType[*netMail.Address] `json:"fromEmail"`
	SecretKey   string                         `json:"secretKey"`
}

Config is the configuration for the AWS SES provider. It includes assets to create an AWS session.

func (Config) DefaultsAndValidate

func (c Config) DefaultsAndValidate() (Config, error)

DefaultsAndValidate implements the jsontype.Config interface.

type InitializedConfig

type InitializedConfig struct {
	FromEmail *netMail.Address
}

InitializedConfig is the configuration for the AWS SES provider after it has been initialized.

type SES

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

SES is an email provider that uses AWS SES.

func NewProvider

func NewProvider(conf Config) (SES, error)

NewProvider creates a new SES provider. It will create an AWS session using the provided configuration.

func NewProviderInitialized

func NewProviderInitialized(conf InitializedConfig, svc *ses.SES) (SES, error)

NewProviderInitialized creates a new SES provider with an initialized configuration.

func (SES) SendMagicLink

func (s SES) SendMagicLink(ctx context.Context, e email.Email) error

func (SES) SendOTP

func (s SES) SendOTP(ctx context.Context, e email.Email) error