sendgrid

package
v2.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 23, 2026 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// ErrNilConfig indicates a nil config was provided.
	ErrNilConfig = platformerrors.New("SendGrid config is nil")
	// ErrEmptyAPIToken indicates an empty API token was provided.
	ErrEmptyAPIToken = platformerrors.New("empty Sendgrid API token")
	// ErrNilHTTPClient indicates a nil HTTP client was provided.
	ErrNilHTTPClient = platformerrors.New("nil HTTP client")
)
View Source
var ErrSendgridAPIResponse = platformerrors.New("sendgrid request error")

ErrSendgridAPIResponse indicates an error occurred in SendGrid.

Functions

This section is empty.

Types

type Config

type Config struct {
	APIToken string `env:"API_TOKEN" json:"apiToken"`
}

Config configures SendGrid to send email.

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.

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, circuitBreaker circuitbreaking.CircuitBreaker) (*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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL