email

Documentation

Index

• Constants
• type AWSSESConfig
• type BodyFromHTMLParams
• type BodyFromMJMLParams
• type Config
• type Interface
  • func Init(cfg Config, log logger.Interface) Interface
• type Recipient
• type SMTPConfig
• type SendEmailParams
• type TemplateConfig
• type TemplateInterface

Constants

const (
	BodyContentTypePlain string = "text/plain"
	BodyContentTypeHTML  string = "text/html"
)

Types

type AWSSESConfig

type AWSSESConfig struct {
	Region          string
	AccessKeyID     string
	SecretAccessKey string
}

type BodyFromHTMLParams

type BodyFromHTMLParams struct {
	Filename          string
	OverrideDirectory string
	Data              any
	FuncMap           map[string]any
}

type BodyFromMJMLParams

type BodyFromMJMLParams struct {
	Filename          string
	OverrideDirectory string
	Data              any
	FuncMap           map[string]any
}

type Config

type Config struct {
	SMTP     SMTPConfig
	Template TemplateConfig
}

type Interface

type Interface interface {
	SendEmail(ctx context.Context, params SendEmailParams) error
	GenerateBody() TemplateInterface
}

func Init

func Init(cfg Config, log logger.Interface) Interface

type Recipient

type Recipient struct {
	ToEmails  []string
	CCEmails  []string
	BCCEmails []string
}

type SMTPConfig

type SMTPConfig struct {
	Host      string
	Port      int
	Username  string
	Password  string
	TLSConfig struct {
		InsecureSkipVerify bool
	}
}

type SendEmailParams

type SendEmailParams struct {
	Body        string
	BodyType    string
	Subject     string
	SenderName  string
	SenderEmail string
	Recipients  Recipient
	Attachments []string
	Headers     map[string]string
}

type TemplateConfig

type TemplateConfig struct {
	FileDirectory string
}

type TemplateInterface

type TemplateInterface interface {
	FromHTML(params BodyFromHTMLParams) (string, error)
	FromMJML(ctx context.Context, params BodyFromMJMLParams) (string, error)
}