sms

Documentation

Index

• type Sender
  • func NewSender(config SenderConfig) Sender
• type SenderConfig
  • func NewEnvConfig() (SenderConfig, error)

Types

type Sender

type Sender interface {
	// Send - To send a new SMS.
	Send(phoneNumber, message string) error
}

Sender - Implementations of this will be used to send SMSes. (If required)

func NewSender

func NewSender(config SenderConfig) Sender

NewSender - Gets a new SMS sender.

type SenderConfig

type SenderConfig interface {
	// Phone number used for sending.
	PhoneNumber() string

	// Used to identity account.
	AccountID() string

	// Used to authenticate account.
	AuthToken() string
}

SenderConfig - To configure sms sender.

func NewEnvConfig

func NewEnvConfig() (SenderConfig, error)

NewEnvConfig - Provides a new config from environment variables for sms sender.