email

Documentation

Index

• Constants
• Variables
• type EmailConfig
• type Recipient
• type SendEmail
• type SendEmailContext
• type SendMessageError
• type SendMessageSuccess
• type SenderSettings
• type SmtpSender
  • func (t *SmtpSender) GetInfo() module.ComponentInfo
  • func (t *SmtpSender) Handle(ctx context.Context, responseHandler module.Handler, port string, ...) error
  • func (t *SmtpSender) Instance() module.Component
  • func (t *SmtpSender) Ports() []module.NodePort
• type SmtpServerSettings

Constants

const (
	SendEmailComponent = "send_email"
	PortSuccess        = "success"
	PortSettings       = "settings"
	PortError          = "error"
	PortIn             = "in"
)

Variables

var SenderDefaultSettings = SenderSettings{}

Types

type EmailConfig

type EmailConfig struct {
	ContentType string      `` /* 126-byte string literal not displayed */
	From        string      `json:"from" title:"From" propertyOrder:"3"`
	To          []Recipient `` /* 129-byte string literal not displayed */

	Body         string             `json:"body" title:"Email body" format:"textarea" propertyOrder:"5"`
	Subject      string             `json:"subject" title:"Subject" propertyOrder:"6"`
	SmtpSettings SmtpServerSettings `json:"smtpSettings" required:"true" title:"SMTP Settings" propertyOrder:"7"`
}

type Recipient

type Recipient struct {
	Name  string `json:"name" title:"Name" colSpan:"col-span-6"`
	Email string `json:"email" required:"true" title:"Email settings" format:"email" minLength:"1" colSpan:"col-span-6"`
}

type SendEmail

type SendEmail struct {
	Context SendEmailContext `json:"context" configurable:"true" title:"Context" propertyOrder:"1"`
	Email   EmailConfig      `json:"email" required:"true" title:"Email"`
}

type SendEmailContext

type SendEmailContext any

type SendMessageError

type SendMessageError struct {
	Context   SendEmailContext `json:"context"`
	Error     string           `json:"error"`
	Email     EmailConfig      `json:"sent"`
	MessageID string           `json:"messageID"`
}

type SendMessageSuccess

type SendMessageSuccess struct {
	Context   SendEmailContext `json:"context"`
	MessageID string           `json:"messageID"`
	Email     EmailConfig      `json:"sent"`
}

type SenderSettings

type SenderSettings struct {
	EnableErrorPort   bool `` /* 150-byte string literal not displayed */
	EnableSuccessPort bool `json:"enableSuccessPort" required:"true" title:"Enable Success port"`
}

type SmtpSender

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

func (*SmtpSender) GetInfo

func (t *SmtpSender) GetInfo() module.ComponentInfo

func (*SmtpSender) Handle

func (t *SmtpSender) Handle(ctx context.Context, responseHandler module.Handler, port string, msg interface{}) error

func (*SmtpSender) Instance

func (t *SmtpSender) Instance() module.Component

func (*SmtpSender) Ports

func (t *SmtpSender) Ports() []module.NodePort

type SmtpServerSettings

type SmtpServerSettings struct {
	Host     string `json:"host" required:"true" minLength:"1" title:"SMTP Host" propertyOrder:"1"`
	Port     int    `json:"port" required:"true" title:"SMTP Port" propertyOrder:"2"`
	Username string `json:"username" title:"SMTP username" required:"true" propertyOrder:"3"`
	Password string `json:"password" title:"SMTP password" required:"true" propertyOrder:"4"`
	Test     bool   `json:"test" format:"button" title:"Test connection" required:"true" propertyOrder:"5"`
}