email_sent.go

package events

import (
	"github.com/nyaruka/goflow/flows"
)

func init() {
	registerType(TypeEmailSent, func() flows.Event { return &EmailSentEvent{} })
}

// TypeEmailSent is our type for the email event
const TypeEmailSent string = "email_sent"

// EmailSentEvent events are created when an action has sent an email.
//
//   {
//     "type": "email_sent",
//     "created_on": "2006-01-02T15:04:05Z",
//     "to": ["foo@bar.com"],
//     "subject": "Your activation token",
//     "body": "Your activation token is AAFFKKEE"
//   }
//
// @event email_sent
type EmailSentEvent struct {
	baseEvent

	To      []string `json:"to" validate:"required,min=1"`
	Subject string   `json:"subject" validate:"required"`
	Body    string   `json:"body"`
}

// NewEmailSent returns a new email event with the passed in subject, body and emails
func NewEmailSent(to []string, subject string, body string) *EmailSentEvent {
	return &EmailSentEvent{
		baseEvent: newBaseEvent(TypeEmailSent),
		To:        to,
		Subject:   subject,
		Body:      body,
	}
}