handler

Documentation

Overview

Package handler implements AWS Lambda event handling.

Index

• Constants
• type Event
  • func (event *Event) UnmarshalJSON(data []byte) error
• type EventType
  • func (i EventType) String() string
• type Handler
  • func NewHandler(emailDomain string, siteTitle string, agent agent.SubscriptionAgent, ...) (*Handler, error)
  • func (h *Handler) HandleEvent(ctx context.Context, event *Event) (result any, err error)
• type Options
  • func GetOptions(getenv func(string) string) (*Options, error)
• type ParseError
  • func (e *ParseError) Error() string
• type RedirectMap
• type RedirectPaths
• type UndefinedEnvVarsError
  • func (e *UndefinedEnvVarsError) Error() string

Constants

const (
	Undefined eventOperationType = iota
	Subscribe
	Verify
	Unsubscribe
)

const ErrUserInput = types.SentinelError("invalid user input")

Inspired by the example from the "Customizing error tests with Is and As methods" section of https://go.dev/blog/go1.13-errors.

const ResponseTemplate = `` /* 259-byte string literal not displayed */

Types

type Event

type Event struct {
	Type             EventType
	ApiRequest       *awsevents.APIGatewayProxyRequest
	MailtoEvent      *awsevents.SimpleEmailEvent
	SnsEvent         *awsevents.SNSEvent
	CommandLineEvent *events.CommandLineEvent
	Unknown          []byte
}

func (*Event) UnmarshalJSON

func (event *Event) UnmarshalJSON(data []byte) error

Inspired by: - https://www.synvert-tcm.com/blog/handling-multiple-aws-lambda-event-types-with-go/ See also: - https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda-event.html

type EventType

type EventType int

const (
	UnknownEvent EventType = iota
	ApiRequest
	MailtoEvent
	SnsEvent
	CommandLineEvent
)

func (EventType) String

func (i EventType) String() string

type Handler

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

func NewHandler

func NewHandler(
	emailDomain string,
	siteTitle string,
	agent agent.SubscriptionAgent,
	paths RedirectPaths,
	responseTemplate string,
	unsubscribeUserName string,
	bouncer email.Bouncer,
	logger *log.Logger,
) (*Handler, error)

func (*Handler) HandleEvent

func (h *Handler) HandleEvent(
	ctx context.Context, event *Event,
) (result any, err error)

type Options

type Options struct {
	ApiDomainName        string
	ApiMappingKey        string
	EmailDomainName      string
	EmailSiteTitle       string
	SenderName           string
	SenderUserName       string
	UnsubscribeUserName  string
	UnsubscribeFormPath  string
	SubscribersTableName string
	ConfigurationSet     string
	MaxBulkSendCapacity  types.Capacity

	RedirectPaths RedirectPaths
}

func GetOptions

func GetOptions(getenv func(string) string) (*Options, error)

type ParseError

type ParseError struct {
	Type    eventOperationType
	Message string
}

func (*ParseError) Error

func (e *ParseError) Error() string

type RedirectMap

type RedirectMap map[ops.OperationResult]string

type RedirectPaths

type RedirectPaths struct {
	Invalid           string
	AlreadySubscribed string
	VerifyLinkSent    string
	Subscribed        string
	NotSubscribed     string
	Unsubscribed      string
}

type UndefinedEnvVarsError

type UndefinedEnvVarsError struct {
	UndefinedVars []string
}

func (*UndefinedEnvVarsError) Error

func (e *UndefinedEnvVarsError) Error() string