sendgrid

Documentation

Index

• type BodyType
• type SendGrid
  • func New(apiKey, senderAddress, senderName string) *SendGrid
  • func (s *SendGrid) AddReceivers(addresses ...string)
  • func (s *SendGrid) BodyFormat(format BodyType)
  • func (s SendGrid) Send(ctx context.Context, subject, message string) error

Types

type BodyType

type BodyType int

BodyType is used to specify the format of the body.

const (
	// PlainText is used to specify that the body is plain text.
	PlainText BodyType = iota
	// HTML is used to specify that the body is HTML.
	HTML
)

type SendGrid

type SendGrid struct {
	// contains filtered or unexported fields
}

SendGrid struct holds necessary data to communicate with the SendGrid API.

func New

func New(apiKey, senderAddress, senderName string) *SendGrid

New returns a new instance of a SendGrid notification service. You will need a SendGrid API key. See https://sendgrid.com/docs/for-developers/sending-email/api-getting-started/

func (*SendGrid) AddReceivers

func (s *SendGrid) AddReceivers(addresses ...string)

AddReceivers takes email addresses and adds them to the internal address list. The Send method will send a given message to all those addresses.

func (*SendGrid) BodyFormat

func (s *SendGrid) BodyFormat(format BodyType)

BodyFormat can be used to specify the format of the body. Default BodyType is HTML.

func (SendGrid) Send

func (s SendGrid) Send(ctx context.Context, subject, message string) error

Send takes a message subject and a message body and sends them to all previously set chats. Message body supports html as markup language.