email

package
v0.0.76 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package email provides the email utilities for minder

Index

Constants

View Source
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/"
	// BodyMaxLength is the maximum length of the email body
	BodyMaxLength = 10000
	// MaxFieldLength is the maximum length of a string field
	MaxFieldLength = 200
)

Variables

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

ErrValidationFailed is returned when the template data source fails validation

Functions

func NewErrValidationFailed added in v0.0.73

func NewErrValidationFailed(fieldName, fieldValue string) error

NewErrValidationFailed creates a new error for failed validation

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

Directories

Path Synopsis
Package awsses provides the email utilities for minder
Package awsses provides the email utilities for minder
Package noop provides a noop email utilities for minder
Package noop provides a noop email utilities for minder

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL