emailsender

Documentation

Index

• type EmailSender
  • func NewEmailConsumer(config *worker.Config, log log.Logger) *EmailSender
  • func NewEmailSender(config *worker.Config, log log.Logger) (*EmailSender, error)
  • func (ew *EmailSender) ConsumeJobs() error
  • func (ew *EmailSender) EnqueueMailJob(job *Job) error
  • func (ew *EmailSender) Shutdown() error
• type Job
• type MailTemplate
  • func NewMailTemplate(textPath, htmlPath string) (*MailTemplate, error)
• type MailTemplates
  • func NewMailTemplates() (*MailTemplates, error)

Types

type EmailSender

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

func NewEmailConsumer

func NewEmailConsumer(config *worker.Config, log log.Logger) *EmailSender

func NewEmailSender

func NewEmailSender(config *worker.Config, log log.Logger) (*EmailSender, error)

NewEmailSender returns a new instance of EmailWorker.

func (*EmailSender) ConsumeJobs

func (ew *EmailSender) ConsumeJobs() error

func (*EmailSender) EnqueueMailJob

func (ew *EmailSender) EnqueueMailJob(job *Job) error

func (*EmailSender) Shutdown

func (ew *EmailSender) Shutdown() error

type Job

type Job struct {
	TextTemplate string      `json:"textTemplate"`
	HTMLTemplate string      `json:"htmlTemplate"`
	Subject      string      `json:"subject"`
	Sender       string      `json:"sender"`
	From         string      `json:"from"`
	To           string      `json:"to"`
	Recipient    string      `json:"recipient"`
	Data         interface{} `json:"data"`
}

type MailTemplate

type MailTemplate struct {
	TextTemplate string
	HTMLTemplate string
}

MailTemplate is a set of templates for emails, specifically for the MIME type text/plain and text/html.

func NewMailTemplate

func NewMailTemplate(textPath, htmlPath string) (*MailTemplate, error)

NewEmailTemplate returns a new instance of MailTemplate.

type MailTemplates

type MailTemplates struct {
	PasswordReset *MailTemplate
	UserInvite    *MailTemplate
}

MailTemplates contain all the templates in memory required for enqueuing mail jobs.

func NewMailTemplates

func NewMailTemplates() (*MailTemplates, error)

NewMailTemplates returns a new instance of MailTemplates.