emailsender

Documentation

Overview

emailsender package provides email senders.

Index

• Variables
• type BatchSender
  • func StartBatchSender(options BatchSenderOptions) (sender *BatchSender, err error)
  • func (self *BatchSender) Close() error
  • func (self *BatchSender) Send(email Email) error
• type BatchSenderOptions
• type DirectSender
  • func (self *DirectSender) Close() error
  • func (self *DirectSender) Quit() error
  • func (self *DirectSender) Send(email Email) (err error)
• type Email
• type Sender

Variables

var (
	WrongEmailValue = errors.New("Wrong email value (missing recipient or nil template)")
)

Types

type BatchSender

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

BatchSender is a sender that stores emails in a queue to send them asynchronously in batch. Emails from the queue are sent while the connections is opened. The connection is opened once the number of waiting emails reach a threshold or when an email is in the queue for at least a given duration. The connection is closed as soon as there is no waiting email in the queue.

func StartBatchSender

func StartBatchSender(options BatchSenderOptions) (sender *BatchSender, err error)

StartBatchSender creates, starts and returns a new BatchSender.

func (*BatchSender) Close

func (self *BatchSender) Close() error

Close asks the sender to send all the emails in the queue and then to stop the background goroutine.

func (*BatchSender) Send

func (self *BatchSender) Send(email Email) error

Send adds an email to the queue.

type BatchSenderOptions

type BatchSenderOptions struct {
	MinBatchLen int
	MaxDelay    string // string representation of a duration
	Sender      string // email address
	SMTP        string // host:port
}

BatchSenderOptions records the options for the batch sender. A email is sent by the batch sender either if there are at least (MinBatchLen - 1) other emails waiting for being sent, or if the email has beeen asked to be sent at least MaxDelay ago.

type DirectSender

type DirectSender struct {
	Sender string // email address
	SMTP   string // host:port
	// contains filtered or unexported fields
}

DirectSender is a sender that directly sends emails to an SMTP server. The connection to the server is left open for multiple emails to be send in one session.

func (*DirectSender) Close

func (self *DirectSender) Close() error

func (*DirectSender) Quit

func (self *DirectSender) Quit() error

Quit closes the currently opened connection, if any. It should be called as soon as there is no email to send.

func (*DirectSender) Send

func (self *DirectSender) Send(email Email) (err error)

Send sends an email to the SMTP server. It opens a new connection if needed, otherwise it uses the previously opened connection.

type Email

type Email struct {
	To   []string
	Tmpl *template.Template
	Data interface{}
}

type Sender

type Sender interface {

	// Send asks the sender to send an email. The email may be kept in memory and sent later.
	// Hence nil return value does not mean the email has been sent.
	Send(email Email) error

	// Close closes the sender. This may result in retained email to be sent.
	Close() error
}