queue

Documentation

Index

• type Config
• type DKIMConfig
• type Host
  • func NewHost(host string, s *Storage, c *Config) *Host
  • func (h *Host) Deliver(m *Message)
  • func (h *Host) Idle() time.Duration
  • func (h *Host) Status() *HostStatus
  • func (h *Host) Stop()
• type HostStatus
• type MailServerFinder
• type Message
• type ProcessFailFunc
• type ProcessFunc
• type Queue
  • func NewQueue(c *Config) (*Queue, error)
  • func (q *Queue) Deliver(m *Message)
  • func (q *Queue) Status() *QueueStatus
  • func (q *Queue) Stop()
• type QueueStatus
• type SMTPError
  • func (e *SMTPError) Error() string
  • func (e *SMTPError) IsPermanent() bool
  • func (e *SMTPError) IsTemporary() bool
  • func (e *SMTPError) Unwrap() error
• type Storage
  • func NewStorage(directory string) *Storage
  • func (s *Storage) DeleteMessage(m *Message) error
  • func (s *Storage) GetMessageBody(m *Message) (io.ReadCloser, error)
  • func (s *Storage) LoadMessages() ([]*Message, error)
  • func (s *Storage) NewBody() (io.WriteCloser, string, error)
  • func (s *Storage) SaveMessage(m *Message, body string) error

Types

type Config

type Config struct {
	// TODO: support json marshal for duration
	Hostname               string        `json:"hostname"`
	Directory              string        `json:"directory"`
	DisableSSLVerification bool          `json:"disable-ssl-verification"`
	InitialInterval        time.Duration `json:"-"`
	RandomizationFactor    float64       `json:"randomization_factor"`
	Multiplier             float64       `json:"multiplier"`
	MaxInterval            time.Duration `json:"-"`
	MaxAttempts            int           `json:"max_attempts"`
	Jitter                 bool          `json:"jitter"`

	// Map domain names to DKIM config for that domain
	DKIMConfigs map[string]DKIMConfig `json:"dkim-configs"`
	// ProcessFunc allow you to define custom process function for message.
	ProcessFunc ProcessFunc `json:"-"`
	// ProcessFailFunc allow you to define processor if message failed with 5xx status.
	ProcessFailFunc ProcessFailFunc `json:"-"`
}

Application configuration.

type DKIMConfig

type DKIMConfig struct {
	PrivateKey       string `json:"private-key"`
	Selector         string `json:"selector"`
	Canonicalization string `json:"canonicalization"`
}

See https://github.com/Freeaqingme/dkim

type Host

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

Persistent connection to an SMTP host.

func NewHost

func NewHost(host string, s *Storage, c *Config) *Host

NewHost creates a new host connection.

func (*Host) Deliver

func (h *Host) Deliver(m *Message)

Attempt to deliver a message to the host.

func (*Host) Idle

func (h *Host) Idle() time.Duration

Retrieve the connection idle time.

func (*Host) Status

func (h *Host) Status() *HostStatus

Return the status of the host connection.

func (*Host) Stop

func (h *Host) Stop()

Close the connection to the host.

type HostStatus

type HostStatus struct {
	Active bool `json:"active"`
	Length int  `json:"length"`
}

Host status information.

type MailServerFinder

type MailServerFinder interface {
	// Attempt to find the mail servers for the specified host. MX records are
	// checked first. If one or more were found, the records are converted into an
	// array of strings (sorted by priority). If none were found, the original host
	// is returned.
	FindServers(host string) ([]string, error)
}

type Message

type Message struct {
	Host    string   `json:"host"`
	From    string   `json:"from"`
	To      []string `json:"to"`
	Attempt int      `json:"attempt"`
	// Metadata can store any data useful for custom processors.
	Metadata map[string]string `json:"metadata"`
	// contains filtered or unexported fields
}

Message metadata.

type ProcessFailFunc

type ProcessFailFunc func(m *Message, s *Storage, err error) error

type ProcessFunc

type ProcessFunc func(m *Message, s *Storage) error

type Queue

type Queue struct {
	Storage *Storage
	// contains filtered or unexported fields
}

Mail queue managing the sending of messages to hosts.

func NewQueue

func NewQueue(c *Config) (*Queue, error)

Create a new message queue. Any undelivered messages on disk will be added to the appropriate queue.

func (*Queue) Deliver

func (q *Queue) Deliver(m *Message)

Deliver the specified message to the appropriate host queue.

func (*Queue) Status

func (q *Queue) Status() *QueueStatus

Provide the status of each host queue.

func (*Queue) Stop

func (q *Queue) Stop()

Stop all active host queues.

type QueueStatus

type QueueStatus struct {
	Uptime int                    `json:"uptime"`
	Hosts  map[string]*HostStatus `json:"hosts"`
}

QueueStatus status information.

type SMTPError

type SMTPError struct {
	Err error
}

func (*SMTPError) Error

func (e *SMTPError) Error() string

func (*SMTPError) IsPermanent

func (e *SMTPError) IsPermanent() bool

func (*SMTPError) IsTemporary

func (e *SMTPError) IsTemporary() bool

func (*SMTPError) Unwrap

func (e *SMTPError) Unwrap() error

type Storage

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

Manager for message metadata and body on disk. All methods are safe to call from multiple goroutines.

func NewStorage

func NewStorage(directory string) *Storage

Create a Storage instance for the specified directory.

func (*Storage) DeleteMessage

func (s *Storage) DeleteMessage(m *Message) error

Delete the specified message. The message body is also deleted if no more messages exist.

func (*Storage) GetMessageBody

func (s *Storage) GetMessageBody(m *Message) (io.ReadCloser, error)

Retreive a reader for the message body.

func (*Storage) LoadMessages

func (s *Storage) LoadMessages() ([]*Message, error)

Load messages from the storage directory. Any messages that could not be loaded are ignored.

func (*Storage) NewBody

func (s *Storage) NewBody() (io.WriteCloser, string, error)

Create a new message body. The writer must be closed after writing the message body.

func (*Storage) SaveMessage

func (s *Storage) SaveMessage(m *Message, body string) error

Save the specified message to disk.