notify

package

v0.2.2 Latest Latest Go to latest Published: Jun 27, 2023 License: GPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

This section is empty.

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

Email holds all email data

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

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

func (e *Email) Send() error

Send sends the email notification

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

EmailConfig holds all email configuration data

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

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

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

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