manager

Documentation

Index

• Constants
• type CampaignMessage
  • func (m *CampaignMessage) AltBody() []byte
  • func (m *CampaignMessage) Body() []byte
  • func (m *CampaignMessage) Subject() string
• type Config
• type DataSource
• type Manager
  • func New(cfg Config, src DataSource, notifCB models.AdminNotifCallback, i *i18n.I18n, ...) *Manager
  • func (m *Manager) AddMessenger(msg messenger.Messenger) error
  • func (m *Manager) Close()
  • func (m *Manager) HasMessenger(id string) bool
  • func (m *Manager) HasRunningCampaigns() bool
  • func (m *Manager) NewCampaignMessage(c *models.Campaign, s models.Subscriber) (CampaignMessage, error)
  • func (m *Manager) PushCampaignMessage(msg CampaignMessage) error
  • func (m *Manager) PushMessage(msg Message) error
  • func (m *Manager) Run(tick time.Duration)
  • func (m *Manager) TemplateFuncs(c *models.Campaign) template.FuncMap
• type Message

Constants

const (
	// BaseTPL is the name of the base template.
	BaseTPL = "base"

	// ContentTpl is the name of the compiled message.
	ContentTpl = "content"
)

Types

type CampaignMessage

type CampaignMessage struct {
	Campaign   *models.Campaign
	Subscriber models.Subscriber
	// contains filtered or unexported fields
}

CampaignMessage represents an instance of campaign message to be pushed out, specific to a subscriber, via the campaign's messenger.

func (*CampaignMessage) AltBody

func (m *CampaignMessage) AltBody() []byte

AltBody returns a copy of the message's alt body.

func (*CampaignMessage) Body

func (m *CampaignMessage) Body() []byte

Body returns a copy of the message body.

func (*CampaignMessage) Subject

func (m *CampaignMessage) Subject() string

Subject returns a copy of the message subject

type Config

type Config struct {
	// Number of subscribers to pull from the DB in a single iteration.
	BatchSize int

	Concurrency           int
	MessageRate           int
	MaxSendErrors         int
	SlidingWindow         bool
	SlidingWindowDuration time.Duration
	SlidingWindowRate     int
	RequeueOnError        bool
	FromEmail             string
	IndividualTracking    bool
	LinkTrackURL          string
	UnsubURL              string
	OptinURL              string
	MessageURL            string
	ViewTrackURL          string
	UnsubHeader           bool
}

Config has parameters for configuring the manager.

type DataSource

type DataSource interface {
	NextCampaigns(excludeIDs []int64) ([]*models.Campaign, error)
	NextSubscribers(campID, limit int) ([]models.Subscriber, error)
	GetCampaign(campID int) (*models.Campaign, error)
	UpdateCampaignStatus(campID int, status string) error
	CreateLink(url string) (string, error)
}

DataSource represents a data backend, such as a database, that provides subscriber and campaign records.

type Manager

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

Manager handles the scheduling, processing, and queuing of campaigns and message pushes.

func New

func New(cfg Config, src DataSource, notifCB models.AdminNotifCallback, i *i18n.I18n, l *log.Logger) *Manager

New returns a new instance of Mailer.

func (*Manager) AddMessenger

func (m *Manager) AddMessenger(msg messenger.Messenger) error

AddMessenger adds a Messenger messaging backend to the manager.

func (*Manager) Close

func (m *Manager) Close()

Close closes and exits the campaign manager.

func (*Manager) HasMessenger

func (m *Manager) HasMessenger(id string) bool

HasMessenger checks if a given messenger is registered.

func (*Manager) HasRunningCampaigns

func (m *Manager) HasRunningCampaigns() bool

HasRunningCampaigns checks if there are any active campaigns.

func (*Manager) NewCampaignMessage

func (m *Manager) NewCampaignMessage(c *models.Campaign, s models.Subscriber) (CampaignMessage, error)

NewCampaignMessage creates and returns a CampaignMessage that is made available to message templates while they're compiled. It represents a message from a campaign that's bound to a single Subscriber.

func (*Manager) PushCampaignMessage

func (m *Manager) PushCampaignMessage(msg CampaignMessage) error

PushCampaignMessage pushes a campaign messages to be sent out by the workers. It times out if the queue is busy.

func (*Manager) PushMessage

func (m *Manager) PushMessage(msg Message) error

PushMessage pushes an arbitrary non-campaign Message to be sent out by the workers. It times out if the queue is busy.

func (*Manager) Run

func (m *Manager) Run(tick time.Duration)

Run is a blocking function (that should be invoked as a goroutine) that scans the data source at regular intervals for pending campaigns, and queues them for processing. The process queue fetches batches of subscribers and pushes messages to them for each queued campaign until all subscribers are exhausted, at which point, a campaign is marked as "finished".

func (*Manager) TemplateFuncs

func (m *Manager) TemplateFuncs(c *models.Campaign) template.FuncMap

TemplateFuncs returns the template functions to be applied into compiled campaign templates.

type Message

type Message struct {
	messenger.Message
	Subscriber models.Subscriber

	// Messenger is the messenger backend to use: email|postback.
	Messenger string
}

Message represents a generic message to be pushed to a messenger.