resend

Documentation

Overview

Package resend is for sending emails via the resend api

Index

• Variables
• func New(apiKey string, options ...Option) (newman.EmailSender, error)
• type Option
  • func WithAPIKey(apiKey string) Option
  • func WithBaseURL(baseURL url.URL) Option
  • func WithClient(client *resend.Client) Option
  • func WithDevMode(path string) Option
  • func WithFilepath(filepath string) Option
  • func WithHeaders(headers map[string]string) Option
  • func WithUserAgent(userAgent string) Option

Variables

var (
	// ErrFailedToSendEmail is returned when an email fails to send
	ErrFailedToSendEmail = errors.New("failed to send email")
	// ErrMissingAPIKey is returned when an API key is missing
	ErrMissingAPIKey = errors.New("missing API key")
)

Functions

func New

func New(apiKey string, options ...Option) (newman.EmailSender, error)

New is a function that creates a new resend EmailSender instance.

Types

type Option

type Option func(*resendEmailSender)

Option is a type representing a function that modifies a ResendEmailSender

func WithAPIKey

func WithAPIKey(apiKey string) Option

WithAPIKey is an option that allows to set a custom API key for the Resend client

func WithBaseURL

func WithBaseURL(baseURL url.URL) Option

WithBaseURL is an option that allows to set a custom base URL for the Resend client

func WithClient

func WithClient(client *resend.Client) Option

WithClient is an option that allows to set a custom Resend client

func WithDevMode

func WithDevMode(path string) Option

func WithFilepath

func WithFilepath(filepath string) Option

WithFilePath is an option that allows to set a custom file path for the Resend client

func WithHeaders

func WithHeaders(headers map[string]string) Option

WithHeaders is an option that allows to set a custom headers for the Resend client

func WithUserAgent

func WithUserAgent(userAgent string) Option

WithUserAgent is an option that allows to set a custom user agent for the Resend client