resend

Documentation

Index

• Constants
• Variables
• func HandleWebhook(res http.ResponseWriter, req *http.Request)
• func SendTemplatedEmail(ctx context.Context, to string, templateID string, ...) error
• func WithTemplateVariable(key string, value any) templateEmailOption
• type Attachment
• type Config
• type EmailRecieved
• type ReceivedEmail
  • func (e *ReceivedEmail) GetBody() string
  • func (e *ReceivedEmail) GetFrom() *mail.Address
  • func (e *ReceivedEmail) GetID() string
  • func (e *ReceivedEmail) GetSubject() string
  • func (e *ReceivedEmail) Timestamp() time.Time
  • func (e *ReceivedEmail) Valid() error
• type WebhookEmailReceieved

Constants

const (
	// ConfigEnvPrefix is the prefix applied to environment variables for configuring Resend.
	ConfigEnvPrefix = config.ConfigEnvPrefix + "RESEND_"
)

Variables

var ErrInvalidEmail = errors.New("email is invalid")

Functions

func HandleWebhook

func HandleWebhook(res http.ResponseWriter, req *http.Request)

HandleWebhook will handle incoming webhook requests from Resend.

func SendTemplatedEmail

func SendTemplatedEmail(ctx context.Context, to string, templateID string, options ...templateEmailOption) error

SendTemplateEmail sends the template with the given id to the given address, with any additional template options applied.

func WithTemplateVariable

func WithTemplateVariable(key string, value any) templateEmailOption

Types

type Attachment

type Attachment struct {
	Id                 string `json:"id,omitempty"`
	Filename           string `json:"filename,omitempty"`
	ContentType        string `json:"content_type,omitempty"`
	ContentDisposition string `json:"content_disposition,omitempty"`
	ContentId          string `json:"content_id,omitempty"`
}

type Config

type Config struct {
	WebHookSecret string `koanf:"webhooksecret" validate:"required"`
	APIKey        string `koanf:"apikey"        validate:"required"`
}

Config structure.

type EmailRecieved

type EmailRecieved struct {
	EmailId     string       `json:"email_id,omitempty"`
	CreatedAt   string       `json:"created_at,omitempty"`
	From        string       `json:"from,omitempty"`
	To          []string     `json:"to,omitempty"`
	Bcc         []string     `json:"bcc,omitempty"`
	Cc          []string     `json:"cc,omitempty"`
	MessageId   string       `json:"message_id,omitempty"`
	Subject     string       `json:"subject,omitempty"`
	Attachments []Attachment `json:"attachments,omitempty"`
}

type ReceivedEmail

type ReceivedEmail struct {
	*resend.ReceivedEmail
}

func (*ReceivedEmail) GetBody

func (e *ReceivedEmail) GetBody() string

func (*ReceivedEmail) GetFrom

func (e *ReceivedEmail) GetFrom() *mail.Address

func (*ReceivedEmail) GetID

func (e *ReceivedEmail) GetID() string

func (*ReceivedEmail) GetSubject

func (e *ReceivedEmail) GetSubject() string

func (*ReceivedEmail) Timestamp

func (e *ReceivedEmail) Timestamp() time.Time

func (*ReceivedEmail) Valid

func (e *ReceivedEmail) Valid() error

Valid returns a non-nil error when the ReceivedEmail contains invalid fields.

type WebhookEmailReceieved

type WebhookEmailReceieved struct {
	Type      string        `json:"type,omitempty"`
	CreatedAt string        `json:"created_at,omitempty"`
	Data      EmailRecieved `json:"data,omitempty"`
}