email

Documentation

Index

• Constants
• type Client
• type Config
  • func LoadConfig(file string) (*Config, error)
• type MailgunClient
  • func NewMailgunClient(cfg *MailgunClientConfig) *MailgunClient
  • func (m *MailgunClient) Send(to string, subject string, htmlBody string) error
• type MailgunClientConfig
  • func LoadMailgunConfig(file string) (*MailgunClientConfig, error)
• type Provider
  • func NewProvider(locations []string) (*Provider, error)
  • func (p *Provider) GetProvider(id string) Client

Constants

const MailgunProviderName = "mailgun"

MailgunProviderName is mailgun provider name

Types

type Client

type Client interface {
	Send(to string, subject string, htmlBody string) error
}

Client exposes send email operations

type Config

type Config struct {
	// ProviderID specifies email provider id
	ProviderID string `json:"provider_id" yaml:"provider_id"`
}

Config provides email providers common configuration

func LoadConfig

func LoadConfig(file string) (*Config, error)

LoadConfig returns configuration loaded from a file

type MailgunClient

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

MailgunClient client for Mailgun

func NewMailgunClient

func NewMailgunClient(cfg *MailgunClientConfig) *MailgunClient

NewMailgunClient creates a new mailgun client

func (*MailgunClient) Send

func (m *MailgunClient) Send(to string, subject string, htmlBody string) error

Send implements email sender for users

type MailgunClientConfig

type MailgunClientConfig struct {
	// ProviderID specifies email provider id
	ProviderID string `json:"provider_id" yaml:"provider_id"`
	// Domain specifies domain emails are sent from
	Domain string `json:"domain" yaml:"domain"`
	// Sender specifies sender email
	Sender string `json:"sender" yaml:"sender"`
	// APIKey specifies mailgun private key
	APIKey string `json:"api_key" yaml:"api_key"`
}

MailgunClientConfig config for Mailgun

func LoadMailgunConfig

func LoadMailgunConfig(file string) (*MailgunClientConfig, error)

LoadMailgunConfig returns mailgun configuration loaded from a file

type Provider

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

Provider of email clients

func NewProvider

func NewProvider(locations []string) (*Provider, error)

NewProvider returns provider

func (*Provider) GetProvider

func (p *Provider) GetProvider(id string) Client

GetProvider returns email provider by id