sendgrid

Documentation

Overview

Package sendgrid provides the implementation of an email sender using SendGrid.

Index

• func New(ctx context.Context, emailConfig email.Config, sgConfig Config) (email.Sender, error)
• type Config
• type SendGrid
  • func (s *SendGrid) Send(message *email.Message) error

Functions

func New

func New(ctx context.Context, emailConfig email.Config, sgConfig Config) (email.Sender, error)

New creates a SendGrid email provider.

Types

type Config

type Config struct {
	APIKey      string `name:"api-key" description:"The SendGrid API key to use"`
	SandboxMode bool   `name:"sandbox" description:"Use SendGrid sandbox mode for testing"`
}

Config for the SendGrid email provider.

type SendGrid

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

SendGrid is the type that implements SendGrid as email provider.

func (*SendGrid) Send

func (s *SendGrid) Send(message *email.Message) error

Send an email message.