High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
JavaScript campaigncampaign-managementemail-marketingemail-subscriptionlistmonkmailing-listnewsletternewsletter-managementnewsletter-softwareself-hostedsms-gatewaysmtptransactional-emails
package models
import (
"fmt"
"html/template"
"io"
txttpl "text/template"
"time"
null "gopkg.in/volatiletech/null.v6"
)
const (
BaseTpl = "base"
ContentTpl = "content"
TemplateTypeCampaign = "campaign"
TemplateTypeCampaignVisual = "campaign_visual"
TemplateTypeTx = "tx"
)
// tplRenderer exposes only execution and hides other unrelated methods.
type tplRenderer struct {
tpl interface {
ExecuteTemplate(io.Writer, string, any) error
}
}
func (t *tplRenderer) ExecuteTemplate(w io.Writer, name string, data any) error {
return t.tpl.ExecuteTemplate(w, name, data)
}
// Template represents a reusable e-mail template.
type Template struct {
Base
Name string `db:"name" json:"name"`
// Subject is only for type=tx.
Subject string `db:"subject" json:"subject"`
Type string `db:"type" json:"type"`
Body string `db:"body" json:"body,omitempty"`
BodySource null.String `db:"body_source" json:"body_source,omitempty"`
IsDefault bool `db:"is_default" json:"is_default"`
// Only relevant to tx (transactional) templates.
SubjectTpl *tplRenderer `json:"-"`
Tpl *tplRenderer `json:"-"`
Attachments []Attachment `json:"-"`
}
// Compile compiles a template body and subject (only for tx templates) and
// caches the templat references to be executed later.
func (t *Template) Compile(f template.FuncMap) error {
tpl, err := template.New(BaseTpl).Funcs(f).Parse(t.Body)
if err != nil {
return fmt.Errorf("error compiling transactional template: %v", err)
}
t.Tpl = &tplRenderer{tpl}
// If the subject line has a template string, compile it.
if HasTplExpr(t.Subject) {
subj := t.Subject
subjTpl, err := txttpl.New(BaseTpl).Funcs(f).Parse(subj)
if err != nil {
return fmt.Errorf("error compiling subject: %v", err)
}
t.SubjectTpl = &tplRenderer{subjTpl}
}
return nil
}
type CampaignStats struct {
ID int `db:"id" json:"id"`
Status string `db:"status" json:"status"`
ToSend int `db:"to_send" json:"to_send"`
Sent int `db:"sent" json:"sent"`
Started null.Time `db:"started_at" json:"started_at"`
UpdatedAt null.Time `db:"updated_at" json:"updated_at"`
Rate int `json:"rate"`
NetRate int `json:"net_rate"`
}
// AnalyticsItem is the minimal campaign or list metadata used by analytics.
type AnalyticsItem struct {
ID int `db:"id" json:"id"`
Name string `db:"name" json:"name"`
Sent int `db:"sent" json:"sent"`
}
type CampaignAnalyticsCount struct {
Total *int `db:"total" json:"-"`
ListID int `db:"list_id" json:"list_id,omitempty"`
CampaignID int `db:"campaign_id" json:"campaign_id"`
Count int `db:"count" json:"count"`
Timestamp time.Time `db:"timestamp" json:"timestamp"`
}
type CampaignAnalyticsLink struct {
URL string `db:"url" json:"url"`
Count int `db:"count" json:"count"`
}
type CampaignViewExport struct {
CampaignID int `db:"campaign_id"`
CampaignUUID string `db:"campaign_uuid"`
CampaignName string `db:"campaign_name"`
SubscriberID int `db:"subscriber_id"`
SubscriberUUID string `db:"subscriber_uuid"`
Email string `db:"email"`
SubscriberName string `db:"subscriber_name"`
CreatedAt time.Time `db:"created_at"`
}
type CampaignClickExport struct {
CampaignID int `db:"campaign_id"`
CampaignUUID string `db:"campaign_uuid"`
CampaignName string `db:"campaign_name"`
SubscriberID int `db:"subscriber_id"`
SubscriberUUID string `db:"subscriber_uuid"`
Email string `db:"email"`
SubscriberName string `db:"subscriber_name"`
URL string `db:"url"`
CreatedAt time.Time `db:"created_at"`
}