email

Documentation

Index

• Constants
• func BindFormOrJSON(c *gin.Context, bindTo interface{}) (err error)
• func GenUUID() string
• func TimedDispatch(em *GenericEmailSender)
• func XData(x ...interface{}) (rv string)
• type AwsSesEmailSender
  • func (em *AwsSesEmailSender) SendEmailViaVendor(...) (error, string)
• type EmailSender
  • func NewEmailSender(senderType string, gcfg *data.BaseConfigType, db map[string]bool, f *os.File, ...) (rv EmailSender)
• type EmailSenderImplementation
  • func NewEmailSenderAwsSes(f *os.File) (rv EmailSenderImplementation)
  • func NewEmailSenderSendgrid(f *os.File) (rv EmailSenderImplementation)
• type GenericEmailSender
  • func (em *GenericEmailSender) GetCurTick() int
  • func (em GenericEmailSender) LogError(rowID, msg string, err error)
  • func (em GenericEmailSender) LogSuccess(rowID string)
  • func (em *GenericEmailSender) ResetLogFile(newFp *os.File)
  • func (em *GenericEmailSender) SendEmail(template_name string, param ...interface{}) (err error)
  • func (em *GenericEmailSender) SendEmailMapdata(template_name string, mdata map[string]interface{}) (err error)
  • func (em *GenericEmailSender) SendEmailViaVendor(...) (err error)
  • func (em *GenericEmailSender) SetupHandlerApi(router *gin.Engine, urlPath, AuthKey string)
  • func (em GenericEmailSender) SqlRunStmt(stmt string, encPat string, data ...interface{}) (rv []map[string]interface{}, err error)
  • func (em *GenericEmailSender) TemplateAndSend()
• type SendgridEmailSender
  • func (em *SendgridEmailSender) SendEmailViaVendor(...) (err error, result string)

Constants

const (
	// The character encoding for the email.
	CharSet = "UTF-8"
)

Functions

func BindFormOrJSON

func BindFormOrJSON(c *gin.Context, bindTo interface{}) (err error)

func GenUUID

func GenUUID() string

GenUUID generates a UUID and returns it.

func TimedDispatch

func TimedDispatch(em *GenericEmailSender)

func XData

func XData(x ...interface{}) (rv string)

XData convers a list of parameters to a JSON data showing what the list contains. This is returned as a string.

Types

type AwsSesEmailSender

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

func (*AwsSesEmailSender) SendEmailViaVendor

func (em *AwsSesEmailSender) SendEmailViaVendor(rowID, fromName, fromAddress, subject, toName, toAddress, textBody, htmlBody string) (error, string)

-------------------------------------------------------------------------------------------------------------------------

type EmailSender

type EmailSender interface {
	SendEmailViaVendor(rowID, fromName, fromAddress, subject, toName, toAddress, textBody, htmlBody string) (err error)
	SendEmail(template_name string, param ...interface{}) (err error)
	SendEmailMapdata(template_name string, mdata map[string]interface{}) (err error)
	LogError(rowID, msg string, err error)
	LogSuccess(rowID string)
	SetupHandlerApi(router *gin.Engine, urlPath, key string)
	ResetLogFile(newFp *os.File)
}

func NewEmailSender

func NewEmailSender(senderType string, gcfg *data.BaseConfigType, db map[string]bool, f *os.File, conn *pgxpool.Pool, ctx context.Context, lgr *zap.Logger, xmd *metrics.MetricsData) (rv EmailSender)

func NewEmailSender(senderType string, gcfg *data.BaseConfigType, db map[string]bool, f *os.File, conn *pgxpool.Pool, ctx context.Context, lgr *zap.Logger, xmd *metrics.MetricsData) (rv GenericEmailSender) {

type EmailSenderImplementation

type EmailSenderImplementation interface {
	SendEmailViaVendor(rowID, fromName, fromAddress, subject, toName, toAddress, textBody, htmlBody string) (err error, result string)
}

func NewEmailSenderAwsSes

func NewEmailSenderAwsSes(f *os.File) (rv EmailSenderImplementation)

func NewEmailSenderSendgrid

func NewEmailSenderSendgrid(f *os.File) (rv EmailSenderImplementation)

type GenericEmailSender

type GenericEmailSender struct {
	SenderName string

	TheSender EmailSenderImplementation

	// Debug flags like prevent send of email for testing
	DbFlag map[string]bool
	// contains filtered or unexported fields
}

func (*GenericEmailSender) GetCurTick

func (em *GenericEmailSender) GetCurTick() int

GetCurTics returns the number of times that a timeout has saved the data.

func (GenericEmailSender) LogError

func (em GenericEmailSender) LogError(rowID, msg string, err error)

-------------------------------------------------------------------------------------------------------------------------

CREATE TABLE if not exists q_qr_email_log (
	  email_email_id		uuid DEFAULT uuid_generate_v4() not null primary key
	, updated 			timestamp
	, created 			timestamp default current_timestamp not null
	, user_id			uuid
	, state				text
	, error_msg			text
	, email_data		text
);

func (GenericEmailSender) LogSuccess

func (em GenericEmailSender) LogSuccess(rowID string)

func (*GenericEmailSender) ResetLogFile

func (em *GenericEmailSender) ResetLogFile(newFp *os.File)

func (*GenericEmailSender) SendEmail

func (em *GenericEmailSender) SendEmail(template_name string, param ...interface{}) (err error)

SendEmail combines a base template name with globacl configuration on where to find the templates and turns that into all the parts of an email, then calls SendEmailViaVendor to send the email.

func (*GenericEmailSender) SendEmailMapdata

func (em *GenericEmailSender) SendEmailMapdata(template_name string, mdata map[string]interface{}) (err error)

func (*GenericEmailSender) SendEmailViaVendor

func (em *GenericEmailSender) SendEmailViaVendor(rowID, fromName, fromAddress, subject, toName, toAddress, textBody, htmlBody string) (err error)

SendEmailViaVendor will use the underlying implemenation to send the email.

func (*GenericEmailSender) SetupHandlerApi

func (em *GenericEmailSender) SetupHandlerApi(router *gin.Engine, urlPath, AuthKey string)

SetupHandlerApi will create a handler at the specified URL path to "kick" the timed sender

func (GenericEmailSender) SqlRunStmt

func (em GenericEmailSender) SqlRunStmt(stmt string, encPat string, data ...interface{}) (rv []map[string]interface{}, err error)

SqlRunStmt will run a single statemt and return the data as an array of maps

func (*GenericEmailSender) TemplateAndSend

func (em *GenericEmailSender) TemplateAndSend()

type SendgridEmailSender

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

func (*SendgridEmailSender) SendEmailViaVendor

func (em *SendgridEmailSender) SendEmailViaVendor(rowID, fromName, fromAddress, subject, toName, toAddress, textBody, htmlBody string) (err error, result string)

-------------------------------------------------------------------------------------------------------------------------