email

Documentation

Overview

Package email provides the email utilities for minder

Index

• Constants
• Variables
• func NewErrValidationFailed(fieldName, fieldValue string, err error) error
• func NewMessage(ctx context.Context, ...) (*message.Message, error)
• type MailEventPayload

Constants

const (
	// TopicQueueInviteEmail is the topic for sending invite emails
	TopicQueueInviteEmail = "invite.email.event"
	// BodyMaxLength is the maximum length of the email body
	BodyMaxLength = 10000
	// MaxFieldLength is the maximum length of a string field
	MaxFieldLength = 200

	// DefaultMinderTermsURL is the default terms URL for minder
	DefaultMinderTermsURL = "https://stacklok.com/stacklok-terms-of-service"
	// DefaultMinderPrivacyURL is the default privacy URL for minder
	DefaultMinderPrivacyURL = "https://stacklok.com/privacy-policy/"
)

Variables

var ErrValidationFailed = errors.New("validation failed")

ErrValidationFailed is returned when the template data source fails validation

Functions

func NewErrValidationFailed

func NewErrValidationFailed(fieldName, fieldValue string, err error) error

NewErrValidationFailed creates a new error for failed validation

func NewMessage

func NewMessage(
	ctx context.Context,
	inviteeEmail, inviteCode, inviteURL, minderURLBase, role string,
	projectId uuid.UUID, projectDisplay, sponsorDisplay string,
) (*message.Message, error)

NewMessage creates a new message for sending an invitation email

Types

type MailEventPayload

type MailEventPayload struct {
	Address  string `json:"email"`
	Subject  string `json:"subject"`
	BodyHTML string `json:"body_html"`
	BodyText string `json:"body_text"`
}

MailEventPayload is the event payload for sending an invitation email