notify

Documentation

Index

• Variables
• func Send(publicKey, privateKey, sender string, recipients []string, subject, msg string) error
• type HTMLEmailer
• type Kind
• type Lookup
• type MailjetNotifier
  • func NewMailjetNotifier(options ...Option) (*MailjetNotifier, error)
  • func (n *MailjetNotifier) Recipients(skey int64, kind Kind) ([]string, time.Duration, error)
  • func (n *MailjetNotifier) Send(ctx context.Context, skey int64, kind Kind, msg string) error
  • func (n *MailjetNotifier) SendHTMLEmail(ctx context.Context, subject string, templatePath string, data interface{}) error
• type Notifier
• type Option
  • func WithFilter(filter string) Option
  • func WithPeriod(period time.Duration) Option
  • func WithRecipient(recipient string) Option
  • func WithRecipientLookup(lookup Lookup) Option
  • func WithRecipients(recipients []string) Option
  • func WithSecrets(secrets map[string]string) Option
  • func WithSender(sender string) Option
  • func WithStore(store TimeStore) Option
• type TimeStore
  • func NewStore(store datastore.Store) TimeStore

Variables

var ErrNoRecipient = errors.New("no recipient")

Errors.

Functions

func Send

func Send(publicKey, privateKey, sender string, recipients []string, subject, msg string) error

Send sends an email message using the Mailjet API.

Types

type HTMLEmailer

type HTMLEmailer interface {
	// SendHTMLEmail sends a formatted HTML email.
	SendHTMLEmail(ctx context.Context, subject string, templatePath string) error
}

HTMLEmailer is an interface for types which are able to send formatted emails using HTML.

type Kind

type Kind string

Kind represents a kind of notification.

type Lookup

type Lookup func(int64, Kind) ([]string, time.Duration, error)

Lookup is a function that returns the recipients and their corresponding notification period for a given site and notification kind. It is used with WithRecipientLookup.

type MailjetNotifier

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

Notifier represents a notifier that uses the Mailjet API to send email.

func NewMailjetNotifier

func NewMailjetNotifier(options ...Option) (*MailjetNotifier, error)

NewMailjetNotifier initializes a MailjetNotifier with the supplied options. See WithSender, WithRecipient, WithFilter, WithStore and WithSecrets for a description of the various options. Secrets are required to send actual emails using the Mailjet API, but can be omitted during testing.

func (*MailjetNotifier) Recipients

func (n *MailjetNotifier) Recipients(skey int64, kind Kind) ([]string, time.Duration, error)

Recipients returns a list of recipients and their corresponding minimum notification period for the given site and notification kind. It uses the WithRecipientLookup function if supplied, else defaults to the recipients supplied by either WithRecipient or WithRecipients and the period supplied by WithPeriod. ErrNoRecipient is returned if there are no recipients.

func (*MailjetNotifier) Send

func (n *MailjetNotifier) Send(ctx context.Context, skey int64, kind Kind, msg string) error

Send sends an email message, depending on what options are present. With filters, then all filters must match in order to send. With persistence, then the message is sent only if it was not sent to the same recipient recently.

func (*MailjetNotifier) SendHTMLEmail

func (n *MailjetNotifier) SendHTMLEmail(ctx context.Context, subject string, templatePath string, data interface{}) error

SendHTMLEmail sends a formatted HTML email using the MailJet API.

type Notifier

type Notifier interface {
	Send(context.Context, int64, Kind, string) error
	Recipients(int64, Kind) ([]string, time.Duration, error)
}

type Option

type Option func(*MailjetNotifier) error

Option is a functional option supplied to Init.

func WithFilter

func WithFilter(filter string) Option

WithFilter applies a filter string. If multiple WithFilter options are applied, they form a compound conjunctive filter. Specifiying an empty filter string clears the filter.

func WithPeriod

func WithPeriod(period time.Duration) Option

WithPeriod sets the minimum notification period, which is used in conjunction with a TimeStore.

func WithRecipient

func WithRecipient(recipient string) Option

WithRecipient sets a single recipient email address.

func WithRecipientLookup

func WithRecipientLookup(lookup Lookup) Option

WithRecipientLookup sets a function to look up multiple recipients and their corresponding notification period given a site key and a notification kind.

func WithRecipients

func WithRecipients(recipients []string) Option

WithRecipients sets multiple recipient email addresses.

func WithSecrets

func WithSecrets(secrets map[string]string) Option

WithSecrets applies the secrets necessary for sending email, notably the public and private mail API keys. This is always required, unless testing.

func WithSender

func WithSender(sender string) Option

WithSender sets the sender email address.

func WithStore

func WithStore(store TimeStore) Option

WithStore applies a TimeStore for notification persistence. Combine with WithPeriod to enforce a minimum notification period. See also TimeStore.

type TimeStore

type TimeStore interface {
	Sendable(context.Context, int64, time.Duration, string) (bool, error) // Returns true if a message is sendable.
	Sent(context.Context, int64, string) error                            // Records the time a message was sent.
}

TimeStore is an interface for notification persistence.

func NewStore

func NewStore(store datastore.Store) TimeStore

NewStore returns a TimeStore that uses a datastore for notification persistence.