notify

Documentation

Overview

Package notify holds all different types of ways to notify users about various events.

Index

• type Email
  • func (e *Email) Prepare(booking managerv1.Booking) Notifier
  • func (e *Email) Send() error
• type EmailConfig
• type Notifier
  • func NewNotifier(notification managerv1.Notification) (Notifier, error)

Types

type Email

type Email struct {
	Recipient, Subject, HTMLBody, TextBody, Sender string
	Config                                         EmailConfig
}

Email holds all email data

func (*Email) Prepare

func (e *Email) Prepare(booking managerv1.Booking) Notifier

Prepare prepares the email notification, by using the passed booking, to set the Email fields

func (*Email) Send

func (e *Email) Send() error

Send sends the email notification

type EmailConfig

type EmailConfig struct {
	Host     string
	Port     string
	Username string
	Password string
}

EmailConfig holds all email configuration data

type Notifier

type Notifier interface {
	Prepare(booking managerv1.Booking) Notifier
	Send() error
}

Notifier is an interface that each type of notifier must implement.

func NewNotifier

func NewNotifier(notification managerv1.Notification) (Notifier, error)

NewNotifier returns a new Notifier based on the type of notification.