smtpx

Documentation

Index

• func DefaultShouldRetry(err error) bool
• func Send(c *Client, m *Message, retries *RetryConfig) error
• func SetSender(sender Sender)
• type Client
  • func NewClient(host string, port int, username, password, from string) *Client
  • func NewClientFromURL(connectionURL string) (*Client, error)
  • func (c *Client) Send(m *Message) error
• type Message
  • func NewMessage(recipients []string, subject, text, html string) *Message
• type MockSender
  • func NewMockSender(errs ...error) *MockSender
  • func (s *MockSender) Logs() []string
  • func (s *MockSender) Send(c *Client, m *Message) error
• type RetryConfig
  • func NewFixedRetries(backoffs ...time.Duration) *RetryConfig
  • func (r *RetryConfig) Backoff(n int) time.Duration
  • func (r *RetryConfig) MaxRetries() int
• type Sender

Functions

func DefaultShouldRetry

func DefaultShouldRetry(err error) bool

DefaultShouldRetry is the default function for determining if a send should be retried

func Send

func Send(c *Client, m *Message, retries *RetryConfig) error

Send an email using SMTP

func SetSender

func SetSender(sender Sender)

SetSender sets the sender used by Send

Types

type Client

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

Client is an SMTP client

func NewClient

func NewClient(host string, port int, username, password, from string) *Client

NewClient creates a new client

func NewClientFromURL

func NewClientFromURL(connectionURL string) (*Client, error)

NewClientFromURL creates a client from a URL like smtp://user:pass@host:port/?from=from@example.com

func (*Client) Send

func (c *Client) Send(m *Message) error

Send sends the given message

type Message

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

Message is email message

func NewMessage

func NewMessage(recipients []string, subject, text, html string) *Message

NewMessage creates a new message

type MockSender

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

MockSender is a mocked sender for testing that just logs would-be commands

func NewMockSender

func NewMockSender(errs ...error) *MockSender

NewMockSender creates a new mock sender

func (*MockSender) Logs

func (s *MockSender) Logs() []string

Logs returns the send logs

func (*MockSender) Send

func (s *MockSender) Send(c *Client, m *Message) error

type RetryConfig

type RetryConfig struct {
	Backoffs    []time.Duration
	ShouldRetry func(error) bool
}

RetryConfig configures if and how retrying of connections happens

func NewFixedRetries

func NewFixedRetries(backoffs ...time.Duration) *RetryConfig

NewFixedRetries creates a new retry config with the given backoffs

func (*RetryConfig) Backoff

func (r *RetryConfig) Backoff(n int) time.Duration

Backoff gets the backoff time for the nth retry

func (*RetryConfig) MaxRetries

func (r *RetryConfig) MaxRetries() int

MaxRetries gets the maximum number of retries allowed

type Sender

type Sender interface {
	Send(*Client, *Message) error
}

Sender is anything that can send an email

var DefaultSender Sender = defaultSender{}

DefaultSender is the default SMTP sender