messenger

Documentation

Index

• Constants
• type Attachment
• type Message
• type Messenger
  • func NewAWSSES(cfg []byte, l *onelog.Logger) (Messenger, error)
  • func NewPinpoint(cfg []byte, l *onelog.Logger) (Messenger, error)
  • func NewTwilio(cfg []byte, l *onelog.Logger) (Messenger, error)

Constants

const (
	ContentTypeHTML  = "html"
	ContentTypePlain = "plain"
)

Types

type Attachment

type Attachment struct {
	Name    string
	Header  textproto.MIMEHeader
	Content []byte
}

Attachment represents a file or blob attachment that can be sent along with a message by a Messenger.

type Message

type Message struct {
	From        string
	To          []string
	Subject     string
	ContentType string
	Body        []byte
	AltBody     []byte
	Headers     textproto.MIMEHeader
	Attachments []Attachment

	Subscriber models.Subscriber

	// Campaign is generally the same instance for a large number of subscribers.
	Campaign *models.Campaign
}

Message is the message pushed to a Messenger.

type Messenger

type Messenger interface {
	Name() string
	Push(Message) error
	Flush() error
	Close() error
}

func NewAWSSES

func NewAWSSES(cfg []byte, l *onelog.Logger) (Messenger, error)

NewAWSSES creates new instance of pinpoint

func NewPinpoint

func NewPinpoint(cfg []byte, l *onelog.Logger) (Messenger, error)

NewPinpoint creates new instance of pinpoint

func NewTwilio

func NewTwilio(cfg []byte, l *onelog.Logger) (Messenger, error)

NewTwilio creates new instance of twilio