notifier

package

v1.3.6 Latest Latest Go to latest Published: Jan 22, 2024 License: MIT Imports: 7 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

This section is empty.

This section is empty.

func SendEmail(recipient string, message string, subject string) error

SendEmail provides the implementation of the EmailSender type for runtime usage.

func SendEmailErrorMock(recipient string, message string, subject string) error

SendEmailErrorMock mocks an error response about no response from the server.

func SendEmailMock(recipient string, message string, subject string) error

SendEmailMock mocks the normal response of a successful send with no error.

func SendSms(smsNumber string, message string) error

SendSms provides the implementation of the SmsSender type for runtime usage.

func SendSmsErrorMock(smsNumber string, message string) error

SendSmsErrorMock mocks an error response about no response from the server.

func SendSmsMock(smsNumber string, message string) error

SendSmsMock mocks the normal response of a successful send with no error.

type EmailSender func(recipient string, message string, subject string) error

EmailSender defines a function to do the work to send an email.

type Notifier struct {
	Site      database.Site
	Message   string
	Subject   string
	SendEmail EmailSender
	SendSms   SmsSender
}

Notifier sends the notifications to the recipients on a status change.

func NewNotifier(site database.Site, message string, subject string,
	sendEmail EmailSender, sendSms SmsSender) *Notifier

NewNotifier returns a new Notifier object to perform notifications about status change

func (n *Notifier) Notify()

Notify starts the notification for each contact for the site.

type SmsSender func(smsNumber string, message string) error

SmsSender defines a function to do the work to send an SMS text message.