email

Documentation

Index

• type Auth
• type EmailConfig
• type GetEmailTemplateDataRequest
• type GetEmailTemplateDataResponse
• type IEmailRenderer
• type IEmailService
• type IEmailTemplateData
• type PlainAuth
• type RenderEmailRequest
• type RenderEmailResponse
• type SendEmailRequest
• type SendEmailResponse
• type SendSimpleEmailRequest
• type SendSimpleEmailResponse

Types

type Auth

type Auth struct {
	PlainAuth *PlainAuth `json:"plainAuth"`
}

type EmailConfig

type EmailConfig struct {
	TemplateEngine *template.Template `json:"-"`
	Host           string             `json:"host"`
	Auth           *Auth              `json:"auth"`
	FromName       string             `json:"fromName"`
	FromEmail      string             `json:"fromEmail"`
	JustLogIt      bool               `json:"justLogIt"`
}

type GetEmailTemplateDataRequest

type GetEmailTemplateDataRequest struct {
	// SubjectId is a well-known identifier for the email subject
	SubjectId string
}

type GetEmailTemplateDataResponse

type GetEmailTemplateDataResponse struct {
	Data map[string]interface{}
}

type IEmailRenderer

type IEmailRenderer interface {
	RenderEmail(ctx context.Context, request *RenderEmailRequest) (*RenderEmailResponse, error)
}

type IEmailService

type IEmailService interface {
	SendEmail(ctx context.Context, request *SendEmailRequest) (*SendEmailResponse, error)
	SendSimpleEmail(ctx context.Context, request *SendSimpleEmailRequest) (*SendSimpleEmailResponse, error)
}

type IEmailTemplateData

type IEmailTemplateData interface {
	GetEmailTemplateData(request *GetEmailTemplateDataRequest) (*GetEmailTemplateDataResponse, error)
}

type PlainAuth

type PlainAuth struct {
	Identity string `json:"identity"`
	Username string `json:"username"`
	Password string `json:"password"`
	Host     string `json:"host"`
}

type RenderEmailRequest

type RenderEmailRequest struct {
	HtmlTemplate string
	TextTemplate string
	Data         map[string]interface{}
}

type RenderEmailResponse

type RenderEmailResponse struct {
	Html string
	Text string
}

type SendEmailRequest

type SendEmailRequest struct {
	ToEmail      string
	SubjectId    string
	HtmlTemplate string
	TextTemplate string
	Data         map[string]interface{}
}

type SendEmailResponse

type SendEmailResponse struct{}

type SendSimpleEmailRequest

type SendSimpleEmailRequest struct {
	ToEmail   string
	SubjectId string
	BodyId    string
	Data      map[string]string
}

type SendSimpleEmailResponse

type SendSimpleEmailResponse struct{}