sendgrid

Documentation

Index

• Variables
• type Config
• type Emailer
  • func NewSendGridEmailer(cfg *Config, logger logging.Logger, tracerProvider tracing.TracerProvider, ...) (*Emailer, error)
  • func (e *Emailer) SendEmail(ctx context.Context, details *email.OutboundEmailMessage) error

Variables

var (

	// ErrNilConfig indicates an empty API token was provided.
	ErrNilConfig = errors.New("SendGrid config is nil")
	// ErrEmptyAPIToken indicates an empty API token was provided.
	ErrEmptyAPIToken = errors.New("empty API token")
	// ErrNilHTTPClient indicates a nil HTTP client was provided.
	ErrNilHTTPClient = errors.New("nil HTTP client")
)

var ErrSendgridAPIIssue = errors.New("making SendGrid request")

ErrSendgridAPIIssue indicates an error occurred in SendGrid.

Types

type Config

type Config struct {
	APIToken string `json:"apiToken" toml:"api_token,omitempty"`
}

Config configures SendGrid to send email.

type Emailer

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

Emailer uses SendGrid to send email.

func NewSendGridEmailer

func NewSendGridEmailer(cfg *Config, logger logging.Logger, tracerProvider tracing.TracerProvider, client *http.Client) (*Emailer, error)

NewSendGridEmailer returns a new SendGrid-backed Emailer.

func (*Emailer) SendEmail

func (e *Emailer) SendEmail(ctx context.Context, details *email.OutboundEmailMessage) error

SendEmail sends an email.