var (ErrValidationNoFromAddress =xerrors.New("'from' address not defined")ErrValidationNoToAddress   =xerrors.New("'to' address(es) not defined")ErrValidationNoSmarthost   =xerrors.New("'smarthost' address not defined")ErrValidationNoHello       =xerrors.New("'hello' not defined"))

typeDeliveryFunc¶

type DeliveryFunc func(ctxcontext.Context, msgIDuuid.UUID) (retryablebool, errerror)

DeliveryFunc delivers the notification.The first return param indicates whether a retry can be attempted (i.e. a temporary error), and the second returnsany error that may have arisen.If (false, nil) is returned, that is considered a successful dispatch.

typeInboxHandler¶added inv2.21.0

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

InboxHandler is responsible for dispatching notification messages to the Coder Inbox.

func NewInboxHandler(logslog.Logger, storeInboxStore, pspubsub.Pubsub) *InboxHandler

func (s *InboxHandler) Dispatcher(payloadtypes.MessagePayload, titleTmpl, bodyTmplstring, _template.FuncMap) (DeliveryFunc,error)

typeInboxStore¶added inv2.21.0

type InboxStore interface {InsertInboxNotification(ctxcontext.Context, argdatabase.InsertInboxNotificationParams) (database.InboxNotification,error)}

typeSMTPHandler¶

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

SMTPHandler is responsible for dispatching notification messages via SMTP.NOTE: auth and TLS is currently *not* enabled in this initial thin slice.TODO: implement DKIM/SPF/DMARC?https://github.com/emersion/go-msgauth

func NewSMTPHandler(cfgcodersdk.NotificationsEmailConfig, logslog.Logger) *SMTPHandler

func (s *SMTPHandler) Dispatcher(payloadtypes.MessagePayload, titleTmpl, bodyTmplstring, helperstemplate.FuncMap) (DeliveryFunc,error)

typeWebhookHandler¶

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

WebhookHandler dispatches notification messages via an HTTP POST webhook.

func NewWebhookHandler(cfgcodersdk.NotificationsWebhookConfig, logslog.Logger) *WebhookHandler

func (w *WebhookHandler) Dispatcher(payloadtypes.MessagePayload, titleMarkdown, bodyMarkdownstring, _template.FuncMap) (DeliveryFunc,error)

typeWebhookPayload¶

type WebhookPayload struct {Versionstring               `json:"_version"`MsgIDuuid.UUID            `json:"msg_id"`Payloadtypes.MessagePayload `json:"payload"`Titlestring               `json:"title"`TitleMarkdownstring               `json:"title_markdown"`Bodystring               `json:"body"`BodyMarkdownstring               `json:"body_markdown"`}

WebhookPayload describes the JSON payload to be delivered to the configured webhook endpoint.