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 ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var EmailBackendCodes = map[string]EmailBackend{ "mandrill": &MandrillEmailBackend{}, "sendgrid": &SendGridEmailBackend{}, "mailgun": &MailgunEmailBackend{}, "amazonses": &AmazonSESEmailBackend{}, "smtp": &SMTPEmailBackend{}, "mock": &MockEmailBackend{}, }
View Source
var PortalEmailTemplatesHTML *template.Template
View Source
var PortalEmailTemplatesTXT *template.Template
Functions ¶
This section is empty.
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 MailgunEmailBackend ¶
type MailgunEmailBackend struct {
// contains filtered or unexported fields
}
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) 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
Source Files
Click to show internal directories.
Click to hide internal directories.