email

Documentation

Index

• Constants
• Variables
• 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.Port
• type SmtpServerSettings

Constants

const (
	SendEmailComponent = "send_email"
	PortResponse       = "response"
	PortError          = "error"
	PortRequest        = "request"
)

Variables

var SenderDefaultSettings = SenderSettings{}

Types

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"`
	SmtpSettings SmtpServerSettings `json:"smtpSettings" required:"true" title:"SMTP Settings"`

	ContentType string `json:"contentType" required:"true" title:"Content type" enum:"text/plain,text/html,application/octet-stream"`

	From string      `json:"from" title:"From"`
	To   []Recipient `json:"to,omitempty" required:"true" description:"List of recipients" title:"To" uniqueItems:"true" minItems:"1"`

	Subject string `json:"subject" title:"Subject"`
	Body    string `json:"body" title:"Email body" format:"textarea"`
}

type SendEmailContext

type SendEmailContext any

type SendMessageError

type SendMessageError struct {
	Request   SendEmail `json:"request"`
	Error     string    `json:"error"`
	MessageID string    `json:"messageID"`
}

type SendMessageSuccess

type SendMessageSuccess struct {
	Request   SendEmail `json:"request"`
	MessageID string    `json:"messageID"`
}

type SenderSettings

type SenderSettings struct {
	EnableErrorPort    bool `` /* 150-byte string literal not displayed */
	EnableResponsePort bool `json:"enableResponsePort" required:"true" title:"Enable Response 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.Port

type SmtpServerSettings

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