emaildriver

README

Tyk Email Driver

Tyk Email driver is a simple driver-based approach to handling multiple transactional email providers and easily switching between them using configuration only.

Warranty

This software is provided with absolutely no warranty.

Documentation

Index

• Variables
• type AmazonSESEmailBackend
  • func (s *AmazonSESEmailBackend) Init(conf map[string]string) error
  • func (s *AmazonSESEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, ...) error
• type EmailBackend
  • func GetEmailBackend(code string) (EmailBackend, error)
• type EmailMeta
• type MailgunEmailBackend
  • func (m *MailgunEmailBackend) Init(conf map[string]string) error
  • func (m *MailgunEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, ...) error
• type MandrillEmailBackend
  • func (m *MandrillEmailBackend) Init(conf map[string]string) error
  • func (m *MandrillEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, ...) error
• type MockEmailBackend
  • func (m *MockEmailBackend) Init(conf map[string]string) error
  • func (m *MockEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, ...) error
• type SMTPEmailBackend
  • func (m *SMTPEmailBackend) Init(conf map[string]string) error
  • func (m *SMTPEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, ...) error
• type SendGridEmailBackend
  • func (m *SendGridEmailBackend) Init(conf map[string]string) error
  • func (m *SendGridEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, ...) error
• type TykTemplateName

Variables

var EmailBackendCodes = map[string]EmailBackend{
	"mandrill":  &MandrillEmailBackend{},
	"sendgrid":  &SendGridEmailBackend{},
	"mailgun":   &MailgunEmailBackend{},
	"amazonses": &AmazonSESEmailBackend{},
	"smtp":      &SMTPEmailBackend{},
	"mock":      &MockEmailBackend{},
}

var PortalEmailTemplatesHTML *template.Template

var PortalEmailTemplatesTXT *template.Template

Types

type AmazonSESEmailBackend

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

func (*AmazonSESEmailBackend) Init

func (s *AmazonSESEmailBackend) Init(conf map[string]string) error

func (*AmazonSESEmailBackend) Send

func (s *AmazonSESEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, htmlTemplateName TykTemplateName, OrgId string, Styles string) error

Send Sends emails using Amazon SES

type EmailBackend

type EmailBackend interface {
	Init(map[string]string) error
	Send(EmailMeta, interface{}, TykTemplateName, TykTemplateName, string, string) error
}

func GetEmailBackend

func GetEmailBackend(code string) (EmailBackend, error)

type EmailMeta

type EmailMeta struct {
	RecipientEmail string
	RecipientName  string
	FromEmail      string
	FromName       string
	Subject        string
}

type MailgunEmailBackend

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

func (*MailgunEmailBackend) Init

func (m *MailgunEmailBackend) Init(conf map[string]string) error

func (*MailgunEmailBackend) Send

func (m *MailgunEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, htmlTemplateName TykTemplateName, OrgId string, Styles string) error

type MandrillEmailBackend

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

func (*MandrillEmailBackend) Init

func (m *MandrillEmailBackend) Init(conf map[string]string) error

func (*MandrillEmailBackend) Send

func (m *MandrillEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, htmlTemplateName TykTemplateName, OrgId string, Styles string) error

type MockEmailBackend

type MockEmailBackend struct{}

func (*MockEmailBackend) Init

func (m *MockEmailBackend) Init(conf map[string]string) error

func (*MockEmailBackend) Send

func (m *MockEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, htmlTemplateName TykTemplateName, OrgId string, Styles string) error

type SMTPEmailBackend

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

func (*SMTPEmailBackend) Init

func (m *SMTPEmailBackend) Init(conf map[string]string) error

Init receives the configs, validates them and sets on the SMTPEmailBackend struct for use by Send function

func (*SMTPEmailBackend) Send

func (m *SMTPEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName,
	htmlTemplateName TykTemplateName, OrgId string, Styles string) error

type SendGridEmailBackend

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

func (*SendGridEmailBackend) Init

func (m *SendGridEmailBackend) Init(conf map[string]string) error

func (*SendGridEmailBackend) Send

func (m *SendGridEmailBackend) Send(emailMeta EmailMeta, emailData interface{}, textTemplateName TykTemplateName, htmlTemplateName TykTemplateName, OrgId string, Styles string) error

type TykTemplateName

type TykTemplateName string