sms

Documentation

Overview

Package sms provides types and methods to work with SMS delivery.

Index

• Variables
• type SMS
  • func New(l logger.Logger) *SMS
  • func (s *SMS) SendNewSMS()
  • func (s *SMS) SendSMS() error

Variables

var (
	ErrRunningCurl = errors.New("sms: error running curl command")
)

Types

type SMS

type SMS struct {
	UseHTTPS   bool     // Use secure http
	Content    string   // SMS content
	Host       string   // SMS server hostname or ip
	Port       string   // SMS server port number
	Sender     string   // SMS sender
	Recipients []string // List of sms recipients
	Logger     logger.Logger
}

SMS contains properties required for sending SMS to an SMS gateway.

func New

func New(l logger.Logger) *SMS

func (*SMS) SendNewSMS

func (s *SMS) SendNewSMS()

SendNewSMS sends sms text message via the configured SMS gateway.

func (*SMS) SendSMS

func (s *SMS) SendSMS() error

SendSMS sends sms text message via the configured SMS gateway.