email

Documentation

Overview

Package email provides the email utilities for minder

Index

• Constants
• func NewMessage(ctx context.Context, ...) (*message.Message, error)
• type MailEventPayload

Constants

const (
	// TopicQueueInviteEmail is the topic for sending invite emails
	TopicQueueInviteEmail = "invite.email.event"
	// 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/"
)

Functions

func NewMessage

func NewMessage(
	ctx context.Context,
	inviteeEmail, inviteURL, minderURLBase, role, 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