From 1ae98699e7fe5be8c0f4ede5042a88e38e90214a Mon Sep 17 00:00:00 2001 From: Kailash Nadh Date: Mon, 24 May 2021 22:41:48 +0530 Subject: [PATCH] Add support for bounce processing. - Blocklist or unsubscribe subscribers based on a bounce threshold - Add /bounces UI for viewing bounces and in the subscriber view - Add settings UI for managing bounce settings - Add support for scanning POP3 bounce mailboxes - Add a generic webhook for posting custom bounces at /webhooks/bounce - Add SES bounce webhook support at /webhooks/services/ses - Add Sendgrid bounce webhook support at /webhooks/services/sendgrid --- cmd/bounce.go | 251 ++++++++++++++++++++++ cmd/campaigns.go | 1 + cmd/handlers.go | 14 ++ cmd/init.go | 52 ++++- cmd/lists.go | 3 +- cmd/main.go | 7 + cmd/{manager_db.go => manager_store.go} | 30 ++- cmd/queries.go | 4 + cmd/settings.go | 54 +++++ cmd/subscribers.go | 22 ++ cmd/upgrade.go | 1 + frontend/fontello/config.json | 56 ++--- frontend/src/App.vue | 4 + frontend/src/api/index.js | 19 ++ frontend/src/assets/icons/fontello.css | 18 +- frontend/src/assets/icons/fontello.woff2 | Bin 6824 -> 7288 bytes frontend/src/assets/style.scss | 20 +- frontend/src/constants.js | 1 + frontend/src/router/index.js | 6 + frontend/src/views/Bounces.vue | 196 +++++++++++++++++ frontend/src/views/Campaigns.vue | 6 + frontend/src/views/Settings.vue | 192 ++++++++++++++++- frontend/src/views/SubscriberForm.vue | 117 +++++++++-- frontend/src/views/Subscribers.vue | 19 +- go.mod | 1 + go.sum | 9 +- i18n/en.json | 46 +++- internal/bounce/bounce.go | 148 +++++++++++++ internal/bounce/gmail.bounce | 257 +++++++++++++++++++++++ internal/bounce/mailbox/opt.go | 29 +++ internal/bounce/mailbox/pop.go | 119 +++++++++++ internal/bounce/proton.bounce | 152 ++++++++++++++ internal/bounce/webhooks/sendgrid.go | 104 +++++++++ internal/bounce/webhooks/ses.go | 249 ++++++++++++++++++++++ internal/manager/manager.go | 98 +++++++-- internal/migrations/v2.0.0.go | 43 ++++ models/models.go | 31 +++ queries.sql | 71 +++++++ schema.sql | 27 ++- 39 files changed, 2386 insertions(+), 91 deletions(-) create mode 100644 cmd/bounce.go rename cmd/{manager_db.go => manager_store.go} (71%) create mode 100644 frontend/src/views/Bounces.vue create mode 100644 internal/bounce/bounce.go create mode 100644 internal/bounce/gmail.bounce create mode 100644 internal/bounce/mailbox/opt.go create mode 100644 internal/bounce/mailbox/pop.go create mode 100644 internal/bounce/proton.bounce create mode 100644 internal/bounce/webhooks/sendgrid.go create mode 100644 internal/bounce/webhooks/ses.go create mode 100644 internal/migrations/v2.0.0.go diff --git a/cmd/bounce.go b/cmd/bounce.go new file mode 100644 index 0000000..1ed87e8 --- /dev/null +++ b/cmd/bounce.go @@ -0,0 +1,251 @@ +package main + +import ( + "encoding/json" + "fmt" + "io/ioutil" + "net/http" + "strconv" + "strings" + "time" + + "github.com/knadh/listmonk/internal/subimporter" + "github.com/knadh/listmonk/models" + "github.com/labstack/echo" + "github.com/lib/pq" +) + +type bouncesWrap struct { + Results []models.Bounce `json:"results"` + + Total int `json:"total"` + PerPage int `json:"per_page"` + Page int `json:"page"` +} + +// handleGetBounces handles retrieval of bounce records. +func handleGetBounces(c echo.Context) error { + var ( + app = c.Get("app").(*App) + pg = getPagination(c.QueryParams(), 50) + out bouncesWrap + + id, _ = strconv.Atoi(c.Param("id")) + campID, _ = strconv.Atoi(c.QueryParam("campaign_id")) + source = c.FormValue("source") + orderBy = c.FormValue("order_by") + order = c.FormValue("order") + ) + + // Fetch one list. + single := false + if id > 0 { + single = true + } + + // Sort params. + if !strSliceContains(orderBy, bounceQuerySortFields) { + orderBy = "created_at" + } + if order != sortAsc && order != sortDesc { + order = sortDesc + } + + stmt := fmt.Sprintf(app.queries.QueryBounces, orderBy, order) + if err := db.Select(&out.Results, stmt, id, campID, 0, source, pg.Offset, pg.Limit); err != nil { + app.log.Printf("error fetching bounces: %v", err) + return echo.NewHTTPError(http.StatusInternalServerError, + app.i18n.Ts("globals.messages.errorFetching", + "name", "{globals.terms.bounce}", "error", pqErrMsg(err))) + } + if len(out.Results) == 0 { + out.Results = []models.Bounce{} + return c.JSON(http.StatusOK, okResp{out}) + } + + if single { + return c.JSON(http.StatusOK, okResp{out.Results[0]}) + } + + // Meta. + out.Total = out.Results[0].Total + out.Page = pg.Page + out.PerPage = pg.PerPage + + return c.JSON(http.StatusOK, okResp{out}) +} + +// handleGetSubscriberBounces retrieves a subscriber's bounce records. +func handleGetSubscriberBounces(c echo.Context) error { + var ( + app = c.Get("app").(*App) + subID = c.Param("id") + ) + + id, _ := strconv.ParseInt(subID, 10, 64) + if id < 1 { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidID")) + } + + out := []models.Bounce{} + stmt := fmt.Sprintf(app.queries.QueryBounces, "created_at", "ASC") + if err := db.Select(&out, stmt, 0, 0, subID, "", 0, 1000); err != nil { + app.log.Printf("error fetching bounces: %v", err) + return echo.NewHTTPError(http.StatusInternalServerError, + app.i18n.Ts("globals.messages.errorFetching", + "name", "{globals.terms.bounce}", "error", pqErrMsg(err))) + } + + return c.JSON(http.StatusOK, okResp{out}) +} + +// handleDeleteBounces handles bounce deletion, either a single one (ID in the URI), or a list. +func handleDeleteBounces(c echo.Context) error { + var ( + app = c.Get("app").(*App) + pID = c.Param("id") + all, _ = strconv.ParseBool(c.QueryParam("all")) + IDs = pq.Int64Array{} + ) + + // Is it an /:id call? + if pID != "" { + id, _ := strconv.ParseInt(pID, 10, 64) + if id < 1 { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidID")) + } + IDs = append(IDs, id) + } else if !all { + // Multiple IDs. + i, err := parseStringIDs(c.Request().URL.Query()["id"]) + if err != nil { + return echo.NewHTTPError(http.StatusBadRequest, + app.i18n.Ts("globals.messages.invalidID", "error", err.Error())) + } + + if len(i) == 0 { + return echo.NewHTTPError(http.StatusBadRequest, + app.i18n.Ts("globals.messages.invalidID")) + } + IDs = i + } + + if _, err := app.queries.DeleteBounces.Exec(IDs); err != nil { + app.log.Printf("error deleting bounces: %v", err) + return echo.NewHTTPError(http.StatusInternalServerError, + app.i18n.Ts("globals.messages.errorDeleting", + "name", "{globals.terms.bounce}", "error", pqErrMsg(err))) + } + + return c.JSON(http.StatusOK, okResp{true}) +} + +// handleBounceWebhook renders the HTML preview of a template. +func handleBounceWebhook(c echo.Context) error { + var ( + app = c.Get("app").(*App) + service = c.Param("service") + + bounces []models.Bounce + ) + + // Read the request body instead of using using c.Bind() to read to save the entire raw request as meta. + rawReq, err := ioutil.ReadAll(c.Request().Body) + if err != nil { + app.log.Printf("error reading ses notification body: %v", err) + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.Ts("globals.messages.internalError")) + } + + switch true { + // Native internal webhook. + case service == "": + var b models.Bounce + if err := json.Unmarshal(rawReq, &b); err != nil { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.Ts("globals.messages.invalidData")) + } + + if err := validateBounceFields(b, app); err != nil { + return err + } + + b.Email = strings.ToLower(b.Email) + + if len(b.Meta) == 0 { + b.Meta = json.RawMessage("{}") + } + + if b.CreatedAt.Year() == 0 { + b.CreatedAt = time.Now() + } + + bounces = append(bounces, b) + + // Amazon SES. + case service == "ses" && app.constants.BounceSESEnabled: + switch c.Request().Header.Get("X-Amz-Sns-Message-Type") { + // SNS webhook registration confirmation. Only after these are processed will the endpoint + // start getting bounce notifications. + case "SubscriptionConfirmation", "UnsubscribeConfirmation": + if err := app.bounce.SES.ProcessSubscription(rawReq); err != nil { + app.log.Printf("error processing SNS (SES) subscription: %v", err) + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidData")) + } + break + + // Bounce notification. + case "Notification": + b, err := app.bounce.SES.ProcessBounce(rawReq) + if err != nil { + app.log.Printf("error processing SES notification: %v", err) + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidData")) + } + bounces = append(bounces, b) + + default: + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidData")) + } + + // SendGrid. + case service == "sendgrid" && app.constants.BounceSendgridEnabled: + var ( + sig = c.Request().Header.Get("X-Twilio-Email-Event-Webhook-Signature") + ts = c.Request().Header.Get("X-Twilio-Email-Event-Webhook-Timestamp") + ) + + // Sendgrid sends multiple bounces. + bs, err := app.bounce.Sendgrid.ProcessBounce(sig, ts, rawReq) + if err != nil { + app.log.Printf("error processing sendgrid notification: %v", err) + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidData")) + } + bounces = append(bounces, bs...) + + default: + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.Ts("bounces.unknownService")) + } + + // Record bounces if any. + for _, b := range bounces { + if err := app.bounce.Record(b); err != nil { + app.log.Printf("error recording bounce: %v", err) + } + } + + return c.JSON(http.StatusOK, okResp{true}) +} + +func validateBounceFields(b models.Bounce, app *App) error { + if b.Email == "" && b.SubscriberUUID == "" { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidData")) + } + + if b.Email != "" && !subimporter.IsEmail(b.Email) { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidEmail")) + } + + if b.SubscriberUUID != "" && !reUUID.MatchString(b.SubscriberUUID) { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidUUID")) + } + + return nil +} diff --git a/cmd/campaigns.go b/cmd/campaigns.go index c21d1b1..312f799 100644 --- a/cmd/campaigns.go +++ b/cmd/campaigns.go @@ -73,6 +73,7 @@ var ( regexFullTextQuery = regexp.MustCompile(`\s+`) campaignQuerySortFields = []string{"name", "status", "created_at", "updated_at"} + bounceQuerySortFields = []string{"email", "campaign_name", "source", "created_at"} ) // handleGetCampaigns handles retrieval of campaigns. diff --git a/cmd/handlers.go b/cmd/handlers.go index bcf6f50..ebf64c1 100644 --- a/cmd/handlers.go +++ b/cmd/handlers.go @@ -62,6 +62,8 @@ func registerHTTPHandlers(e *echo.Echo, app *App) { g.GET("/api/subscribers/:id", handleGetSubscriber) g.GET("/api/subscribers/:id/export", handleExportSubscriberData) + g.GET("/api/subscribers/:id/bounces", handleGetSubscriberBounces) + g.DELETE("/api/subscribers/:id/bounces", handleDeleteSubscriberBounces) g.POST("/api/subscribers", handleCreateSubscriber) g.PUT("/api/subscribers/:id", handleUpdateSubscriber) g.POST("/api/subscribers/:id/optin", handleSubscriberSendOptin) @@ -72,6 +74,10 @@ func registerHTTPHandlers(e *echo.Echo, app *App) { g.DELETE("/api/subscribers/:id", handleDeleteSubscribers) g.DELETE("/api/subscribers", handleDeleteSubscribers) + g.GET("/api/bounces", handleGetBounces) + g.DELETE("/api/bounces", handleDeleteBounces) + g.DELETE("/api/bounces/:id", handleDeleteBounces) + // Subscriber operations based on arbitrary SQL queries. // These aren't very REST-like. g.POST("/api/subscribers/query/delete", handleDeleteSubscribersByQuery) @@ -132,6 +138,14 @@ func registerHTTPHandlers(e *echo.Echo, app *App) { g.GET("/settings", handleIndexPage) g.GET("/settings/logs", handleIndexPage) + if app.constants.BounceWebhooksEnabled { + // Private authenticated bounce endpoint. + g.POST("/webhooks/bounce", handleBounceWebhook) + + // Public bounce endpoints for webservices like SES. + e.POST("/webhooks/service/:service", handleBounceWebhook) + } + // Public subscriber facing views. e.GET("/subscription/form", handleSubscriptionFormPage) e.POST("/subscription/form", handleSubscriptionForm) diff --git a/cmd/init.go b/cmd/init.go index 994e756..ff0eeb2 100644 --- a/cmd/init.go +++ b/cmd/init.go @@ -21,6 +21,8 @@ import ( "github.com/knadh/koanf/providers/confmap" "github.com/knadh/koanf/providers/file" "github.com/knadh/koanf/providers/posflag" + "github.com/knadh/listmonk/internal/bounce" + "github.com/knadh/listmonk/internal/bounce/mailbox" "github.com/knadh/listmonk/internal/i18n" "github.com/knadh/listmonk/internal/manager" "github.com/knadh/listmonk/internal/media" @@ -65,6 +67,10 @@ type constants struct { OptinURL string MessageURL string MediaProvider string + + BounceWebhooksEnabled bool + BounceSESEnabled bool + BounceSendgridEnabled bool } func initFlags() { @@ -296,6 +302,10 @@ func initConstants() *constants { // url.com/campaign/{campaign_uuid}/{subscriber_uuid}/px.png c.ViewTrackURL = fmt.Sprintf("%s/campaign/%%s/%%s/px.png", c.RootURL) + + c.BounceWebhooksEnabled = ko.Bool("bounce.webhooks_enabled") + c.BounceSESEnabled = ko.Bool("bounce.ses_enabled") + c.BounceSendgridEnabled = ko.Bool("bounce.sendgrid_enabled") return &c } @@ -344,8 +354,7 @@ func initCampaignManager(q *Queries, cs *constants, app *App) *manager.Manager { SlidingWindow: ko.Bool("app.message_sliding_window"), SlidingWindowDuration: ko.Duration("app.message_sliding_window_duration"), SlidingWindowRate: ko.Int("app.message_sliding_window_rate"), - }, newManagerDB(q), campNotifCB, app.i18n, lo) - + }, newManagerStore(q), campNotifCB, app.i18n, lo) } // initImporter initializes the bulk subscriber importer. @@ -495,6 +504,45 @@ func initNotifTemplates(path string, fs stuffbin.FileSystem, i *i18n.I18n, cs *c return tpl } +// initBounceManager initializes the bounce manager that scans mailboxes and listens to webhooks +// for incoming bounce events. +func initBounceManager(app *App) *bounce.Manager { + opt := bounce.Opt{ + BounceCount: ko.MustInt("bounce.count"), + BounceAction: ko.MustString("bounce.action"), + WebhooksEnabled: ko.Bool("bounce.webhooks_enabled"), + SESEnabled: ko.Bool("bounce.ses_enabled"), + SendgridEnabled: ko.Bool("bounce.sendgrid_enabled"), + SendgridKey: ko.String("bounce.sendgrid_key"), + } + + // For now, only one mailbox is supported. + for _, b := range ko.Slices("bounce.mailboxes") { + if !b.Bool("enabled") { + continue + } + + var boxOpt mailbox.Opt + if err := b.UnmarshalWithConf("", &boxOpt, koanf.UnmarshalConf{Tag: "json"}); err != nil { + lo.Fatalf("error reading bounce mailbox config: %v", err) + } + + opt.MailboxType = b.String("type") + opt.MailboxEnabled = true + opt.Mailbox = boxOpt + break + } + + b, err := bounce.New(opt, &bounce.Queries{ + RecordQuery: app.queries.RecordBounce, + }, app.log) + if err != nil { + lo.Fatalf("error initializing bounce manager: %v", err) + } + + return b +} + // initHTTPServer sets up and runs the app's main HTTP server and blocks forever. func initHTTPServer(app *App) *echo.Echo { // Initialize the HTTP server. diff --git a/cmd/lists.go b/cmd/lists.go index 5864763..d965b24 100644 --- a/cmd/lists.go +++ b/cmd/lists.go @@ -160,8 +160,7 @@ func handleUpdateList(c echo.Context) error { return handleGetLists(c) } -// handleDeleteLists handles deletion deletion, -// either a single one (ID in the URI), or a list. +// handleDeleteLists handles list deletion, either a single one (ID in the URI), or a list. func handleDeleteLists(c echo.Context) error { var ( app = c.Get("app").(*App) diff --git a/cmd/main.go b/cmd/main.go index ff1a1c7..37d02e2 100644 --- a/cmd/main.go +++ b/cmd/main.go @@ -17,6 +17,7 @@ import ( "github.com/jmoiron/sqlx" "github.com/knadh/koanf" "github.com/knadh/koanf/providers/env" + "github.com/knadh/listmonk/internal/bounce" "github.com/knadh/listmonk/internal/buflog" "github.com/knadh/listmonk/internal/i18n" "github.com/knadh/listmonk/internal/manager" @@ -42,6 +43,7 @@ type App struct { messengers map[string]messenger.Messenger media media.Store i18n *i18n.I18n + bounce *bounce.Manager notifTpls *template.Template log *log.Logger bufLog *buflog.BufLog @@ -168,6 +170,11 @@ func main() { app.importer = initImporter(app.queries, db, app) app.notifTpls = initNotifTemplates("/email-templates/*.html", fs, app.i18n, app.constants) + if ko.Bool("bounce.enabled") { + app.bounce = initBounceManager(app) + go app.bounce.Run() + } + // Initialize the default SMTP (`email`) messenger. app.messengers[emailMsgr] = initSMTPMessenger(app.manager) diff --git a/cmd/manager_db.go b/cmd/manager_store.go similarity index 71% rename from cmd/manager_db.go rename to cmd/manager_store.go index 7ed7d96..5ff5e55 100644 --- a/cmd/manager_db.go +++ b/cmd/manager_store.go @@ -12,7 +12,7 @@ type runnerDB struct { queries *Queries } -func newManagerDB(q *Queries) *runnerDB { +func newManagerStore(q *Queries) *runnerDB { return &runnerDB{ queries: q, } @@ -64,3 +64,31 @@ func (r *runnerDB) CreateLink(url string) (string, error) { return out, nil } + +// RecordBounce records a bounce event and returns the bounce count. +func (r *runnerDB) RecordBounce(b models.Bounce) (int64, int, error) { + var res = struct { + SubscriberID int64 `db:"subscriber_id"` + Num int `db:"num"` + }{} + + err := r.queries.UpdateCampaignStatus.Select(&res, + b.SubscriberUUID, + b.Email, + b.CampaignUUID, + b.Type, + b.Source, + b.Meta) + + return res.SubscriberID, res.Num, err +} + +func (r *runnerDB) BlocklistSubscriber(id int64) error { + _, err := r.queries.BlocklistSubscribers.Exec(pq.Int64Array{id}) + return err +} + +func (r *runnerDB) DeleteSubscriber(id int64) error { + _, err := r.queries.DeleteSubscribers.Exec(pq.Int64Array{id}) + return err +} diff --git a/cmd/queries.go b/cmd/queries.go index e6f692f..3fdded4 100644 --- a/cmd/queries.go +++ b/cmd/queries.go @@ -83,6 +83,10 @@ type Queries struct { UpdateSettings *sqlx.Stmt `query:"update-settings"` // GetStats *sqlx.Stmt `query:"get-stats"` + RecordBounce *sqlx.Stmt `query:"record-bounce"` + QueryBounces string `query:"query-bounces"` + DeleteBounces *sqlx.Stmt `query:"delete-bounces"` + DeleteBouncesBySubscriber *sqlx.Stmt `query:"delete-bounces-by-subscriber"` } // dbConf contains database config required for connecting to a DB. diff --git a/cmd/settings.go b/cmd/settings.go index 72e9412..ae48705 100644 --- a/cmd/settings.go +++ b/cmd/settings.go @@ -80,6 +80,28 @@ type settings struct { Timeout string `json:"timeout"` MaxMsgRetries int `json:"max_msg_retries"` } `json:"messengers"` + + BounceEnabled bool `json:"bounce.enabled"` + BounceEnableWebhooks bool `json:"bounce.webhooks_enabled"` + BounceCount int `json:"bounce.count"` + BounceAction string `json:"bounce.action"` + SESEnabled bool `json:"bounce.ses_enabled"` + SendgridEnabled bool `json:"bounce.sendgrid_enabled"` + SendgridKey string `json:"bounce.sendgrid_key"` + BounceBoxes []struct { + UUID string `json:"uuid"` + Enabled bool `json:"enabled"` + Type string `json:"type"` + Host string `json:"host"` + Port int `json:"port"` + AuthProtocol string `json:"auth_protocol"` + ReturnPath string `json:"return_path"` + Username string `json:"username"` + Password string `json:"password,omitempty"` + TLSEnabled bool `json:"tls_enabled"` + TLSSkipVerify bool `json:"tls_skip_verify"` + ScanInterval string `json:"scan_interval"` + } `json:"bounce.mailboxes"` } var ( @@ -99,10 +121,14 @@ func handleGetSettings(c echo.Context) error { for i := 0; i < len(s.SMTP); i++ { s.SMTP[i].Password = "" } + for i := 0; i < len(s.BounceBoxes); i++ { + s.BounceBoxes[i].Password = "" + } for i := 0; i < len(s.Messengers); i++ { s.Messengers[i].Password = "" } s.UploadS3AwsSecretAccessKey = "" + s.SendgridKey = "" return c.JSON(http.StatusOK, okResp{s}) } @@ -154,6 +180,31 @@ func handleUpdateSettings(c echo.Context) error { return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("settings.errorNoSMTP")) } + // Bounce boxes. + for i, s := range set.BounceBoxes { + // Assign a UUID. The frontend only sends a password when the user explictly + // changes the password. In other cases, the existing password in the DB + // is copied while updating the settings and the UUID is used to match + // the incoming array of blocks with the array in the DB. + if s.UUID == "" { + set.BounceBoxes[i].UUID = uuid.Must(uuid.NewV4()).String() + } + + if d, _ := time.ParseDuration(s.ScanInterval); d.Minutes() < 1 { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("settings.bounces.invalidScanInterval")) + } + + // If there's no password coming in from the frontend, copy the existing + // password by matching the UUID. + if s.Password == "" { + for _, c := range cur.BounceBoxes { + if s.UUID == c.UUID { + set.BounceBoxes[i].Password = c.Password + } + } + } + } + // Validate and sanitize postback Messenger names. Duplicates are disallowed // and "email" is a reserved name. names := map[string]bool{emailMsgr: true} @@ -189,6 +240,9 @@ func handleUpdateSettings(c echo.Context) error { if set.UploadS3AwsSecretAccessKey == "" { set.UploadS3AwsSecretAccessKey = cur.UploadS3AwsSecretAccessKey } + if set.SendgridKey == "" { + set.SendgridKey = cur.SendgridKey + } // Marshal settings. b, err := json.Marshal(set) diff --git a/cmd/subscribers.go b/cmd/subscribers.go index 56462df..a4a6288 100644 --- a/cmd/subscribers.go +++ b/cmd/subscribers.go @@ -614,6 +614,28 @@ func handleManageSubscriberListsByQuery(c echo.Context) error { return c.JSON(http.StatusOK, okResp{true}) } +// handleDeleteSubscriberBounces deletes all the bounces on a subscriber. +func handleDeleteSubscriberBounces(c echo.Context) error { + var ( + app = c.Get("app").(*App) + pID = c.Param("id") + ) + + id, _ := strconv.ParseInt(pID, 10, 64) + if id < 1 { + return echo.NewHTTPError(http.StatusBadRequest, app.i18n.T("globals.messages.invalidID")) + } + + if _, err := app.queries.DeleteBouncesBySubscriber.Exec(id, nil); err != nil { + app.log.Printf("error deleting bounces: %v", err) + return echo.NewHTTPError(http.StatusInternalServerError, + app.i18n.Ts("globals.messages.errorDeleting", + "name", "{globals.terms.bounces}", "error", pqErrMsg(err))) + } + + return c.JSON(http.StatusOK, okResp{true}) +} + // handleExportSubscriberData pulls the subscriber's profile, // list subscriptions, campaign views and clicks and produces // a JSON report. This is a privacy feature and depends on the diff --git a/cmd/upgrade.go b/cmd/upgrade.go index 72e6b8f..a27bc91 100644 --- a/cmd/upgrade.go +++ b/cmd/upgrade.go @@ -30,6 +30,7 @@ var migList = []migFunc{ {"v0.8.0", migrations.V0_8_0}, {"v0.9.0", migrations.V0_9_0}, {"v1.0.0", migrations.V1_0_0}, + {"v2.0.0", migrations.V2_0_0}, } // upgrade upgrades the database to the current version by running SQL migration files diff --git a/frontend/fontello/config.json b/frontend/fontello/config.json index 5e8f936..218347a 100644 --- a/frontend/fontello/config.json +++ b/frontend/fontello/config.json @@ -510,6 +510,34 @@ "magnify" ] }, + { + "uid": "e97fad4c93444c9b81151c2aa4086e13", + "css": "chart-bar", + "code": 59428, + "src": "custom_icons", + "selected": true, + "svg": { + "path": "M916 875H84V125H166V791H250V416H416V791H500V250H666V791H750V584H916V875Z", + "width": 1000 + }, + "search": [ + "chart-bar" + ] + }, + { + "uid": "61e03b48670cd93477e233e0d6bb3f1c", + "css": "email-bounce", + "code": 59429, + "src": "custom_icons", + "selected": true, + "svg": { + "path": "M916 834H750V959L541 771.5 750 584V709H916V834ZM834 166H166Q132.8 166 108.4 190.4T84 250V750Q84 785.2 108.4 809.6T166 834H459V750H166V334L500 541 834 334V625H916V250Q916 214.8 891.6 190.4T834 166ZM500 459L166 250H834Z", + "width": 1000 + }, + "search": [ + "email-bounce" + ] + }, { "uid": "f4ad3f6d071a0bfb3a8452b514ed0892", "css": "vector-square", @@ -4570,20 +4598,6 @@ "chart-areaspline" ] }, - { - "uid": "e97fad4c93444c9b81151c2aa4086e13", - "css": "chart-bar", - "code": 983336, - "src": "custom_icons", - "selected": false, - "svg": { - "path": "M916 875H84V125H166V791H250V416H416V791H500V250H666V791H750V584H916V875Z", - "width": 1000 - }, - "search": [ - "chart-bar" - ] - }, { "uid": "298bc9b464d2b4e5cad91cd3d419747f", "css": "chart-histogram", @@ -60444,20 +60458,6 @@ "email-receive" ] }, - { - "uid": "61e03b48670cd93477e233e0d6bb3f1c", - "css": "email-receive-outline", - "code": 987355, - "src": "custom_icons", - "selected": false, - "svg": { - "path": "M916 834H750V959L541 771.5 750 584V709H916V834ZM834 166H166Q132.8 166 108.4 190.4T84 250V750Q84 785.2 108.4 809.6T166 834H459V750H166V334L500 541 834 334V625H916V250Q916 214.8 891.6 190.4T834 166ZM500 459L166 250H834Z", - "width": 1000 - }, - "search": [ - "email-receive-outline" - ] - }, { "uid": "b52d1e4a907f8f98e038e8997079e456", "css": "email-send", diff --git a/frontend/src/App.vue b/frontend/src/App.vue index 3297aa5..485d26a 100644 --- a/frontend/src/App.vue +++ b/frontend/src/App.vue @@ -55,6 +55,10 @@ + + http.delete(`/api/lists/${id}`, export const getSubscribers = async (params) => http.get('/api/subscribers', { params, loading: models.subscribers, store: models.subscribers }); +export const getSubscriber = async (id) => http.get(`/api/subscribers/${id}`, + { loading: models.subscribers }); + +export const getSubscriberBounces = async (id) => http.get(`/api/subscribers/${id}/bounces`, + { loading: models.bounces }); + +export const deleteSubscriberBounces = async (id) => http.delete(`/api/subscribers/${id}/bounces`, + { loading: models.bounces }); + +export const deleteBounce = async (id) => http.delete(`/api/bounces/${id}`, + { loading: models.bounces }); + +export const deleteBounces = async (params) => http.delete('/api/bounces', + { params, loading: models.bounces }); + export const createSubscriber = (data) => http.post('/api/subscribers', data, { loading: models.subscribers }); @@ -148,6 +163,10 @@ export const getImportLogs = async () => http.get('/api/import/subscribers/logs' export const stopImport = () => http.delete('/api/import/subscribers'); +// Bounces. +export const getBounces = async (params) => http.get('/api/bounces', + { params, loading: models.bounces }); + // Campaigns. export const getCampaigns = async (params) => http.get('/api/campaigns', { params, loading: models.campaigns, store: models.campaigns }); diff --git a/frontend/src/assets/icons/fontello.css b/frontend/src/assets/icons/fontello.css index 3d6cf7e..5d34a5d 100644 --- a/frontend/src/assets/icons/fontello.css +++ b/frontend/src/assets/icons/fontello.css @@ -5,37 +5,37 @@ font-style: normal; } - [class^="mdi-"]:before, [class*=" mdi-"]:before { +[class^="mdi-"]:before, [class*=" mdi-"]:before { font-family: "fontello"; font-style: normal; font-weight: normal; speak: never; - + display: inline-block; text-decoration: inherit; width: 1em; margin-right: .2em; text-align: center; /* opacity: .8; */ - + /* For safety - reset parent styles, that can break glyph codes*/ font-variant: normal; text-transform: none; - + /* fix buttons height, for twitter bootstrap */ line-height: 1em; - + /* Animation center compensation - margins should be symmetric */ /* remove if not needed */ margin-left: .2em; - + /* you can be more comfortable with increased icons size */ /* font-size: 120%; */ - + /* Font smoothing. That was taken from TWBS */ -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; - + /* Uncomment for 3D effect */ /* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */ } @@ -76,3 +76,5 @@ .mdi-arrow-down:before { content: '\e821'; } /* '' */ .mdi-cancel:before { content: '\e822'; } /* '' */ .mdi-magnify:before { content: '\e823'; } /* '' */ +.mdi-chart-bar:before { content: '\e824'; } /* '' */ +.mdi-email-bounce:before { content: '\e825'; } /* '' */ diff --git a/frontend/src/assets/icons/fontello.woff2 b/frontend/src/assets/icons/fontello.woff2 index fb07f159c7e45eed1e3aa1c73df3ccd21304c4e4..af01501d3638a8424353d45083e936b66d1eb749 100644 GIT binary patch literal 7288 zcmV-;9Eam~Pew8T0RR91033J#4*&oF05`}00303w0RR9100000000000000000000 z0000SR0d!GhIR-J37iZO2nxAavsDXF00A}vBm;pQ1Rw>4O$UWd41pXQY%?`u+>P1o zfFku!)*`Alhi3o(x8%kc(1BI{1GWf)pcYl}Mvl+gbhA>3uiyto74qWE8?skcEsbsnllFYXM ze_nm}zPzM}hEi~+no5Hxuu;$-XlLyNo&C)2&lXVeJb8QnmQjgy0|^Hb4dM&}?~>w3 z5@}MWNd^iD&;%g`xxTL5{)cHK1UY7YBvJYQ|81Y`ee~9?f~Oi2AzdrP2{B?b)r<>^ z5&GlzH-kA%$!3f7w1WEq<_8JH{XFA3c&S)LK*OsoG zq^N)t7-houv;i`pmW-eYO1||K^%b?c>Pu#Y&9NNN*i?U?hqn13izoz)H^H&S!WpFZ zkAr`qy}&4p0<5zl$VCS(vbZ0zGRxmDK}<7qsf-Vm@uf0;RK}mmI2wY#8C?xPfJfH|(fT!v+^&PW|K-rW z2=}WWQCxok@o*!RJ}HNMqO=CQ0?2g+6?$uc0H2Kv2w1Z=U_kvDGj+eP6$~WrZ6Z^Z zO^!~2@L)_(1`t-E2fZ0*($PV0VX2>LLO83ZC-$Gx8Dg6aIw`M-0XObcvROM?0~%ry zOmvEugV`*6qKbOL+e@JFS9a?#n_&a)&}lF(d%s;~Sj8>F(#=zfI*0DZ1>LVg2}+@d zo6H@aBF(Cq3Er-u5yh+X6XendiYF`iBk6=r&x_>U35Y|hsd&QqyD@c_jDJ&I; zp*pJX;?4tPTmswHkta@y{NK}>QggS1#$D%kRM->8qJ<#dJLM{kRzKEeAOU0?Wav;a zNNZ)mG6Bq10!T3emL4Q+F33PgYt!E5DqW`wHQpznQBNn4BL?MR-oO%JJgm8bkK%C+R`1~E8744p zR1%#F`Ygn&t<93Qt@#)0*-R_P?fXtG=s+^mU@#1b_t>qq!&4GC`_9a}C7GDb0n2}(5ut5bus3Zic z2m{rGLJeV|mT*uoQASL)@vMH}sY-DUt;xmAr0zL1wl$%pomic2+$Z7CX%o$X zr_X8!eMdd50|gwxVRvT?OgIE-Cd`~ewp6{qQ>k62`Mgm&L37k$_W*2uK?YqYAI=$c zpXLI^L~gVPiO9@rD(eCuOqB9!y!trUN+5TlEN(Q|+^sr&?*oN<0hmEWpQSz-r?gK> z*@uFI)94RGbFurg6McCq(?tX>SjGb3$eu*STX#n7j;W;*?<|P5vQ;@L+L*5=w;mkN zRpl*R@-5hka@ z`amLb%Hw*H=Gf#UHGG_QrqB6YhRJQ;l~`wcm&}xBkw9-*bSZl-Eqhj&UmwggOeM9^ zmP;zP0Bz1<{tPW5gS0g+5ryS}D7ZpYtAPQ~}4R7KMq^K&~iYaUlLcyJw zs$CW`LH3A}eWK)ms5f;|d82fXF};j1tu`Ojwh+v4+GT6imic zAA0oArt)-pCkwP_;~J$h0yhFwwtY>54vr$`DIiQCv_Xt$FI8inkA2g4C(IO7agoZ&VB4hlFaNUN&hd?N{7itK20*x);;d`% zuXwBW(Suvew4?LTu~u5d4j`?;tnG|nQMWKl1O$I7n;;u_4`A=3yaIfOgM1l4Pd*FK zeghqG*q~^@Wt72CwWro5AmmUa^Bn{!#)3kU!&s)aq0QcKs~bm}ZJmeWu%*tn-Eny1 zy?#k_IJ&FRw(VK|XcQE(ozeIxyzDlkXS3^=dAsyw;U5S(YPOE@x=ph`Y)fq-#@?9S z?H#_e!*JW*w-@%ipI7ZCH<7l~FWOp1n8o6{yctIPRsO{PX~%WTeqXc=%?p0akIK$r z5&pBt1zyGhh#}~Z?TfG<_;B#0!H*_?THlH!X`XojlyGB|Qd-ZIA^D(30tE9f4!St$ z;k=d-vEWCr;scT)H^+$;e4povj^PphYwk|lfo@(YaexDzy)nu10Lg;G7v}ioKrHWP!^FrRTBk>$Pw4$!@6wB@7RVXwzThx3Hr~oGqYl7va-q^Xb`h z1#H;x70$LlcP>Ug&1d`^Lh=kCZx#k{rsmA)-|)~O;GX%d6i$Cq-_OCpX{Q3KIGsTh z!82JmA&7-ZGMk2!&B8sD<}wc*SF{baf{Ez|a&q<&Pi1T`eMo+}@%io7TaOMSKxWWV z-$E}T4?`w59>6a66iR*4NVX3FU-XDTDJsmeQlYd)GVBc@H#z=u&XQUWyrin;pl?^# z=70|^54tc4{aRs6ID#%JRUtUBi(M`}5bOXlo0cSSVUEVhej8a1Wh-UW4b;elVLX(i z90HKQCmnZ%j^2~7_j$ykzf9txnJ40(m0sG7l(joeFkcxlRk$Hi}$ zuyZ`0p2aDEvMlRD&vNWk_Dpd9b^ccqE@$5a(0ob!*0jmrxDiY6=b+e^u`eM%ePv9# zn7lr7f{@iRv&xs9~rBU|r zkh(RmRScjjQ(efncamMI_5s$CrX_QXF4Cpib+7qZEJR2!g~aK5ry(Y)yTjhFXSYzJ zA!;!BG9iC0M zHXWzCk;MvAnIze5Iw7z~)|7Dta+=b`t#E*2h{P$(SG=1nN^4m4WS)0=15wTa zlmS#>qV{{iaRcR|SH=2&i9U(V)W?%rdIAAeO-PDnx|LT>IRV z-5%?A68Ru2f!8vpwrbg$X^0j$wQqPXx)kNFc)HZrw_2OP_9r14gtq#Yi}v=et%%EJ zJ4B139N3XN&h$lH#J@&I3C6c(!bZa`Y;OMUQg`?0u2E=sI0_%X?a{tA0KYrLHjry< z>gNAS;RencJNG7hKF@k%a6q)8juYVL+7J^7NnxA&OJIq_dXqzNa7q$yxU`$$?_b84 zM)bO?(!D($rWRg(Zf$$9N<01?CtdJONdC{~myk@o3$07;Xcn&1>y_NIbuD#ui}d;% zSaWOas$`DkZzL@Suuyyf5s+jovG{o`~?d(`My+V z&zpPeAIW72sp5pYWV$RSoi@xZihdm%99=g76B%yGr_v_ibZ?OL&!*P`z()Le=5Q8k zdb(hHFaRUMEHi?`z5WTs*``^}BL`Hf7KXj00i8^oWr51hE~afExc2t+3atVcuF;jg zrE>l#(rY~n;qEW~1&5L_ zjj8d^iO*T{^mw66R!r`kEiVN+Ddo%J{IP?pIPQ=3M(QJ?^yDjH`YloC>}`h|cZ@xw z*fF>s9rU!kpZ0xt(}_#cqrK9V+da*aNBhww`y`meQa5oBBJJyx%608Sim&`U?9eg- z!$IwVf$h7AQ{V3897Oy}I_hHdpGQKhwKa96K`?&mEo~1sQ}g@|l`f819ADHG;JGrd zdR};WO(XzBihRqB|Si9P0dF-i@gt$8IZ{+4v z1*v@RR9vaxpTz7DZC(pyXxDNkx(JOUwk#e1JG8vF;{=p~TL1(M#i z(QW+1$E)q9u+N{5l;E86Gtjwz&EghCa=FNvJz5s_u`Bp-@@2L&5!lG5l*SGpI6{^x z;z<(c%R!!@An)>889r|EJt>6*ar}YgNFezF%JzR5=3mLj6624MUnCznl=ym*$tS<_ z=Lsf#GK&WvK31+qSNwLe!Rq!Y3P^G!K?Ww|X8E z2~RA3vJY~c$|jJk59hq?gZpjXkg}YYm$zWvM0WQ3Kb-lj0{>ZO&jrb#DRNzrk|v+Q zw?mhK?(CVoyt&h^HU6G0kjq8xV6gGz$&bMhw|=sz>>J*5?5NEeM%A&${r!CEx|{#c zZ}&o=W|3&*NSe(Sj#wOf{lJ!wmNe?JRmmI?B3iISgAlJ?JOHSs{q>93#Ygv%uU}rg zNe!=F#?1dsqaPTQEDXM>N`*wblE@m&p7xuW-(19KOe5JdVF8y*UjWM3AXntAK_V*H{aVreh2eO zJ`0IU(MBAt5MivT+Hjo0WS!Pbwls}f_FKGV6+DrGMk`H0k!(9YitrB zrJ&<6hf5&ge7elNrYz%aFo`|FxJ-E&c@odE>PP#-DktjtOb9#)v<_N zOA;ME={Pa{hKh7#2!}?X)F=aL%e0z&jCYtnN~mH6Ko?NxG!nR@uAH^4zuD$m#;xsn zd&r+;$8l$g-DQhX`e0%kCzK7S+^~EcHvs2~1WHhxjU{xc|Q(z;xEvJCaoGKOqis??aks&Y6P2VNBWn>Q{XjnS|O(^Jz$5ODO5*(|2=@d_3 zq*P(Hhsp`Em}@xB3%B*sfrcE3rJ(lmx=54%+H=YkCqj#3#RB%Y=gZ-}+x| z`|+sRiFRB=Vd>(~{1*m`#{S0B+0vG1bE#sYe}GYpE0F&OL@)y&3kYO-*4r6QtgT~j zE~>Fbn#e*GQXV|5Un=3mR;z9$KShwf2#*cWN()&xLmX7+03EZ1wo7zYyE$Y;t6~GX zu6~Ew)ej%vQ*u4;--q{R)l7#LitOmF!yHY_d5I<|ICfMx50eoLPl?nSRJj0^({02k zB8Z$1ZXBCWy*~xf?vdaIaL4c9Fm<~L6)6Rh6Xm|ocFKvuCc5lg)C0^f#BZ@=g_L_5 z%h+e>{5QV8yQ?zq86=Iu(#8JVRph$|_2GCEXECFrlktfk=-8$9e`FR31Or?*QIr|X zRb?#$7E7di&XMWg!P7rH)nPFMt_$789Y(=%c{=frQOnE-Zpg=7ssMl8aS%_8?g)#xorW= zQq!Dkh&~x-(Eosl{{zs34iHji5Wx>}CeHfy3MV?&ad9qc*=VQLi&YVf*|`kk!u&j4 zENzJ$LptEU8?TWzENsfUDqP>?${^JiW7HbQLI9j*c6^!$ zy(J|%qXg`Dm>!$RB+g7PFpSDfCSb3o-0$>tqm|dWTd}q4XhbWAPXYTvCX~Cn1p=Ib z!~&p|RrWc4XU^S*5eLE^6mHm@&Fj=PsQ%@tQ(0(5Ynw35@j5UgDb**046Fn^;VT%D zmdnCbeYPr}o57o3q_eIr(|xv^-!Q9iATLc(0?os);xSmL{i9o}Oj?pnO0(`LJk-q< zvvwrMY>;@9m#8dt4uAz5P;2=PrIrt$yDb-t0=)FP^*w$2VR2nvyS6IRgchs-yI_~7 z$*Tq3ZF!XY%5%H{D$u3V3V-e@@|`hh8xj(~g57E;Zf>gK(u;(sm8UF zpql7%B=7wGMOkdti~Vw6%*(k}+;T1a;|3qUtNTw>k}<)sh&F-H)c6CM1gq8Lz)+>{ zC^gfiN2}{nd^FKAcNegqx8WpX#x<5=M@g9J`Y{NJ@vV+N{ z{Z*-?p+3ij-zq4n^Psv0eMo09!4Ri)Qe#bYSg;MZZSR8{;ZR3it3v7P6qz_weW{>J zLlMpmDc?aTA07#avsmOZN8^$>fCn`+X#;d_;Og^mO>LQyn@ABrW=kcUp(HbnY-`Ik z6QhoKC}H|@XF7og!?^}6DAD1j_92w*n8d{+abxC3m=l#BSMbdv)_SCJ(X zZi%Qj?m9NVwo?Mk(EFSp=rEr%`<>N zGA-$WuoG#c=_J%?kPJ~lQlJB!EOX{12Q<_vw~^eX6rB0wpF&a?_3(c{Ny@Xq^zc*S z_tX(y9^$LtEiixTt+ljr)8TD;i@$ll;X4@A=Zdk`d_L;7mY$$mzt({1EY#4|6M#`E zX&1;!h>6SNxsCFW->TWoZ@~+aT>v4Uy(`f^_|PE&Q4pa8jQ!=>VZGjN8vC*0L3OqoW9Q7SZYP zCenbHCd*_XLz4DOMCOgxdx5PzaJ&TqoQOzt*RxncYP#VvKlj(;u^n&52O}tk6C_28 zB~qDOp;W0gTAitxdC7ees<|PA1G%_6LR#?hNDJ;2PK_Uf5_}#q!Y@{5M>3M05Pel{ z68%<4Yn>W0f+vPD_+mJMuY?8447imJejq zo)ubfztJl1kW{_G+rnm}yj|hcm<|+j5#bkevQn+v6`!W)xV2O$^gh(P$!7$vMSr>I{RmBfL)1M&}bHc*$6sH2c@APRvQM2Zgl!!N7SK z?q7J)C;3a@g6IV@FC-=e9i^=8V3kPSEdb2k@bOB~Glr}68zmfxNM$@~m}H{Y@R z(ysu3BIV{z7%+C)UAb&MEnc~`3t{4(`mz+_Iv8s;&&<-ASEZN3p=5Gs?Wo9_KLhIV ShUFV}-6>)H#fCW;s{jDST*{*W literal 6824 zcmV;Z8dv3aPew8T0RR9102-(O4*&oF05g~X02)sK0RR9100000000000000000000 z0000SR0dW6hFS<936^jX2nx3pu{jG&00A}vBm;pI1Rw>4O$UWC41oq4XD=6&T|1<} zc_6g^9JMl{T9iaoZ6?b8|NoYt#$jJv2{t3Gu+_VCS*4sSRr*d{aJo~=O42L07Pw4X z-!@_>inC?eXXU>!S68%GV0(X0oL-K8#~#{`DnAtiPz)c2;eiL!W#~iyi?x=u&l%i- zogOoGpu=~TBQ*9&?!C)zGn2`dWb<3;^re=ru%D9{f#f078ILd+cmDV0UeCGlZ9*w0 zjQom@KD+@U#}Ud3gEA7Zc!PB_-P-=) zqRLog!J?1pDzfV#$=$117Xh+o`XUA`v@fEas0{!DY;(ZPa4jXj#qm7+ee2x+0xr;m z+CjoVwuRF`+r_dxl4f?mv6*)+KS}v8K!t1h05I?D+-Cip+5VS$2s#xLR>V-x<^b%! zg|?K6(hjPb%^FA-AOq^||BWC8rKh4!QLC#)7dFk7_A`XY@jiHpIy5@<0qPDH=S&ZP zLPw8C9-ja|A=N>y7-YW0Eki}w;RnIwp?3i8u)BZD#z{2e6@7A#QZ=Rx3YqUBe+iZ7L zERo9O3Z+V|(dzUDqseTs+7MhErWc3c@3BG4BLPI1h!Us7IdMr`6Su@Y@kl%quf#j? zNqiH(M4U(xX(CJHi6T)ZszjY=5^bVO^ob!cCZ@!kSQ2aIc8P4_WR+9*qv>pk6#$>P zZ{G>P$v>FApV0dJpzZ>FM5)v|Bei#8ff2$5dI0&rUey7XNh1bA6pVI1UJJt zeQH}eVrS5~{_I7?XTw)Nmw5M6l_=7BZtc%xlu_5o>B`4Tldgl;P%-@*@45L$Y*s}dRf0BGTWG-omTrTsAh=Q@ zm1DyzGANH!v;hj8nuC8VC2`P2KZg23Y|;%mXzj7E<5mP{aC-xvR3n%eDy@s`5uIEu zFhnU2mq=z=nle5%28CCX&G4s1cg?Z(144fpc$AwVYW1j{c`+(sMJx>pwK6_Pjb#AD z9H7VJG`5t@1)6*0gBaT~h#*67Y!v@ks$4A?U_`!ys1!lHLO8kgh3h8FwNGyJhaSEy zzw#$H%bXDkM7u{&V9q-|I5rRq$6y3*%H*ziD`H&469t7wQGm;muU1}TO7kfC4ZBU6 zCZJeWH_kwhJsK4g`jFE=q&H{**`*DUgr^o&*Bg&wqG)Beo<16M$8@Jb1!~} z7LziQH<#~}NH6$q)w~FnF%(#@TE-nBB#})jdNYIhjXgiv-iz(otUb zl*-~By-T0uEhPoWNxNy? zC>?f5KB+UDYeXhA<|>MayD2^8K3f#YNf_xAL_Eg**Ky|2LkG(UoG50lOyV25z5Wzf zMbR+_pi3vBijv#l0+Av#>*32+*j6z&w!8=^;m%opI@!_lYFtYF8m*=jVY(}}?Q>m(bxffLlHB&*Z$@VRq5(x^(nk_H<#gEc-?>Vt?vfsF`#n~xQJXrswwA| zS7{ZQ6}xR2-?&I(`e!S);Zo~E*?ZTD^EsoP9{wkKhDT|qA?2pqx^6_(b0x4R_5r~} z$Nh6fb4`Q*Sc0rEu$cmQWQ&2_Sc2>^aF_zdkRt|8V+nG`z-0>HkShjm zV+nG{z+(#FlP3mVV+r!cz-J0zlP?B-V+kT+R!JZQv5@cN;(S0MJg9l7$3y^vmZ1qj z57J-+X=x^O2UeH?JIH_&WWWtF;DuT6gDeC=7Q!HVxCjkxtGv*gBApj&OL31z=GMKG z_%Hzw|NrOmuCJwJTq`k?;xD> z*bEc4Mvt#k7cQt?GOKQ7Db%PQ8_>%fJ1ffiu9mxoQ|HGhJFyz_cu3yUHW8h}hmU-u z=@RetOa21d<4SsCBj*0W(OkcEdI0Zr9Q^1XZ2T_=7C5-r#I3A-`O&Pw1A6{L2 zt?qA}t2sy`ER{d>OZD3Rs>l<)R6FOQ%TDxEtvK0BO&m1AiH)y3*+aQ+mfCp|&P6&(LCFFV##wR<}1IOaAI$Yqo1WhI%C4k#)9U=?&4yQWH~l8Y*K zu=9@Vtno8EGm{h7S z7|*@XA9$$;J1zs0W}$WtXpPmi|JD~lowmmy5+`IB0=2YR>dAR2*W(8C}G?n`5A z0=*QVQL0nu`-;#CaY3iC{Fp=sSxC2L8&WxUTNSe$Qbd}Fu$;aJ4hqEFy&mW!=mlWQ z{ogb5_gCXPX6BsS{h${NU?o#}UtZvQb*1^isg#T2byqb0nSmtewBH{5nrYBL%1{e_ zAJk9dxdB|B+Xev?2bG{2!09G%0jThfZ{GDxBXl0d_Y2zn`B`>HmFY>*Q?-H=p~jG| z^=L?m2WyY>TMv33ylNMz4*}pkKX=o_nAc7t=cD`iYg6?&a91`HjH%m-^;4pSoK}q$ zv2cZRt+9EbYxNb%0agb8qmLu5rS=+DS8BBXHCV}p8p9+^9zFd7Ag=M+d;O0ue*irI zyoMPF{*d*duGNP^eE#YA$wue;13&eD^R7m4Q9fRo%bvInja&b<|Lwnx5|Rovm_oh8 zUn*s|n%Y@N*B*?fOG#*>5wBCNKu1c!@yiIkm9th&OgcJ3b^vu-Eokoi*ELdgMX5_s zr}`jx@S};UtH5%0b%YJJr7WRjD@$WS)r=vACU947mcX^hf5%oIUSq)EYgaGCYdb== z5zFPMy)&U3O{WTRYB1xd>*>c_<&^Jv0*70^aU7=LQC7 zE#IWAtpPlYg%rz9XdKM+vvo6zG$7M%n59{qA(weO8J}*-01RsRpuk2q!(91ua zICAB3VOD3Sg>~}y+2hAEIy*0+%U2dBRHc0Xj+7;OLM01Q77Eb-NyT6OKs-~cm&yw( zmz~Mr;hCR}{JycjS0QhIJUl7PMoLNjG|7z>=ybDAa(sF7YazNf_8urAS>3*Sd_p!c z8HVVZPdLTGG=fsiA39XcR}#`r2L8%aDa&BiY+sjOM^nT%cv6O*sKP1*vKdT>HDs&b zy!8-=FbWu-)SRI(yVN{)5rYAT2>KWTcuEn&O~jKqp9+ZBvoUR;(rR5niK39e%uQQK zV2zA41YM}IQBgQb3F2W%VYUx7DSt{Tli8M{%tzD2tw!j~kuF}2bmmO41mJZEuVa*@ zqbVXmIsN?Hf9shhzg*eWsq$QawKm3f)`ePXz|Ja*iVhQ81emT5w3MdvG-j9bT-tKC zw4b{*yIa;vd*79bsarMZThwDiZT7dw+Y)z3?o^pJlA$qFtdHR6cPQ(QM#u5Pn}29PV4V47K_V* zmL}a66CA32Ge?+4luc{Vu;Xj359Q|tdKlJ=V6zC;!z4aEXSz%_6C$Ag zz20tWZBL}iab*?&NlzO;k>w-^YWUn5UV(G&IKNTSrP}gx6~E#xKPr%UXO&)JPdOd0z>f`QSs|ScN@Mb875?dS z=sEIbv@j5!$j91n+&u@toRTs?l6KzV=$hg4NP*4tB_hqC107W>WCW}B5zl>#Bq(2*gC=gFf^ z7#*&skML)^k5ivMUVXoIJ$a0G|8k>mnO`N;UcRgqRyM~kfIaVWcB2Tk1KCAvaW}QM z_ib+L)F0ia*ZJ9|pIrdK)|A%GbP&qHxwZQxXZ9TQT zx>^N2J+=)e$@CUxvo=O(+3+#U)#o=?4g;~cs8N?Ngjg&gs8i}?w<}E`r)x7YCl}uB<^a1D zA5IEJ3H}8~w+uIEOFL%1CyXJGLZC9BZmL@I0RRnLLONzhPBhz#xn9B_QKpCyn>v~$ zN~z|kO7(6x@3dw+v$L%Qnq@7SPWw`QUl>&oX~_^SD}ho+S)y*3R*#RE4OKiYpbIE; z5)C+27XLtv*}LMs#&-2~(ce9Dw?<-ToS^i<_SqXJVpH$)3j{a=2?+25c5QjwFE6W$ zTuzAR`@&niUyXT> zd9$vkV_mAP-uioodq=)I%qU=L8xZ{E6ws+t#auw~ZpYzohFw1xCQS-tWDg@~7@UA6 zgnG{YQ)p=~*ek{ZV;|5+smv`8g$UBl0S>FeZCE}4NQ7ssFxubaSrY%>)|F|}=Qi@^ z-+5}UiuIr4@&!Cv;j8@ded2g8`eP{_Y6rcCHB4A83se+^te{{hR|xl*BElCn51-7? zaN4Sf**|DiVL|v;_-E3l*Ht@4JGzF#()#ZBzqcErv47vwhZ+vep^AxqgHeoYkUs$t z%mBz70(p1HL=v1=8}epboZ$a7iB+aErM9l#H<(5d)Tmp>j}W9U!eaw8(m;l4ii7H0 zLPu<%%?hp6?F`b&eXxqo>2>v3)G(l|%Swx@PN!2;A4@x;P~Tu~n!5 z!w8lyjMOPqxd4@u?U*x6F+FS@-y0v_jgBBE3OEe@4WjZZ5O87%Q?)6~bPhFrcgTz) zIUhFUH{arf0|XlE`{Ys~<(wfS-Q51+@cr4Qu;jH-hN8G~IiF2z-OlI|ha%3p2WAKQ zftGDr!23pqfnb0`6-AlBT-U5&z+#1T&lxg(0Z*SC41;0@9M8fgY6$lC5BGP{GMqx3 zJY6V=%63iNsgWm_$ijL6Ft&>f%@qRXVJkT4Q@Fzl-eec0!!bYPz8?-#CY#Z;)y`_9 z^ygsVZ)c#78zw5IL#r@Za;TuDm_C!DIg;NJ?w!9qo<|Yy+2d1=nvCnJETZfzjKDy; z^1qIj+Dv|h7~os{G<8#?9BKsw$JHNm^wh+<9+e3yycvfyQdy5mwlb)ENDkvfR zkOzJ!K6=Jb!%6AT0sk`EomMQY%1|rZMb`F0LWLFh5h;>WWXb}PGC5?D`&@v&$-K5W z)F_e?;NSpfC$S8pv=W?Au)`p1=l+J3DIk zi}EO7U&y#2{=yNSQjaPuXRaHyUUF(fK1(Uwkfk>G9a+EM+2>iP*a)V#(7~G?Nk&bXC!4`~d?o}3oV;+W4^&sR#tm4g{q+?pdr58C4-Nfvg z!3d+fkm<#TBqWt`yn);v~$f zq-ok3fCh9~Xh)eXq$I#taLB|HUm!W;Q_paYg zCGi@-_wCU4Jh7|s4w*%+l`6lagP#vC3X5kU->gFsB@hS8xFjJBgM#gFyN?|zo;PaO zHY$|9PLZ)gPzhZbig0E~#{}m0$uR9J=ON+{Vra0h2lfO{W;87Dnc??*nET^5^Hagr z9{_-VV&#t2Q*L~IC~yc^R*^pmSfoP$dv`=#{8#CZ0j#O3<|h|Lj*3-d>y4%oSR8RT z9x&JD9jLg|LDCa0q|lhN3Qans#*AAk^sz&^#8A<8S+cEBO%^`Wn(v_P3F#1{WLz=C zHPRxq4ayBJt-?!Q5aa7xOutoDRVR%K)D z;+RDVvGJ?Du6C}iu^JLyj0`&2T%rolM98W8>S`CZ*@DaXQ)51L@JXjlq$7GtJ52dCbPwAvpWiEAiG?_ zA~80w;?#XQNOj=nG!omQ&uk}=sb*O*B(il? z#{qFBhys5to1itT$ezvK*;Vzz3VlAQR+nxO*b*^)*`&x5?oujSFBTPlG1I z@WaZo8w7>969v@+iD0)JDp+I^)^}MOiLrr&qGz-!i{o*8)Z5=3I`aQm>jxJWhz7IH z(keCj3lwQY%bE4mDCro1uWgb8SiP?hr-#;516E7-g+&#bR^rX-iY)Ry9oQ13(^CUT zT_8=*8mZz}Z_bG;x?7f@Hc|CFS(x{){>b=zG1ybk*8>0?f8Yz^w-Edu^^l@jy4`|2 zN0E0if55gH1O4K-5l~;~?Ulm-RSt^dvDjOI@%^+}Lru@~Sqle6c-FDEI5@Ry@e8Uk W=A+bnTZ@66>2Cg+p3T1tFb3!)8PiAr diff --git a/frontend/src/assets/style.scss b/frontend/src/assets/style.scss index ec1528e..8d5bd00 100644 --- a/frontend/src/assets/style.scss +++ b/frontend/src/assets/style.scss @@ -92,7 +92,17 @@ section { } .box { - box-shadow: 0 0 2px $grey-lighter; + background: $white-bis; + box-shadow: 2px 2px 5px $white-ter; + border: 1px solid $grey-lightest; + + hr { + background-color: #efefef; + } +} + +.page-header { + min-height: 60px; } /* Two column sidebar+body layout */ @@ -323,7 +333,7 @@ section { /* Tabs */ .b-tabs .tab-content { - padding-top: 2rem; + padding-top: 3rem; } /* Tags */ @@ -449,6 +459,12 @@ section.lists { } } +.bounces { + pre { + padding: 5px 10px; + } +} + /* Import page */ section.import { .delimiter input { diff --git a/frontend/src/constants.js b/frontend/src/constants.js index 6f7bdec..4d23c82 100644 --- a/frontend/src/constants.js +++ b/frontend/src/constants.js @@ -7,6 +7,7 @@ export const models = Object.freeze({ campaigns: 'campaigns', templates: 'templates', media: 'media', + bounces: 'bounces', settings: 'settings', logs: 'logs', }); diff --git a/frontend/src/router/index.js b/frontend/src/router/index.js index e19437a..724a282 100644 --- a/frontend/src/router/index.js +++ b/frontend/src/router/index.js @@ -35,6 +35,12 @@ const routes = [ meta: { title: 'Import subscribers', group: 'subscribers' }, component: () => import(/* webpackChunkName: "main" */ '../views/Import.vue'), }, + { + path: '/subscribers/bounces', + name: 'bounces', + meta: { title: 'Bounces', group: 'subscribers' }, + component: () => import(/* webpackChunkName: "main" */ '../views/Bounces.vue'), + }, { path: '/subscribers/lists/:listID', name: 'subscribers_list', diff --git a/frontend/src/views/Bounces.vue b/frontend/src/views/Bounces.vue new file mode 100644 index 0000000..5ed039f --- /dev/null +++ b/frontend/src/views/Bounces.vue @@ -0,0 +1,196 @@ + + + diff --git a/frontend/src/views/Campaigns.vue b/frontend/src/views/Campaigns.vue index 52cdec2..47575f8 100644 --- a/frontend/src/views/Campaigns.vue +++ b/frontend/src/views/Campaigns.vue @@ -117,6 +117,12 @@ {{ stats.sent }} / {{ stats.toSend }}

+

+ + + {{ props.row.bounces }} + +

diff --git a/frontend/src/views/Settings.vue b/frontend/src/views/Settings.vue index 5697f8f..7c64b60 100644 --- a/frontend/src/views/Settings.vue +++ b/frontend/src/views/Settings.vue @@ -433,6 +433,173 @@ + +

+
+ + + +
+
+ + + +
+
+ + + + + + +
+
+ + + + + + + + + + +
@@ -583,6 +750,10 @@ export default Vue.extend({ this.form.smtp.splice(i, 1); }, + removeBounceBox(i) { + this.form['bounce.mailboxes'].splice(i, 1); + }, + showSMTPHeaders(i) { const s = this.form.smtp[i]; s.showHeaders = true; @@ -615,7 +786,7 @@ export default Vue.extend({ onSubmit() { const form = JSON.parse(JSON.stringify(this.form)); - // De-serialize custom e-mail headers. + // SMTP boxes. for (let i = 0; i < form.smtp.length; i += 1) { // If it's the dummy UI password placeholder, ignore it. if (form.smtp[i].password === dummyPassword) { @@ -629,10 +800,22 @@ export default Vue.extend({ } } + // Bounces boxes. + for (let i = 0; i < form['bounce.mailboxes'].length; i += 1) { + // If it's the dummy UI password placeholder, ignore it. + if (form['bounce.mailboxes'][i].password === dummyPassword) { + form['bounce.mailboxes'][i].password = ''; + } + } + if (form['upload.s3.aws_secret_access_key'] === dummyPassword) { form['upload.s3.aws_secret_access_key'] = ''; } + if (form['bounce.sendgrid_key'] === dummyPassword) { + form['bounce.sendgrid_key'] = ''; + } + for (let i = 0; i < form.messengers.length; i += 1) { // If it's the dummy UI password placeholder, ignore it. if (form.messengers[i].password === dummyPassword) { @@ -680,6 +863,12 @@ export default Vue.extend({ d.smtp[i].password = dummyPassword; } + for (let i = 0; i < d['bounce.mailboxes'].length; i += 1) { + // The backend doesn't send passwords, so add a dummy so that + // the password looks filled on the UI. + d['bounce.mailboxes'][i].password = dummyPassword; + } + for (let i = 0; i < d.messengers.length; i += 1) { // The backend doesn't send passwords, so add a dummy so that it // the password looks filled on the UI. @@ -689,6 +878,7 @@ export default Vue.extend({ if (d['upload.provider'] === 's3') { d['upload.s3.aws_secret_access_key'] = dummyPassword; } + d['bounce.sendgrid_key'] = dummyPassword; this.form = d; this.formCopy = JSON.stringify(d); diff --git a/frontend/src/views/SubscriberForm.vue b/frontend/src/views/SubscriberForm.vue index 62a3d89..7cd3241 100644 --- a/frontend/src/views/SubscriberForm.vue +++ b/frontend/src/views/SubscriberForm.vue @@ -2,7 +2,6 @@
- {{ data.status }}

{{ data.name }}

{{ $t('subscribers.newSubscriber') }}

@@ -12,25 +11,31 @@ {{ $t('globals.fields.uuid') }}: {{ data.uuid }}

+
- - - - - - - - - - +
+
+ + + +
+
+ + + + + + +
+
- + - - {{ $t('globals.buttons.learnMore') }} . - + +
+ + + {{ $t('bounces.view') }} ({{ bounces.length }}) + + + + {{ $t('globals.buttons.delete') }} + + +
+
    +
  1. +
    + + {{ b.campaign.name }} + +
    + {{ $utils.niceDate(b.createdAt, true) }} + + + {{ b.source }} + + + + + 
    {{ b.meta }}
    +
    2. +
+
+
{{ $t('globals.buttons.close') }} @@ -82,12 +123,45 @@ export default Vue.extend({ // Binds form input values. This is populated by subscriber props passed // from the parent component in mounted(). form: { lists: [], strAttribs: '{}' }, + isBounceVisible: false, + bounces: [], + visibleMeta: {}, egAttribs: '{"job": "developer", "location": "Mars", "has_rocket": true}', }; }, methods: { + toggleBounces() { + this.isBounceVisible = !this.isBounceVisible; + }, + + toggleMeta(id) { + let v = false; + if (!this.visibleMeta[id]) { + v = true; + } + Vue.set(this.visibleMeta, id, v); + }, + + deleteBounces(sub) { + this.$utils.confirm( + null, + () => { + this.$api.deleteSubscriberBounces(this.form.id).then(() => { + this.getBounces(); + this.$utils.toast(this.$t('globals.messages.deleted', { name: sub.name })); + }); + }, + ); + }, + + getBounces() { + this.$api.getSubscriberBounces(this.form.id).then((data) => { + this.bounces = data; + }); + }, + onSubmit() { if (this.isEditing) { this.updateSubscriber(); @@ -183,6 +257,11 @@ export default Vue.extend({ }; } + if (this.form.id) { + this.getBounces(); + } + + this.$nextTick(() => { this.$refs.focus.focus(); }); diff --git a/frontend/src/views/Subscribers.vue b/frontend/src/views/Subscribers.vue index 6596c88..acb83cd 100644 --- a/frontend/src/views/Subscribers.vue +++ b/frontend/src/views/Subscribers.vue @@ -198,7 +198,8 @@ - + @@ -309,6 +310,12 @@ export default Vue.extend({ this.isBulkListFormVisible = true; }, + onFormClose() { + if (this.$route.params.id) { + this.$router.push({ name: 'subscribers' }); + } + }, + onPageChange(p) { this.queryParams.page = p; this.querySubscribers(); @@ -472,8 +479,14 @@ export default Vue.extend({ this.queryParams.listID = parseInt(this.$route.params.listID, 10); } - // Get subscribers on load. - this.querySubscribers(); + if (this.$route.params.id) { + this.$api.getSubscriber(parseInt(this.$route.params.id, 10)).then((data) => { + this.showEditForm(data); + }); + } else { + // Get subscribers on load. + this.querySubscribers(); + } }, }); diff --git a/go.mod b/go.mod index daf32c2..472c48b 100644 --- a/go.mod +++ b/go.mod @@ -8,6 +8,7 @@ require ( github.com/disintegration/imaging v1.6.2 github.com/gofrs/uuid v3.2.0+incompatible github.com/jmoiron/sqlx v1.2.0 + github.com/knadh/go-pop3 v0.1.0 github.com/knadh/goyesql/v2 v2.1.1 github.com/knadh/koanf v0.12.0 github.com/knadh/smtppool v0.2.1 diff --git a/go.sum b/go.sum index 69cab48..cfc74ec 100644 --- a/go.sum +++ b/go.sum @@ -13,6 +13,10 @@ github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumC github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c= github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4= +github.com/emersion/go-message v0.15.0 h1:urgKGqt2JAc9NFJcgncQcohHdiYb803YTH9OQwHBHIY= +github.com/emersion/go-message v0.15.0/go.mod h1:wQUEfE+38+7EW8p8aZ96ptg6bAb1iwdgej19uXASlE4= +github.com/emersion/go-textwrapper v0.0.0-20200911093747-65d896831594 h1:IbFBtwoTQyw0fIM5xv1HF+Y+3ZijDR839WMulgxCcUY= +github.com/emersion/go-textwrapper v0.0.0-20200911093747-65d896831594/go.mod h1:aqO8z8wPrjkscevZJFVE1wXJrLpC5LtJG7fqLOsPb2U= github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M= github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= @@ -33,6 +37,8 @@ github.com/jmoiron/sqlx v1.2.0 h1:41Ip0zITnmWNR/vHV+S4m+VoUivnWY5E4OJfLZjCJMA= github.com/jmoiron/sqlx v1.2.0/go.mod h1:1FEQNm3xlJgrMD+FBdI9+xvCksHtbpVBBw5dYhBSsks= github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY= github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y= +github.com/knadh/go-pop3 v0.1.0 h1:MECWomq2uEGeuR7O2TjfzD63H47UFLKOqH1bSH7yhRU= +github.com/knadh/go-pop3 v0.1.0/go.mod h1:a5kUJzrBB6kec+tNJl+3Z64ROgByKBdcyub+mhZMAfI= github.com/knadh/goyesql v2.0.0+incompatible h1:hJFJrU8kaiLmvYt9I/1k1AB7q+qRhHs/afzTfQ3eGqk= github.com/knadh/goyesql v2.0.0+incompatible/go.mod h1:W0tSzU8l7lYH1Fihj+bdQzkzOwvirrsMNHwkuY22qoY= github.com/knadh/goyesql/v2 v2.1.1 h1:Orp5ldaxPM4ozKHfu1m7p6iolJFXDGOpF3/jyOgO6ls= @@ -117,8 +123,9 @@ golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20200331124033-c3d80250170d h1:nc5K6ox/4lTFbMVSL9WRR81ixkcwXThoiF6yf+R9scA= golang.org/x/sys v0.0.0-20200331124033-c3d80250170d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/i18n/en.json b/i18n/en.json index 491e254..068fe21 100644 --- a/i18n/en.json +++ b/i18n/en.json @@ -105,6 +105,7 @@ "globals.buttons.close": "Close", "globals.buttons.continue": "Continue", "globals.buttons.delete": "Delete", + "globals.buttons.deleteAll": "Delete all", "globals.buttons.edit": "Edit", "globals.buttons.enabled": "Enabled", "globals.buttons.learnMore": "Learn more", @@ -130,14 +131,17 @@ "globals.messages.confirm": "Are you sure?", "globals.messages.created": "\"{name}\" created", "globals.messages.deleted": "\"{name}\" deleted", + "globals.messages.deletedCount": "{name} ({num}) deleted", "globals.messages.emptyState": "Nothing here", + "globals.messages.invalidData": "Invalid data", + "globals.messages.internalError": "Internal server error", "globals.messages.errorCreating": "Error creating {name}: {error}", "globals.messages.errorDeleting": "Error deleting {name}: {error}", "globals.messages.errorFetching": "Error fetching {name}: {error}", "globals.messages.errorUUID": "Error generating UUID: {error}", "globals.messages.errorUpdating": "Error updating {name}: {error}", - "globals.messages.invalidID": "Invalid ID", - "globals.messages.invalidUUID": "Invalid UUID", + "globals.messages.invalidID": "Invalid ID(s)", + "globals.messages.invalidUUID": "Invalid UUID(s)", "globals.messages.notFound": "{name} not found", "globals.messages.passwordChange": "Enter a value to change", "globals.messages.updated": "\"{name}\" updated", @@ -164,6 +168,8 @@ "globals.terms.settings": "Settings", "globals.terms.subscriber": "Subscriber | Subscribers", "globals.terms.subscribers": "Subscribers", + "globals.terms.bounce": "Bounce | Bounces", + "globals.terms.bounces": "Bounces", "globals.terms.tag": "Tag | Tags", "globals.terms.tags": "Tags", "globals.terms.template": "Template | Templates", @@ -274,6 +280,21 @@ "public.unsubbedInfo": "You have unsubscribed successfully.", "public.unsubbedTitle": "Unsubscribed", "public.unsubscribeTitle": "Unsubscribe from mailing list", + "bounces.unknownService": "Unknown service.", + "bounces.view": "View bounces", + "bounces.source": "Source", + "settings.bounces.name": "Bounces", + "settings.bounces.enable": "Enable bounce processing", + "settings.bounces.enableMailbox": "Enable bounce mailbox", + "settings.bounces.enableWebhooks": "Enable bounce webhooks", + "settings.bounces.count": "Bounce count", + "settings.bounces.countHelp": "Number of bounces per subscriber", + "settings.bounces.action": "Action", + "settings.bounces.blocklist": "Blocklist", + "settings.bounces.folder": "Folder", + "settings.bounces.folderHelp": "Name of the IMAP folder to scan. Eg: Inbox.", + "settings.bounces.delete": "Delete", + "settings.bounces.invalidScanInterval": "Bounce scan interval should be minimum 1 minute.", "settings.confirmRestart": "Ensure running campaigns are paused. Restart?", "settings.duplicateMessengerName": "Duplicate messenger name: {name}", "settings.errorEncoding": "Error encoding settings: {error}", @@ -366,7 +387,7 @@ "settings.smtp.idleTimeout": "Idle timeout", "settings.smtp.idleTimeoutHelp": "Time to wait for new activity on a connection before closing it and removing it from the pool (s for second, m for minute).", "settings.smtp.maxConns": "Max. connections", - "settings.smtp.maxConnsHelp": "Maximum concurrent connections to the SMTP server.", + "settings.smtp.maxConnsHelp": "Maximum concurrent connections to the server.", "settings.smtp.name": "SMTP", "settings.smtp.password": "Password", "settings.smtp.passwordHelp": "Enter to change", @@ -382,6 +403,25 @@ "settings.smtp.username": "Username", "settings.smtp.waitTimeout": "Wait timeout", "settings.smtp.waitTimeoutHelp": "Time to wait for new activity on a connection before closing it and removing it from the pool (s for second, m for minute).", + "settings.bounces.authProtocol": "Auth protocol", + "settings.bounces.type": "Type", + "settings.bounces.enabled": "Enabled", + "settings.bounces.host": "Host", + "settings.bounces.hostHelp": "Mail server's host address.", + "settings.bounces.scanInterval": "Scan interval", + "settings.bounces.scanIntervalHelp": "Interval at which the bounce mailbox should be scanned for bounces (s for second, m for minute).", + "settings.bounces.password": "Password", + "settings.bounces.passwordHelp": "Enter to change", + "settings.bounces.port": "Port", + "settings.bounces.portHelp": "Mail server's port.", + "settings.bounces.skipTLS": "Skip TLS verification", + "settings.bounces.skipTLSHelp": "Skip hostname check on the TLS certificate.", + "settings.bounces.tls": "TLS", + "settings.bounces.tlsHelp": "Enable STARTTLS.", + "settings.bounces.username": "Username", + "settings.bounces.enableSES": "Enable SES", + "settings.bounces.enableSendgrid": "Enable SendGrid", + "settings.bounces.sendgridKey": "SendGrid Key", "settings.title": "Settings", "settings.updateAvailable": "A new update {version} is available.", "subscribers.advancedQuery": "Advanced", diff --git a/internal/bounce/bounce.go b/internal/bounce/bounce.go new file mode 100644 index 0000000..c197a5b --- /dev/null +++ b/internal/bounce/bounce.go @@ -0,0 +1,148 @@ +package bounce + +import ( + "errors" + "log" + "time" + + "github.com/jmoiron/sqlx" + "github.com/knadh/listmonk/internal/bounce/mailbox" + "github.com/knadh/listmonk/internal/bounce/webhooks" + "github.com/knadh/listmonk/models" + "github.com/lib/pq" +) + +const ( + // subID is the identifying subscriber ID header to look for in + // bounced e-mails. + subID = "X-Listmonk-Subscriber" + campID = "X-Listmonk-Campaign" +) + +// Mailbox represents a POP/IMAP mailbox client that can scan messages and pass +// them to a given channel. +type Mailbox interface { + Scan(limit int, ch chan models.Bounce) error +} + +// Opt represents bounce processing options. +type Opt struct { + BounceCount int `json:"count"` + BounceAction string `json:"action"` + + MailboxEnabled bool `json:"mailbox_enabled"` + MailboxType string `json:"mailbox_type"` + Mailbox mailbox.Opt `json:"mailbox"` + WebhooksEnabled bool `json:"webhooks_enabled"` + SESEnabled bool `json:"ses_enabled"` + SendgridEnabled bool `json:"sendgrid_enabled"` + SendgridKey string `json:"sendgrid_key"` +} + +// Manager handles e-mail bounces. +type Manager struct { + queue chan models.Bounce + mailbox Mailbox + SES *webhooks.SES + Sendgrid *webhooks.Sendgrid + queries *Queries + opt Opt + log *log.Logger +} + +// Queries contains the queries. +type Queries struct { + DB *sqlx.DB + RecordQuery *sqlx.Stmt +} + +// New returns a new instance of the bounce manager. +func New(opt Opt, q *Queries, lo *log.Logger) (*Manager, error) { + m := &Manager{ + opt: opt, + queries: q, + queue: make(chan models.Bounce, 1000), + log: lo, + } + + // Is there a mailbox? + if opt.MailboxEnabled { + switch opt.MailboxType { + case "pop": + m.mailbox = mailbox.NewPOP(opt.Mailbox) + case "imap": + default: + return nil, errors.New("unknown bounce mailbox type") + } + } + + if opt.WebhooksEnabled { + if opt.SESEnabled { + m.SES = webhooks.NewSES() + } + if opt.SendgridEnabled { + sg, err := webhooks.NewSendgrid(opt.SendgridKey) + if err != nil { + lo.Printf("error initializing sendgrid webhooks: %v", err) + } else { + m.Sendgrid = sg + } + } + } + + return m, nil +} + +// Run is a blocking function that listens for bounce events from webhooks and or mailboxes +// and executes them on the DB. +func (m *Manager) Run() { + if m.opt.MailboxEnabled { + go m.runMailboxScanner() + } + + for { + select { + case b, ok := <-m.queue: + if !ok { + return + } + + _, err := m.queries.RecordQuery.Exec(b.SubscriberUUID, + b.Email, + b.CampaignUUID, + b.Type, + b.Source, + b.Meta, + b.CreatedAt, + m.opt.BounceCount, + m.opt.BounceAction) + if err != nil { + // Ignore the error if it complained of no subscriber. + if pqErr, ok := err.(*pq.Error); ok && pqErr.Column == "subscriber_id" { + m.log.Printf("bounced subscriber (%s / %s) not found", b.SubscriberUUID, b.Email) + continue + } + m.log.Printf("error recording bounce: %v", err) + } + } + } +} + +// runMailboxScanner runs a blocking loop that scans the mailbox at given intervals. +func (m *Manager) runMailboxScanner() { + for { + if err := m.mailbox.Scan(1000, m.queue); err != nil { + m.log.Printf("error scanning bounce mailbox: %v", err) + } + + time.Sleep(m.opt.Mailbox.ScanInterval) + } +} + +// Record records a new bounce event given the subscriber's email or UUID. +func (m *Manager) Record(b models.Bounce) error { + select { + case m.queue <- b: + } + return nil +} diff --git a/internal/bounce/gmail.bounce b/internal/bounce/gmail.bounce new file mode 100644 index 0000000..92a7837 --- /dev/null +++ b/internal/bounce/gmail.bounce @@ -0,0 +1,257 @@ +Delivered-To: kailash@zerodha.com +Received: by 2002:a54:21c4:0:0:0:0:0 with SMTP id i4csp2867282eco; + Sun, 23 May 2021 10:33:16 -0700 (PDT) +X-Received: by 2002:a17:902:bb87:b029:ef:1ef:b4a5 with SMTP id m7-20020a170902bb87b02900ef01efb4a5mr21801783pls.28.1621791195832; + Sun, 23 May 2021 10:33:15 -0700 (PDT) +ARC-Seal: i=1; a=rsa-sha256; t=1621791195; cv=none; + d=google.com; s=arc-20160816; + b=xZixRTOHnpK7AKFJqDRGvXg8csiC/HDweapqiROpH9f3CBKOp2bNxesRYQAhF9dRER + TcIdmsNBWmAsM3UCrKP1gsafEEhLa/egWet5tS7eRVNtrlf4xIr/Oyizzi/+vWTaYBaj + SYS6ig0kEx1TIu23fhipMkjmqpba1CvekFt0Sujn51Wl/pCbxQLwXUUG+F2NlOZFnMNy + GkxHgi+2lRqeowzPxMaUxat6yD0uym7V0TephJhTPTekZzIrXHQTd1T023qyvfUjdLU9 + HtXjkqJpJ2NIsHwhLTDqC860/dJMpKhMt6ekH5wK7ooXyXylOIeE9z9grYVVX7esWGgv + M7Tw== +ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; + h=in-reply-to:references:subject:from:date:message-id:auto-submitted + :to:dkim-signature; + bh=N5pKD3v8h0to825sNHx1obZB8CFEVlHQ1rrjBil1NtM=; + b=XNDLUAQC40qw4KX91RFgUOKWbgdsyQz86pvi7wENg/xBasGRJJjyZgBTYyA2e8XUN4 + 3pbUZG68HsGI1bAE/t5HefjTmHRtoSh/nZzMVk+hoHbeFPtMcOo9sDWhcWnZjfFE2tzU + lEDFV1M1NeKf8JcW+nm7Sq6haAv/M7C9q++kQxt0P6GnU17IOb5DyeUQ9SRVa1mTgjZt + TuL94m2a7N6/KkHRrQCVyd1SZJR4+JDhFbdoScc0GXmu+aCt0DlznymAiLRX6SLB/sbx + B4Aj9luupUg/9yzy0JCZ9qhjY3w+36mcz9EnIuA6TJP1AmBUFiVHVXjLTz8FKhKP/TcN + Szrw== +ARC-Authentication-Results: i=1; mx.google.com; + dkim=pass header.i=@googlemail.com header.s=20161025 header.b="d/j1xe99"; + spf=pass (google.com: best guess record for domain of postmaster@mail-sor-f69.google.com designates 209.85.220.69 as permitted sender) smtp.helo=mail-sor-f69.google.com; + dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=googlemail.com +Return-Path: <> +Received: from mail-sor-f69.google.com (mail-sor-f69.google.com. [209.85.220.69]) + by mx.google.com with SMTPS id x9sor5739157pjh.37.2021.05.23.10.33.15 + for + (Google Transport Security); + Sun, 23 May 2021 10:33:15 -0700 (PDT) +Received-SPF: pass (google.com: best guess record for domain of postmaster@mail-sor-f69.google.com designates 209.85.220.69 as permitted sender) client-ip=209.85.220.69; +Authentication-Results: mx.google.com; + dkim=pass header.i=@googlemail.com header.s=20161025 header.b="d/j1xe99"; + spf=pass (google.com: best guess record for domain of postmaster@mail-sor-f69.google.com designates 209.85.220.69 as permitted sender) smtp.helo=mail-sor-f69.google.com; + dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=googlemail.com +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=googlemail.com; s=20161025; + h=to:auto-submitted:message-id:date:from:subject:references + :in-reply-to; + bh=N5pKD3v8h0to825sNHx1obZB8CFEVlHQ1rrjBil1NtM=; + b=d/j1xe99m2/tEFKHFbaxWYQDypZPPXM4yaLLXfv78vQTkusHx6ezzjbbLDQThRi4Gp + icphSZc7bxQqNICr6VHhbaFiywhQUwKRd4Atrv6pFO2pRJAPUX0U9NOK1ktRNsd5ePUA + sIHIwA346yYp2mVsjzKaoAO6hmKG9wota8RYPKE2n3zHQPKdv+TzM9C/r1ddBrcyd92f + tQeM0ySxXyPoQBvHmBhQyM02QcdB43GI7MqChsMM55FsyOAkzSyk2mpr/fR4WRFzqizB + soso7v4Fk4SGSL/YWirMBEYfV4lMC02as8s+C/T3cDCDSLSYevk9TzQZkJCesxGg9v7Y + oZsw== +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20161025; + h=x-gm-message-state:to:auto-submitted:message-id:date:from:subject + :references:in-reply-to; + bh=N5pKD3v8h0to825sNHx1obZB8CFEVlHQ1rrjBil1NtM=; + b=OrbtNPg5Os277o6RgpirMIAKmj2lOd2QCNP4GoWd587x5FG6IkDGS0FMlgqir4kd1m + onrouDFZ2YIfwYjes6UwVc/jRtFEqweNfW148Wwtr0da3N++Q722KoKaIlivsi6tRic5 + IpLG2R/AdMRHyqKgc+32sY5bFpxA8dvV8QzeSjMDOiEW6MDW+5EPZRvlmrQHcs3gltgw + fu24ZBvxO5p+SVA3fv4CHofWBx41eff1xDj3YeXBZC3UvycM3uDXPCccNSdGlFVdVj1k + ShVVBaMYe7ogQaE7NuBI2fTg+2Gwj8A1qaZWkqNa5WMsV+IBGn5X+9hGv5+a2oRBuML2 + VYhw== +X-Gm-Message-State: AOAM532KXW9W45VWVICwrMKyOmBmBlxCXVqvZLIyub147S7L81Y7Yop3 + eSoPXNYLWGr8Yfu3nAAx9bqznTMyYnI5amD+uBfPOw== +X-Google-Smtp-Source: ABdhPJyoLDp5/aV12uOu5ZlEUItHwuaalyHiLdxJo/DQjtVQnyFAt10Oz/cnjtoGwe2hdi+YlKG+Ouy2NlxgqA9gI9fMRnAyaqs9KtM= +X-Received: by 2002:a17:90b:30d0:: with SMTP id hi16mr20431437pjb.30.1621791195594; + Sun, 23 May 2021 10:33:15 -0700 (PDT) +Content-Type: multipart/report; boundary="0000000000001cf3b205c302b0a3"; report-type=delivery-status +To: kailash@zerodha.com +Received: by 2002:a17:90b:30d0:: with SMTP id hi16mr15665871pjb.30; Sun, 23 + May 2021 10:33:15 -0700 (PDT) +Return-Path: <> +Auto-Submitted: auto-replied +Message-ID: <60aa91db.1c69fb81.218cf.a9fa.GMR@mx.google.com> +Date: Sun, 23 May 2021 10:33:15 -0700 (PDT) +From: Mail Delivery Subsystem +Subject: Delivery Status Notification (Failure) +References: +In-Reply-To: +X-Failed-Recipients: psaodp2apsdoad9@zerodha.com + +--0000000000001cf3b205c302b0a3 +Content-Type: multipart/related; boundary="0000000000001cfdaa05c302b0a7" + +--0000000000001cfdaa05c302b0a7 +Content-Type: multipart/alternative; boundary="0000000000001cfdb405c302b0a8" + +--0000000000001cfdb405c302b0a8 +Content-Type: text/plain; charset="UTF-8" + + +** Address not found ** + +Your message wasn't delivered to psaodp2apsdoad9@zerodha.com because the address couldn't be found, or is unable to receive mail. + +Learn more here: https://support.google.com/mail/?p=NoSuchUser + +The response was: + +550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/?p=NoSuchUser j11sor9289118pjs.32 - gsmtp + +--0000000000001cfdb405c302b0a8 +Content-Type: text/html; charset="UTF-8" + + + + + + + + + + + + + + + + +--0000000000001cfdb405c302b0a8-- +--0000000000001cfdaa05c302b0a7 +Content-Type: image/png; name="icon.png" +Content-Disposition: attachment; filename="icon.png" +Content-Transfer-Encoding: base64 +Content-ID: + +iVBORw0KGgoAAAANSUhEUgAAAJAAAACQCAYAAADnRuK4AAAACXBIWXMAABYlAAAWJQFJUiTwAAAA +GXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAABTdJREFUeNrsnD9sFEcUh5+PRMqZ +yA0SPhAUQAQFUkyTgiBASARo6QApqVIkfdxGFJFSgGhJAUIiBaQB0ZIOKVCkwUgURjIg2fxL4kS+ +YDvkbC/388bi8N16Z4/d7J/5PsniuD3fyePP772ZeTsDQRAYQL/UGAJAIEAgQCBAIAAEAgQCBAIE +AkAgyJT3Mv+Eq7vYK8mTE+MDRCAghQECAeRQA5V2ZOpmg5vDx3NPzRbmGRMEcmTrEbNNB8zWfRD+ +f/Efs2e3zCZvMjaksBg27TfbcuSNPEKP9ZyuAQKtHX2O9ncNgWC57umMPKvRNb0GEKgnLoUyxTQC +rcns0/6uIRAs8/hGf9cQCJZpTpjdO2f25/03z+mxntM1eLtsZAgiUtX4JcaBCAQIBAgECARQ8CJa +G5jab4J4pm4WZmO3OALVh802fIwcLkyPkcKAGggAgQCBAIEAgQCBABAIEAjKA/1AnahhbO5FdOOY +VsrrDbPBYcYKgf5D2wLaV3p+22xh1u17tO3S+DTcvxvagUDeivPgx/a/95J/73w7Sj26Hn4pKo2M +ehuV/KyBJM6d0f7k6RKx/R63vvL2tmf/ItDdM2ZTP6f7nkp9Y2fDx1v9akmpIU+KSCLVUghUQfSL +zVKeTklbLxGoctw/nzC5rw8L5KRNbkpnKq6pgSqEClzNnFzY+XnYWrt6VpVk1vbwWvg+RKCKMOUw +Q1LEOXA+/MX3mpJvGDHb265xtnzmFoUK1HaKQGlMtePYM+q2KKjXuaS1NJYIEKgI8jhEgqHt4cqy +Ky53j3hyHz2bqSLp2o2LbJ7MxKovkGqXteoWpaOk96O9/yF/dF7NwlS36AuIQIBA5celQK4PIxBE +4LLzrtoLgaALdSy6CJRkWQCBPGLsTHznomZ9nszUECgJ2ml3WWHe+QVFNPSQx6UdZNtxr9pbEShN +eTTz8mQXHoHSlke7+Z+c9m6VGoHSkEfs/trLW3wQKApN1V3lGfnGu2Z6BFoLtYCs3GWBPAiUCLVh +/HoaeRCoT9R873KLM/IgUBfapnCpe5AHgXry4pf412ihEHkQqCdxd5VqrcezhUIESsJMTJ+Pdthp +Z0WgyNlXXPHc2Mc4IVAELl2Gnh8mhUDvCkfbIVAkcbf/aOoO3fMKhqAD3frTa4quwpn0hUDOkQhI +YYBAgECAQAAU0QlYObl+5Ug8NcprZkZxjUCxRPVA6zmtEXHCBykskrhjgHXN09PoEcgFl4M4H11j +nBAoApcj6ZoPGScEAgTKApcDoTw5sgWB+sGlz1n90IBAPdE6j1o21PfcC11jLagL1oFWRyGlKU3p +OxcSJQ7NZAjkhHp/uG2HFAYIBAgECASAQIBAgECAQAAIBOkxEARBtp9wdVfAMOfIifEBIhCQwgCB +ABAI0oV2jhxZ+nfBatuPZfgBCy0Eqqo8c01b+uu51XZvzOgDWoHNTGR+pCwpLEd5svuAZXlO2uEr +PyEQ8hRWHgRCHmqg0sjTnLalv6crJQ8C/U8stqNO0I4+VZOHFIY8COS1PGL2ybd5yUMKK7s8zYmL +dujyd3n+nESgcsvzZd4/KwIhDwIhT35QA6UyE1qyxZnfvJMHgdKS549JC1qvvJOHFIY8CFR5eV5O +XimqPAhUdHnmfx+zgxdOFXkoqIGKKs/cswnb/8Oeog8HEai48nxUhiFBIORBIOShBioskkbySCLk +IQIhDwIhj28p7FApR6b1qlEbHGpkO/rr6215vi/zH1r2x7tApSGFAQIBAgECAQIBIBAgECAQIBBA +LK8FGADCTxYrr+EVJgAAAABJRU5ErkJggg== +--0000000000001cfdaa05c302b0a7-- +--0000000000001cf3b205c302b0a3 +Content-Type: message/delivery-status + +Reporting-MTA: dns; googlemail.com +Received-From-MTA: dns; kailash@zerodha.com +Arrival-Date: Sun, 23 May 2021 10:33:14 -0700 (PDT) +X-Original-Message-ID: + +Final-Recipient: rfc822; psaodp2apsdoad9@zerodha.com +Action: failed +Status: 5.1.1 +Diagnostic-Code: smtp; 550-5.1.1 The email account that you tried to reach does not exist. Please try + 550-5.1.1 double-checking the recipient's email address for typos or + 550-5.1.1 unnecessary spaces. Learn more at + 550 5.1.1 https://support.google.com/mail/?p=NoSuchUser j11sor9289118pjs.32 - gsmtp +Last-Attempt-Date: Sun, 23 May 2021 10:33:15 -0700 (PDT) + +--0000000000001cf3b205c302b0a3 +Content-Type: message/rfc822 + +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=zerodha.com; s=google; + h=to:from:subject:message-id:date:user-agent:mime-version + :content-language:content-transfer-encoding; + bh=lzgCIA1dMfq+1Zoi8Mtush+Jqj/mDmwC2uBHfa8ybDc=; + b=OI+HpFZBSgaEofYQU9PrR5WymG/k8EXLOh0LJTaCLBt+fyv9xRqmIPJQwHaPaoV3o5 + a3YM9Lbq14BGK8ySHp+ffBcony8TiyqFEa61ostQvQyE21YayJg6EdacY/xHwpFlf8qP + H7iBkJp1pMztZEyxwgu3dIKLkSicVMMlQVEVHpMhq6qaaypTc1VDQab4o9DB0/QPGmXV + RJGbXn+UOLpY+sxxBrxYa65cszT9gbhIxXSB30SsRW3p7ZbtIEouaat7x4QIc0FCPfnc + aQG8o0qFMQmaGbTvaGN4GdMPB/wBjfbhDqxG+uRTETQ75hcE7Pd1ymcivHjuwb8MxAgR + 3VhQ== +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20161025; + h=x-gm-message-state:to:from:subject:message-id:date:user-agent + :mime-version:content-language:content-transfer-encoding; + bh=lzgCIA1dMfq+1Zoi8Mtush+Jqj/mDmwC2uBHfa8ybDc=; + b=uZOZm6bHzCDq0BNBWANQbLYgwTFfmAe4jbJMeMyD118JH2ygj6RZgIoXdf5RsxL2DF + Cj4FeXDRUPzl34SS9hshgD0fLJeLCxiKhRZZK7cuWrjelTY6A4zjNv5U3Z5+3EWk75p8 + tmnHxk2w86TDitiS/NH2MVPhjou20iwAW7KNlWLlvi0W7DO/1eK5zonfuAMMR8uUCV0F + YGtz/WgHVnY//gFOhCFpGLxVBm+U8QGEigG8MLDUiGpc9lmvtwkMkpvnO0UZSeITYAlk + xCN0Jk30pgBEq6CJ1m5TmqeAft7fv6258M/0TH5L1EVqAJQ+9wpvTvPg4FQQrrwz7/PK + VOpg== +X-Gm-Message-State: AOAM532L5lDl9xQIf19Fc0oe2hyHLx8Em+K7lIllieBybFHp01Zr2H3J + wh64f6L6IgQ5tPBvmlRH8IctB4IiHdZquJoRp10FWHKjn7+L4jib5wsUDVnM/Uyjw44b326R08D + fC4vnTb41a9b4AAoJSbKzgIB01Qy81YNUFx7qu9SSQBmaDxggTl/IQt6VsxdVeaY63SMd8rsnlm + FmEFg= +X-Google-Smtp-Source: ABdhPJzV4UdWvj19F/ju1ONILTdIJGjh0CEXGZRIXb0obPTeAAQoIvIxw87mW78rKDpFnLzRgUZhMw== +X-Received: by 2002:a17:90b:30d0:: with SMTP id hi16mr20431400pjb.30.1621791194884; + Sun, 23 May 2021 10:33:14 -0700 (PDT) +Return-Path: +Received: from [192.168.1.108] ([106.51.89.95]) + by smtp.gmail.com with ESMTPSA id n23sm6419900pgv.76.2021.05.23.10.33.13 + for + (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); + Sun, 23 May 2021 10:33:14 -0700 (PDT) +To: psaodp2apsdoad9@zerodha.com +From: Kailash Nadh +Subject: test +Message-ID: +Date: Sun, 23 May 2021 23:03:11 +0530 +User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 + Thunderbird/78.10.1 +MIME-Version: 1.0 +Content-Type: text/html; charset=utf-8 +Content-Language: en-US +Content-Transfer-Encoding: 7bit + + + + + + + +

this is a test message and can + be ignored.
+

+ + + +--0000000000001cf3b205c302b0a3-- diff --git a/internal/bounce/mailbox/opt.go b/internal/bounce/mailbox/opt.go new file mode 100644 index 0000000..814bb2c --- /dev/null +++ b/internal/bounce/mailbox/opt.go @@ -0,0 +1,29 @@ +package mailbox + +import "time" + +// Opt represents an e-mail POP/IMAP mailbox configuration. +type Opt struct { + // Host is the server's hostname. + Host string `json:"host"` + + // Port is the server port. + Port int `json:"port"` + + AuthProtocol string `json:"auth_protocol"` + + // Username is the mail server login username. + Username string `json:"username"` + + // Password is the mail server login password. + Password string `json:"password"` + + // Folder is the name of the IMAP folder to scan for e-mails. + Folder string `json:"folder"` + + // Optional TLS settings. + TLSEnabled bool `json:"tls_enabled"` + TLSSkipVerify bool `json:"tls_skip_verify"` + + ScanInterval time.Duration `json:"scan_interval"` +} diff --git a/internal/bounce/mailbox/pop.go b/internal/bounce/mailbox/pop.go new file mode 100644 index 0000000..a8f32b4 --- /dev/null +++ b/internal/bounce/mailbox/pop.go @@ -0,0 +1,119 @@ +package mailbox + +import ( + "encoding/json" + "time" + + "github.com/knadh/go-pop3" + "github.com/knadh/listmonk/models" +) + +// POP represents a POP mailbox. +type POP struct { + opt Opt + client *pop3.Client +} + +// NewPOP returns a new instance of the POP mailbox client. +func NewPOP(opt Opt) *POP { + return &POP{ + opt: opt, + client: pop3.New(pop3.Opt{ + Host: opt.Host, + Port: opt.Port, + TLSEnabled: opt.TLSEnabled, + TLSSkipVerify: opt.TLSSkipVerify, + }), + } +} + +// Scan scans the mailbox and pushes the downloaded messages into the given channel. +// The messages that are downloaded are deleted from the server. If limit > 0, +// all messages on the server are downloaded and deleted. +func (p *POP) Scan(limit int, ch chan models.Bounce) error { + c, err := p.client.NewConn() + if err != nil { + return err + } + defer c.Quit() + + // Authenticate. + if p.opt.AuthProtocol != "none" { + if err := c.Auth(p.opt.Username, p.opt.Password); err != nil { + return err + } + } + + // Get the total number of messages on the server. + count, _, err := c.Stat() + if err != nil { + return err + } + + // No messages. + if count == 0 { + return nil + } + + if limit > 0 && count > limit { + count = limit + } + + // Download messages. + for id := 1; id <= count; id++ { + // Download just one line of the body as the body is not required at all. + m, err := c.Top(id, 1) + if err != nil { + return err + } + + var ( + campUUID = m.Header.Get(models.EmailHeaderCampaignUUID) + subUUID = m.Header.Get(models.EmailHeaderSubscriberUUID) + date, _ = time.Parse("Mon, 02 Jan 2006 15:04:05 -0700", m.Header.Get("Date")) + ) + + if campUUID == "" || subUUID == "" { + continue + } + if date.IsZero() { + date = time.Now() + } + + // Additional bounce e-mail metadata. + meta, _ := json.Marshal(struct { + From string `json:"from"` + Subject string `json:"subject"` + MessageID string `json:"message_id"` + DeliveredTo string `json:"delivered_to"` + Received []string `json:"received"` + }{ + From: m.Header.Get("From"), + Subject: m.Header.Get("Subject"), + MessageID: m.Header.Get("Message-Id"), + DeliveredTo: m.Header.Get("Delivered-To"), + Received: m.Header.Map()["Received"], + }) + + select { + case ch <- models.Bounce{ + Type: "hard", + CampaignUUID: m.Header.Get(models.EmailHeaderCampaignUUID), + SubscriberUUID: m.Header.Get(models.EmailHeaderSubscriberUUID), + Source: p.opt.Host, + CreatedAt: date, + Meta: json.RawMessage(meta), + }: + default: + } + } + + // Delete the downloaded messages. + for id := 1; id <= count; id++ { + if err := c.Dele(id); err != nil { + return err + } + } + + return nil +} diff --git a/internal/bounce/proton.bounce b/internal/bounce/proton.bounce new file mode 100644 index 0000000..50a666c --- /dev/null +++ b/internal/bounce/proton.bounce @@ -0,0 +1,152 @@ +Content-Type: multipart/mixed; + boundary=ea9649a4b8e544897b542b3a1b97e2d172a7efdd385fe08531c312b947091452 +References: <_GK6cYA-I3T01OCdH_MIi1whoJheEQ3--oTPqsatnNKqyJTNfcCFOQMJRqXyDtdOn_jPw7qb40E1F8QlDS_OAw==@protonmail.internalid> +X-Pm-Date: Sun, 23 May 2021 17:12:42 +0000 +X-Pm-External-Id: <4Fp6NV4QXQz4wwcG@mail1.protonmail.ch> +X-Pm-Internal-Id: _GK6cYA-I3T01OCdH_MIi1whoJheEQ3--oTPqsatnNKqyJTNfcCFOQMJRqXyDtdOn_jPw7qb40E1F8QlDS_OAw== +To: +Reply-To: +From: +Subject: Undelivered Mail Returned to Sender +Delivered-To: kailash@nadh.in +X-Pm-Spam-Action: dunno +X-Pm-Origin: internal +X-Attached: email-1.3.eml +Return-Path: <> +Mime-Version: 1.0 +Authentication-Results: mailin027.protonmail.ch; dkim=none +Authentication-Results: mailin027.protonmail.ch; spf=pass + smtp.helo=mail-40136.protonmail.ch +Authentication-Results: mailin027.protonmail.ch; dmarc=fail (p=quarantine + dis=none) header.from=protonmail.com +Received: by mail1.protonmail.ch (Postfix) id 4Fp6NV4QXQz4wwcG; Sun, 23 May + 2021 17:12:42 +0000 (UTC) +Received: from mail-40136.protonmail.ch (mail-40136.protonmail.ch + [185.70.40.136]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 + bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) + server-digest SHA256) (No client certificate requested) by + mailin027.protonmail.ch (Postfix) with ESMTPS id 4Fp6NV73rqz9vNPR for + ; Sun, 23 May 2021 17:12:42 +0000 (UTC) +X-Pm-Spam: 0yeiAIic37iBOIJChpR3Y2bi4AiOiuHVZb8miiACL3cpJI6ZC2CIIMFGhwQGOmY2Y + E4MWxDYMNUDzzQWOzMiA0sIHzCJIYIS6gsHImIzlNwX3iW0YOAiwiACL2cvNUicmziAOLACiwVmc 3b0JogIjujIIMBCCFlVQ1U18BCMCZ0RTOBiCllXYyczBFtcGyHBIbJ2hslmYXa5RlzIGwDQIIRHv wYDIVJuxtzIFy29YZoTg04CMTMwMxuXVuTALMBCSEZ1Q0XOl1TX0LElUR9VISByMkQ6wdvIEg2Qb cVmwhRXdGdvlAobipzMKX4Gg4EzWSN3440MCxC4MMYzgzlGbGdkVluIGsHdIL1mhzxWaGcrl5uZS dXRZX4Ggw4CMEISZVNRUMUlQXZ0Sg00T2UuVVyZGtGVIYlWszlGIGIvN1vbW5mxbIFGilNXdCZlB R1bmy2VcI1GhcxWaibwB92cmlWRacxluttFIWYslItZXlGFZb9Wu0F2WXXyBRvb3hm1bawWut92Y VXuxAuLTTCBMUZEfMVES1TQ9NTQVQFNIRojgMVESyTtBRjYXzGVaINFQyBiRWZvNRccmwi0bLAjg WNkUFRJ99NTlJ1BUSV0fgw0VWTpFNwbHlWtaIdGvgQ2b2cuVVyZGu1xcIEDuTBSOEUP9VERkS0ZX RVUNMlUQEIv5RlIGy2NcaBX0u9WaGI2FlsYWsWJYZ5ScgIibSf9B +Date: Sun, 23 May 2021 17:12:42 +0000 (UTC) +X-Original-To: kailash@nadh.in +X-Pm-Content-Encryption: on-delivery +Message-Id: <4Fp6NV4QXQz4wwcG@mail1.protonmail.ch> +Auto-Submitted: auto-replied +X-Pm-Spamscore: 0 + +--ea9649a4b8e544897b542b3a1b97e2d172a7efdd385fe08531c312b947091452 +Content-Transfer-Encoding: quoted-printable +Content-Type: text/plain; charset=utf-8 + +This is the mail system at ProtonMail. + +I'm sorry to have to inform you that your message could not +be delivered to one or more recipients. It's attached below. + +For further assistance, please forward this email to support@protonmail.com= +. + +If you do so, you can delete your own text from the attached returned messa= +ge. + + +: host + aspmx.l.google.com[172.217.218.26] said: 550-5.1.1 The email account th= +at + you tried to reach does not exist. Please try 550-5.1.1 double-checking= + the + recipient's email address for typos or 550-5.1.1 unnecessary spaces. Le= +arn + more at 550 5.1.1 https://support.google.com/mail/?p=3DNoSuchUser + c95si12273060edf.464 - gsmtp (in reply to RCPT TO command) +---------------------------------------------- +message/delivery-status +---------------------------------------------- +Reporting-MTA: dns; mail1.protonmail.ch +X-Postfix-Queue-ID: 4Fp6NT5QDfz4wwcW +X-Postfix-Sender: rfc822; kailash@nadh.in +Arrival-Date: Sun, 23 May 2021 17:12:41 +0000 (UTC) + +Final-Recipient: rfc822; osdktestpaostestapleps199aopp@zerodha.com +Original-Recipient: rfc822;osdktestpaostestapleps199aopp@zerodha.com +Action: failed +Status: 5.1.1 +Remote-MTA: dns; aspmx.l.google.com +Diagnostic-Code: smtp; 550-5.1.1 The email account that you tried to reach = +does + not exist. Please try 550-5.1.1 double-checking the recipient's email + address for typos or 550-5.1.1 unnecessary spaces. Learn more at 550 5.= +1.1 + https://support.google.com/mail/?p=3DNoSuchUser c95si12273060edf.464 - = +gsmtp +---------------------------------------------- +message/rfc822 +---------------------------------------------- +Return-Path: +Date: Sun, 23 May 2021 17:12:34 +0000 +DKIM-Signature: v=3D1; a=3Drsa-sha256; c=3Drelaxed/relaxed; d=3Dnadh.in; + s=3Dprotonmail2; t=3D1621789961; + bh=3Dquadcf+F3w95Vv4EffkoWEgj0LG46W18oiyVW2rhqjk=3D; + h=3DDate:To:From:Reply-To:Subject:From; + b=3DJjlkyS8K1NigYGOKr6a+Citz/W/NUvCj52hkQu/U5iltmNH9EgWYLJ2gB56gb7WoQ + KTbJidRExtT16u2FdSHlMFpJRYiurJ3S0ko6YGZYT+FUbYqPrKC9sGrX3iHR8g3h3E + 0UsWl9Ny/lylN8PA70tr3IHI0ZzSYP5njITZIyJP9QfHnXK/n9r418pLtnRXoovztX + 797taPQIUjiVXgGDSg9AcWsRHPHGE9y0otE1gG0Vzt7kMzY/RHLq65eRvPtncy9IUU + 7fSbsyi8qaBIbRoFFvkJTHgusTvbyFuPfnajd+Dpm6G3xLn26ny0ZXpDwPO/ZJOsVI + BbcMLTMUBJToQ=3D=3D +To: osdktestpaostestapleps199aopp@zerodha.com +From: Kailash Nadh +Reply-To: Kailash Nadh +Subject: Hi, this is a test! +Message-ID: <231fe26c-de5f-1fd7-b658-6452ae74149e@nadh.in> +MIME-Version: 1.0 +Content-Type: text/plain; charset=3Dutf-8 +Content-Transfer-Encoding: quoted-printable +X-Spam-Status: No, score=3D-1.2 required=3D10.0 tests=3DALL_TRUSTED,DKIM_SI= +GNED, + DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF shortcircuit=3Dno + autolearn=3Ddisabled version=3D3.4.4 +X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on + mailout.protonmail.ch + +Empty Message + + +--ea9649a4b8e544897b542b3a1b97e2d172a7efdd385fe08531c312b947091452 +Content-Disposition: attachment; filename=email-1.3.eml +Content-Type: message/rfc822; name=email-1.3.eml +Content-Description: Undelivered Message +X-Pm-Content-Encryption: on-delivery + +Return-Path: +Date: Sun, 23 May 2021 17:12:34 +0000 +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nadh.in; + s=protonmail2; t=1621789961; + bh=quadcf+F3w95Vv4EffkoWEgj0LG46W18oiyVW2rhqjk=; + h=Date:To:From:Reply-To:Subject:From; + b=JjlkyS8K1NigYGOKr6a+Citz/W/NUvCj52hkQu/U5iltmNH9EgWYLJ2gB56gb7WoQ + KTbJidRExtT16u2FdSHlMFpJRYiurJ3S0ko6YGZYT+FUbYqPrKC9sGrX3iHR8g3h3E + 0UsWl9Ny/lylN8PA70tr3IHI0ZzSYP5njITZIyJP9QfHnXK/n9r418pLtnRXoovztX + 797taPQIUjiVXgGDSg9AcWsRHPHGE9y0otE1gG0Vzt7kMzY/RHLq65eRvPtncy9IUU + 7fSbsyi8qaBIbRoFFvkJTHgusTvbyFuPfnajd+Dpm6G3xLn26ny0ZXpDwPO/ZJOsVI + BbcMLTMUBJToQ== +To: osdktestpaostestapleps199aopp@zerodha.com +From: Kailash Nadh +Reply-To: Kailash Nadh +Subject: Hi, this is a test! +Message-ID: <231fe26c-de5f-1fd7-b658-6452ae74149e@nadh.in> +MIME-Version: 1.0 +Content-Type: text/plain; charset=utf-8 +Content-Transfer-Encoding: quoted-printable +X-Spam-Status: No, score=-1.2 required=10.0 tests=ALL_TRUSTED,DKIM_SIGNED, + DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF shortcircuit=no + autolearn=disabled version=3.4.4 +X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on + mailout.protonmail.ch + +Empty Message + + +--ea9649a4b8e544897b542b3a1b97e2d172a7efdd385fe08531c312b947091452-- diff --git a/internal/bounce/webhooks/sendgrid.go b/internal/bounce/webhooks/sendgrid.go new file mode 100644 index 0000000..ec32dcd --- /dev/null +++ b/internal/bounce/webhooks/sendgrid.go @@ -0,0 +1,104 @@ +package webhooks + +import ( + "crypto/ecdsa" + "crypto/sha256" + "crypto/x509" + "encoding/asn1" + "encoding/base64" + "encoding/json" + "errors" + "fmt" + "math/big" + "strings" + "time" + + "github.com/knadh/listmonk/models" +) + +type sendgridNotif struct { + Email string `json:"email"` + Timestamp int64 `json:"timestamp"` + Event string `json:"event"` +} + +// Sendgrid handles Sendgrid/SNS webhook notifications including confirming SNS topic subscription +// requests and bounce notifications. +type Sendgrid struct { + pubKey *ecdsa.PublicKey +} + +// NewSendgrid returns a new Sendgrid instance. +func NewSendgrid(key string) (*Sendgrid, error) { + // Get the certificate from the key. + sigB, err := base64.StdEncoding.DecodeString(key) + if err != nil { + return nil, err + } + + pubKey, err := x509.ParsePKIXPublicKey(sigB) + if err != nil { + return nil, err + } + + return &Sendgrid{pubKey: pubKey.(*ecdsa.PublicKey)}, nil +} + +// ProcessBounce processes Sendgrid bounce notifications and returns one or more Bounce objects. +func (s *Sendgrid) ProcessBounce(sig, timestamp string, b []byte) ([]models.Bounce, error) { + if err := s.verifyNotif(sig, timestamp, b); err != nil { + return nil, err + } + + var notifs []sendgridNotif + if err := json.Unmarshal(b, ¬ifs); err != nil { + return nil, fmt.Errorf("error unmarshalling Sendgrid notification: %v", err) + } + + out := make([]models.Bounce, 0, len(notifs)) + for _, n := range notifs { + if n.Event != "bounce" { + continue + } + + tstamp := time.Unix(n.Timestamp, 0) + b := models.Bounce{ + Email: strings.ToLower(n.Email), + Type: models.BounceTypeHard, + Meta: json.RawMessage(b), + Source: "sendgrid", + CreatedAt: tstamp, + } + out = append(out, b) + } + + return out, nil +} + +// verifyNotif verifies the signature on a notification payload. +func (s *Sendgrid) verifyNotif(sig, timestamp string, b []byte) error { + sigB, err := base64.StdEncoding.DecodeString(sig) + if err != nil { + return err + } + + ecdsaSig := struct { + R *big.Int + S *big.Int + }{} + + if _, err := asn1.Unmarshal(sigB, &ecdsaSig); err != nil { + return fmt.Errorf("error asn1 unmarshal of signature: %v", err) + } + + h := sha256.New() + h.Write([]byte(timestamp)) + h.Write(b) + hash := h.Sum(nil) + + if !ecdsa.Verify(s.pubKey, hash, ecdsaSig.R, ecdsaSig.S) { + return errors.New("invalid signature") + } + + return nil +} diff --git a/internal/bounce/webhooks/ses.go b/internal/bounce/webhooks/ses.go new file mode 100644 index 0000000..8ad252c --- /dev/null +++ b/internal/bounce/webhooks/ses.go @@ -0,0 +1,249 @@ +package webhooks + +import ( + "bytes" + "crypto/x509" + "encoding/base64" + "encoding/json" + "encoding/pem" + "errors" + "fmt" + "io/ioutil" + "net/http" + "net/url" + "regexp" + "strings" + "time" + + "github.com/knadh/listmonk/models" +) + +// AWS signature/validation logic borrowed from @cavnit's contrib: +// https://gist.github.com/cavnit/f4d63ba52b3aa05406c07dcbca2ca6cf + +// https://sns.ap-southeast-1.amazonaws.com/SimpleNotificationService-010a507c1833636cd94bdb98bd93083a.pem +var sesRegCertURL = regexp.MustCompile(`(?i)^https://sns\.[a-z0-9\-]+\.amazonaws\.com(\.cn)?/SimpleNotificationService\-[a-z0-9]+\.pem$`) + +// sesNotif is an individual notification wrapper posted by SNS. +type sesNotif struct { + // Message may be a plaintext message or a stringified JSON payload based on the message type. + // Four SES messages, this is the actual payload. + Message string `json:"Message"` + + MessageId string `json:"MessageId"` + Signature string `json:"Signature"` + SignatureVersion string `json:"SignatureVersion"` + SigningCertURL string `json:"SigningCertURL"` + Subject string `json:"Subject"` + Timestamp string `json:"Timestamp"` + Token string `json:"Token"` + TopicArn string `json:"TopicArn"` + Type string `json:"Type"` + SubscribeURL string `json:"SubscribeURL"` + UnsubscribeURL string `json:"UnsubscribeURL"` +} + +type sesTimestamp time.Time + +type sesMail struct { + NotifType string `json:"notificationType"` + Bounce struct { + BounceType string `json:"bounceType"` + } `json:"bounce"` + Mail struct { + Timestamp sesTimestamp `json:"timestamp"` + HeadersTruncated bool `json:"headersTruncated"` + Destination []string `json:"destination"` + Headers []map[string]string `json:"headers"` + } `json:"mail"` +} + +// SES handles SES/SNS webhook notifications including confirming SNS topic subscription +// requests and bounce notifications. +type SES struct { + certs map[string]*x509.Certificate +} + +// NewSES returns a new SES instance. +func NewSES() *SES { + return &SES{ + certs: make(map[string]*x509.Certificate), + } +} + +// ProcessSubscription processes an SNS topic subscribe / unsubscribe notification +// by parsing and verifying the payload and calling the subscribe / unsubscribe URL. +func (s *SES) ProcessSubscription(b []byte) error { + var n sesNotif + if err := json.Unmarshal(b, &n); err != nil { + return fmt.Errorf("error unmarshalling SNS notification: %v", err) + } + if err := s.verifyNotif(n); err != nil { + return err + } + + // Make an HTTP request to the sub/unsub URL. + u := n.SubscribeURL + if n.Type == "UnsubscriptionConfirmation" { + u = n.UnsubscribeURL + } + + resp, err := http.Get(u) + if err != nil { + return fmt.Errorf("error requesting subscription URL: %v", err) + } + + if resp.StatusCode != http.StatusOK { + return fmt.Errorf("non 200 response on subscription URL: %v", resp.StatusCode) + } + + return nil +} + +// ProcessBounce processes an SES bounce notification and returns a Bounce object. +func (s *SES) ProcessBounce(b []byte) (models.Bounce, error) { + var ( + bounce models.Bounce + n sesNotif + ) + if err := json.Unmarshal(b, &n); err != nil { + return bounce, fmt.Errorf("error unmarshalling SES notification: %v", err) + } + if err := s.verifyNotif(n); err != nil { + return bounce, err + } + + var m sesMail + if err := json.Unmarshal([]byte(n.Message), &m); err != nil { + return bounce, fmt.Errorf("error unmarshalling SES notification: %v", err) + } + + if len(m.Mail.Destination) == 0 { + return bounce, errors.New("no destination e-mails found in SES notification") + } + + typ := "soft" + if m.Bounce.BounceType == "Permanent" { + typ = "hard" + } + + // Look for the campaign ID in headers. + campUUID := "" + if !m.Mail.HeadersTruncated { + for _, h := range m.Mail.Headers { + key, ok := h["name"] + if !ok || key != models.EmailHeaderCampaignUUID { + continue + } + + campUUID, ok = h["value"] + if !ok { + continue + } + break + } + } + + return models.Bounce{ + Email: strings.ToLower(m.Mail.Destination[0]), + CampaignUUID: campUUID, + Type: typ, + Source: "ses", + Meta: json.RawMessage(n.Message), + CreatedAt: time.Time(m.Mail.Timestamp), + }, nil +} + +func (s *SES) buildSignature(n sesNotif) []byte { + var b bytes.Buffer + b.WriteString("Message" + "\n" + n.Message + "\n") + b.WriteString("MessageId" + "\n" + n.MessageId + "\n") + + if n.Subject != "" { + b.WriteString("Subject" + "\n" + n.Subject + "\n") + } + if n.SubscribeURL != "" { + b.WriteString("SubscribeURL" + "\n" + n.SubscribeURL + "\n") + } + + b.WriteString("Timestamp" + "\n" + n.Timestamp + "\n") + + if n.Token != "" { + b.WriteString("Token" + "\n" + n.Token + "\n") + } + b.WriteString("TopicArn" + "\n" + n.TopicArn + "\n") + b.WriteString("Type" + "\n" + n.Type + "\n") + + return b.Bytes() +} + +// verifyNotif verifies the signature on a notification payload. +func (s *SES) verifyNotif(n sesNotif) error { + // Get the message signing certificate. + cert, err := s.getCert(n.SigningCertURL) + if err != nil { + return fmt.Errorf("error getting SNS cert: %v", err) + } + + sign, err := base64.StdEncoding.DecodeString(n.Signature) + if err != nil { + return err + } + + return cert.CheckSignature(x509.SHA1WithRSA, s.buildSignature(n), sign) +} + +// getCert takes the SNS certificate URL and fetches it and caches it for the first time, +// and returns the cached cert for subsequent calls. +func (s *SES) getCert(certURL string) (*x509.Certificate, error) { + // Ensure that the cert URL is Amazon's. + u, err := url.Parse(certURL) + if err != nil { + return nil, err + } + if !sesRegCertURL.MatchString(certURL) { + return nil, fmt.Errorf("invalid SNS certificate URL: %v", u.Host) + } + + // Return if it's cached. + if c, ok := s.certs[u.Path]; ok { + return c, nil + } + + // Fetch the certificate. + resp, err := http.Get(certURL) + if err != nil { + return nil, err + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return nil, fmt.Errorf("invalid SNS certificate URL: %v", u.Host) + } + + body, err := ioutil.ReadAll(resp.Body) + if err != nil { + return nil, err + } + + p, _ := pem.Decode(body) + if p == nil { + return nil, errors.New("invalid PEM") + } + + cert, err := x509.ParseCertificate(p.Bytes) + + // Cache the cert in-memory. + s.certs[u.Path] = cert + + return cert, err +} + +func (st *sesTimestamp) UnmarshalJSON(b []byte) error { + t, err := time.Parse("2006-01-02T15:04:05.999999999Z", strings.Trim(string(b), `"`)) + if err != nil { + return err + } + *st = sesTimestamp(t) + return nil +} diff --git a/internal/manager/manager.go b/internal/manager/manager.go index 0918935..89d1cb7 100644 --- a/internal/manager/manager.go +++ b/internal/manager/manager.go @@ -21,27 +21,37 @@ const ( // BaseTPL is the name of the base template. BaseTPL = "base" + BounceTypeBlocklist = "blocklist" + BounceTypeDelete = "delete" + // ContentTpl is the name of the compiled message. ContentTpl = "content" dummyUUID = "00000000-0000-0000-0000-000000000000" ) -// DataSource represents a data backend, such as a database, +// Store represents a data backend, such as a database, // that provides subscriber and campaign records. -type DataSource interface { +type Store 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) + + // RecordBounce records an external bounce event identified by + // a user's UUID/e-mail and a campaign UUID. + RecordBounce(b models.Bounce) (int64, int, error) + + BlocklistSubscriber(id int64) error + DeleteSubscriber(id int64) error } // Manager handles the scheduling, processing, and queuing of campaigns // and message pushes. type Manager struct { cfg Config - src DataSource + store Store i18n *i18n.I18n messengers map[string]messenger.Messenger notifCB models.AdminNotifCallback @@ -62,6 +72,7 @@ type Manager struct { campMsgErrorQueue chan msgError campMsgErrorCounts map[int]int msgQueue chan Message + bounceQueue chan models.Bounce // Sliding window keeps track of the total number of messages sent in a period // and on reaching the specified limit, waits until the window is over before @@ -113,6 +124,8 @@ type Config struct { MessageURL string ViewTrackURL string UnsubHeader bool + BounceCount int + BounceAction string } type msgError struct { @@ -120,8 +133,10 @@ type msgError struct { err error } +var pushTimeout = time.Second * 3 + // New returns a new instance of Mailer. -func New(cfg Config, src DataSource, notifCB models.AdminNotifCallback, i *i18n.I18n, l *log.Logger) *Manager { +func New(cfg Config, store Store, notifCB models.AdminNotifCallback, i *i18n.I18n, l *log.Logger) *Manager { if cfg.BatchSize < 1 { cfg.BatchSize = 1000 } @@ -134,7 +149,7 @@ func New(cfg Config, src DataSource, notifCB models.AdminNotifCallback, i *i18n. return &Manager{ cfg: cfg, - src: src, + store: store, i18n: i, notifCB: notifCB, logger: l, @@ -144,6 +159,7 @@ func New(cfg Config, src DataSource, notifCB models.AdminNotifCallback, i *i18n. subFetchQueue: make(chan *models.Campaign, cfg.Concurrency), campMsgQueue: make(chan CampaignMessage, cfg.Concurrency*2), msgQueue: make(chan Message, cfg.Concurrency), + bounceQueue: make(chan models.Bounce, cfg.Concurrency), campMsgErrorQueue: make(chan msgError, cfg.MaxSendErrors), campMsgErrorCounts: make(map[int]int), slidingWindowStart: time.Now(), @@ -184,7 +200,7 @@ func (m *Manager) AddMessenger(msg messenger.Messenger) error { // PushMessage pushes an arbitrary non-campaign Message to be sent out by the workers. // It times out if the queue is busy. func (m *Manager) PushMessage(msg Message) error { - t := time.NewTicker(time.Second * 3) + t := time.NewTicker(pushTimeout) defer t.Stop() select { @@ -199,7 +215,7 @@ func (m *Manager) PushMessage(msg Message) error { // PushCampaignMessage pushes a campaign messages to be sent out by the workers. // It times out if the queue is busy. func (m *Manager) PushCampaignMessage(msg CampaignMessage) error { - t := time.NewTicker(time.Second * 3) + t := time.NewTicker(pushTimeout) defer t.Stop() select { @@ -224,6 +240,20 @@ func (m *Manager) HasRunningCampaigns() bool { return len(m.camps) > 0 } +// PushBounce records a bounce event. +func (m *Manager) PushBounce(b models.Bounce) error { + t := time.NewTicker(pushTimeout) + defer t.Stop() + + select { + case m.bounceQueue <- b: + case <-t.C: + m.logger.Printf("bounce pushed timed out: %s / %s", b.SubscriberUUID, b.Email) + return errors.New("bounce push timed out") + } + return nil +} + // 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 @@ -235,7 +265,7 @@ func (m *Manager) Run(tick time.Duration) { // Spawn N message workers. for i := 0; i < m.cfg.Concurrency; i++ { - go m.messageWorker() + go m.worker() } // Fetch the next set of subscribers for a campaign and process them. @@ -262,9 +292,9 @@ func (m *Manager) Run(tick time.Duration) { } } -// messageWorker is a blocking function that listens to the message queue -// and pushes out incoming messages on it to the messenger. -func (m *Manager) messageWorker() { +// worker is a blocking function that perpetually listents to events (message, bounce) on different +// queues and processes them. +func (m *Manager) worker() { // Counter to keep track of the message / sec rate limit. numMsg := 0 for { @@ -294,14 +324,18 @@ func (m *Manager) messageWorker() { Campaign: msg.Campaign, } + h := textproto.MIMEHeader{} + h.Set(models.EmailHeaderCampaignUUID, msg.Campaign.UUID) + h.Set(models.EmailHeaderSubscriberUUID, msg.Subscriber.UUID) + // Attach List-Unsubscribe headers? if m.cfg.UnsubHeader { - h := textproto.MIMEHeader{} h.Set("List-Unsubscribe-Post", "List-Unsubscribe=One-Click") h.Set("List-Unsubscribe", `<`+msg.unsubURL+`>`) - out.Headers = h } + out.Headers = h + if err := m.messengers[msg.Campaign.Messenger].Push(out); err != nil { m.logger.Printf("error sending message in campaign %s: subscriber %s: %v", msg.Campaign.Name, msg.Subscriber.UUID, err) @@ -331,6 +365,30 @@ func (m *Manager) messageWorker() { if err != nil { m.logger.Printf("error sending message '%s': %v", msg.Subject, err) } + + // Bounce event. + case b, ok := <-m.bounceQueue: + if !ok { + return + } + + subID, count, err := m.store.RecordBounce(b) + if err != nil { + m.logger.Printf("error recording bounce %s / %s", b.SubscriberUUID, b.Email) + } + + if count >= m.cfg.BounceCount { + switch m.cfg.BounceAction { + case BounceTypeBlocklist: + err = m.store.BlocklistSubscriber(subID) + case BounceTypeDelete: + err = m.store.DeleteSubscriber(subID) + } + + if err != nil { + m.logger.Printf("error executing bounce for subscriber: %s", b.SubscriberUUID) + } + } } } } @@ -403,7 +461,7 @@ func (m *Manager) scanCampaigns(tick time.Duration) { select { // Periodically scan the data source for campaigns to process. case <-t.C: - campaigns, err := m.src.NextCampaigns(m.getPendingCampaignIDs()) + campaigns, err := m.store.NextCampaigns(m.getPendingCampaignIDs()) if err != nil { m.logger.Printf("error fetching campaigns: %v", err) continue @@ -457,7 +515,7 @@ func (m *Manager) scanCampaigns(tick time.Duration) { func (m *Manager) addCampaign(c *models.Campaign) error { // Validate messenger. if _, ok := m.messengers[c.Messenger]; !ok { - m.src.UpdateCampaignStatus(c.ID, models.CampaignStatusCancelled) + m.store.UpdateCampaignStatus(c.ID, models.CampaignStatusCancelled) return fmt.Errorf("unknown messenger %s on campaign %s", c.Messenger, c.Name) } @@ -491,7 +549,7 @@ func (m *Manager) getPendingCampaignIDs() []int64 { // have been processed, or that a campaign has been paused or cancelled. func (m *Manager) nextSubscribers(c *models.Campaign, batchSize int) (bool, error) { // Fetch a batch of subscribers. - subs, err := m.src.NextSubscribers(c.ID, batchSize) + subs, err := m.store.NextSubscribers(c.ID, batchSize) if err != nil { return false, fmt.Errorf("error fetching campaign subscribers (%s): %v", c.Name, err) } @@ -566,7 +624,7 @@ func (m *Manager) exhaustCampaign(c *models.Campaign, status string) (*models.Ca // A status has been passed. Change the campaign's status // without further checks. if status != "" { - if err := m.src.UpdateCampaignStatus(c.ID, status); err != nil { + if err := m.store.UpdateCampaignStatus(c.ID, status); err != nil { m.logger.Printf("error updating campaign (%s) status to %s: %v", c.Name, status, err) } else { m.logger.Printf("set campaign (%s) to %s", c.Name, status) @@ -575,7 +633,7 @@ func (m *Manager) exhaustCampaign(c *models.Campaign, status string) (*models.Ca } // Fetch the up-to-date campaign status from the source. - cm, err := m.src.GetCampaign(c.ID) + cm, err := m.store.GetCampaign(c.ID) if err != nil { return nil, err } @@ -583,7 +641,7 @@ func (m *Manager) exhaustCampaign(c *models.Campaign, status string) (*models.Ca // If a running campaign has exhausted subscribers, it's finished. if cm.Status == models.CampaignStatusRunning { cm.Status = models.CampaignStatusFinished - if err := m.src.UpdateCampaignStatus(c.ID, models.CampaignStatusFinished); err != nil { + if err := m.store.UpdateCampaignStatus(c.ID, models.CampaignStatusFinished); err != nil { m.logger.Printf("error finishing campaign (%s): %v", c.Name, err) } else { m.logger.Printf("campaign (%s) finished", c.Name) @@ -606,7 +664,7 @@ func (m *Manager) trackLink(url, campUUID, subUUID string) string { m.linksMut.RUnlock() // Register link. - uu, err := m.src.CreateLink(url) + uu, err := m.store.CreateLink(url) if err != nil { m.logger.Printf("error registering tracking for link '%s': %v", url, err) diff --git a/internal/migrations/v2.0.0.go b/internal/migrations/v2.0.0.go new file mode 100644 index 0000000..8aabd08 --- /dev/null +++ b/internal/migrations/v2.0.0.go @@ -0,0 +1,43 @@ +package migrations + +import ( + "github.com/jmoiron/sqlx" + "github.com/knadh/koanf" + "github.com/knadh/stuffbin" +) + +// V2_0_0 performs the DB migrations for v.1.0.0. +func V2_0_0(db *sqlx.DB, fs stuffbin.FileSystem, ko *koanf.Koanf) error { + if _, err := db.Exec(` + CREATE TABLE IF NOT EXISTS bounces ( + id SERIAL PRIMARY KEY, + subscriber_id INTEGER NOT NULL REFERENCES subscribers(id) ON DELETE CASCADE ON UPDATE CASCADE, + campaign_id INTEGER NULL REFERENCES campaigns(id) ON DELETE SET NULL ON UPDATE CASCADE, + type bounce_type NOT NULL DEFAULT 'hard', + source TEXT NOT NULL DEFAULT '', + meta JSONB NOT NULL DEFAULT '{}', + created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW() + ); + CREATE INDEX IF NOT EXISTS idx_bounces_sub_id ON bounces(subscriber_id); + CREATE INDEX IF NOT EXISTS idx_bounces_camp_id ON bounces(campaign_id); + CREATE INDEX IF NOT EXISTS idx_bounces_source ON bounces(source); + `); err != nil { + return err + } + + if _, err := db.Exec(` + INSERT INTO settings (key, value) SELECT k, v::JSONB FROM (VALUES + ('bounce.enabled', 'false'), + ('bounce.webhooks_enabled', 'false'), + ('bounce.count', '2'), + ('bounce.action', '"blocklist"'), + ('bounce.ses_enabled', 'false'), + ('bounce.sendgrid_enabled', 'false'), + ('bounce.sendgrid_key', '""'), + ('bounce.mailboxes', '[{"enabled":false, "type": "pop", "host":"pop.yoursite.com","port":995,"auth_protocol":"userpass","username":"username","password":"password","return_path": "bounce@listmonk.yoursite.com","scan_interval":"15m","tls_enabled":true,"tls_skip_verify":false}]')) + VALS (k, v) WHERE NOT EXISTS(SELECT * FROM settings LIMIT 1);`); err != nil { + return err + } + + return nil +} diff --git a/models/models.go b/models/models.go index c16dc0c..dcf9c89 100644 --- a/models/models.go +++ b/models/models.go @@ -9,6 +9,7 @@ import ( "html/template" "regexp" "strings" + "time" "github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx/types" @@ -62,6 +63,13 @@ const ( // ContentTpl is the name of the compiled message. ContentTpl = "content" + + // Headers attached to e-mails for bounce tracking. + EmailHeaderSubscriberUUID = "X-Listmonk-Subscriber" + EmailHeaderCampaignUUID = "X-Listmonk-Campaign" + + BounceTypeHard = "hard" + BounceTypeSoft = "soft" ) // regTplFunc represents contains a regular expression for wrapping and @@ -201,6 +209,7 @@ type CampaignMeta struct { CampaignID int `db:"campaign_id" json:"-"` Views int `db:"views" json:"views"` Clicks int `db:"clicks" json:"clicks"` + Bounces int `db:"bounces" json:"bounces"` // This is a list of {list_id, name} pairs unlike Subscriber.Lists[] // because lists can be deleted after a campaign is finished, resulting @@ -226,6 +235,27 @@ type Template struct { IsDefault bool `db:"is_default" json:"is_default"` } +// Bounce represents a single bounce event. +type Bounce struct { + ID int `db:"id" json:"id"` + Type string `db:"type" json:"type"` + Source string `db:"source" json:"source"` + Meta json.RawMessage `db:"meta" json:"meta"` + CreatedAt time.Time `db:"created_at" json:"created_at"` + + // One of these should be provided. + Email string `db:"email" json:"email,omitempty"` + SubscriberUUID string `db:"subscriber_uuid" json:"subscriber_uuid,omitempty"` + SubscriberID int `db:"subscriber_id" json:"subscriber_id,omitempty"` + + CampaignUUID string `db:"campaign_uuid" json:"campaign_uuid,omitempty"` + Campaign *json.RawMessage `db:"campaign" json:"campaign"` + + // Pseudofield for getting the total number of bounces + // in searches and queries. + Total int `db:"total" json:"-"` +} + // markdown is a global instance of Markdown parser and renderer. var markdown = goldmark.New( goldmark.WithRendererOptions( @@ -310,6 +340,7 @@ func (camps Campaigns) LoadStats(stmt *sqlx.Stmt) error { camps[i].Lists = c.Lists camps[i].Views = c.Views camps[i].Clicks = c.Clicks + camps[i].Bounces = c.Bounces } } diff --git a/queries.sql b/queries.sql index a7382a6..244b27a 100644 --- a/queries.sql +++ b/queries.sql @@ -451,15 +451,22 @@ clicks AS ( SELECT campaign_id, COUNT(campaign_id) as num FROM link_clicks WHERE campaign_id = ANY($1) GROUP BY campaign_id +), +bounces AS ( + SELECT campaign_id, COUNT(campaign_id) as num FROM bounces + WHERE campaign_id = ANY($1) + GROUP BY campaign_id ) SELECT id as campaign_id, COALESCE(v.num, 0) AS views, COALESCE(c.num, 0) AS clicks, + COALESCE(b.num, 0) AS bounces, COALESCE(l.lists, '[]') AS lists FROM (SELECT id FROM UNNEST($1) AS id) x LEFT JOIN lists AS l ON (l.campaign_id = id) LEFT JOIN views AS v ON (v.campaign_id = id) LEFT JOIN clicks AS c ON (c.campaign_id = id) +LEFT JOIN bounces AS b ON (b.campaign_id = id) ORDER BY ARRAY_POSITION($1, id); -- name: get-campaign-for-preview @@ -781,3 +788,67 @@ SELECT JSON_OBJECT_AGG(key, value) AS settings UPDATE settings AS s SET value = c.value -- For each key in the incoming JSON map, update the row with the key and its value. FROM(SELECT * FROM JSONB_EACH($1)) AS c(key, value) WHERE s.key = c.key; + +-- name: record-bounce +-- Insert a bounce and count the bounces for the subscriber and either unsubscribe them, +WITH sub AS ( + SELECT id, status FROM subscribers WHERE CASE WHEN $1 != '' THEN uuid = $1::UUID ELSE email = $2 END +), +camp AS ( + SELECT id FROM campaigns WHERE $3 != '' AND uuid = $3::UUID +), +bounce AS ( + -- Record the bounce if it the subscriber is not already blocklisted; + INSERT INTO bounces (subscriber_id, campaign_id, type, source, meta, created_at) + SELECT (SELECT id FROM sub), (SELECT id FROM camp), $4, $5, $6, $7 + WHERE NOT EXISTS (SELECT 1 WHERE (SELECT status FROM sub) = 'blocklisted') +), +num AS ( + SELECT COUNT(*) AS num FROM bounces WHERE subscriber_id = (SELECT id FROM sub) +), +-- block1 and block2 will run when $8 = 'blocklist' and the number of bounces exceed $8. +block1 AS ( + UPDATE subscribers SET status='blocklisted' + WHERE $9 = 'blocklist' AND (SELECT num FROM num) >= $8 AND id = (SELECT id FROM sub) AND (SELECT status FROM sub) != 'blocklisted' +), +block2 AS ( + UPDATE subscriber_lists SET status='unsubscribed' + WHERE $9 = 'blocklist' AND (SELECT num FROM num) >= $8 AND subscriber_id = (SELECT id FROM sub) AND (SELECT status FROM sub) != 'blocklisted' +) +-- This delete will only run when $9 = 'delete' and the number of bounces exceed $8. +DELETE FROM subscribers + WHERE $9 = 'delete' AND (SELECT num FROM num) >= $8 AND id = (SELECT id FROM sub); + +-- name: query-bounces +SELECT COUNT(*) OVER () AS total, + bounces.id, + bounces.type, + bounces.source, + bounces.meta, + bounces.created_at, + bounces.subscriber_id, + subscribers.uuid AS subscriber_uuid, + subscribers.email AS email, + subscribers.email AS email, + ( + CASE WHEN bounces.campaign_id IS NOT NULL + THEN JSON_BUILD_OBJECT('id', bounces.campaign_id, 'name', campaigns.name) + ELSE NULL END + ) AS campaign +FROM bounces +LEFT JOIN subscribers ON (subscribers.id = bounces.subscriber_id) +LEFT JOIN campaigns ON (campaigns.id = bounces.campaign_id) +WHERE ($1 = 0 OR bounces.id = $1) + AND ($2 = 0 OR bounces.campaign_id = $2) + AND ($3 = 0 OR bounces.subscriber_id = $3) + AND ($4 = '' OR bounces.source = $4) +ORDER BY %s %s OFFSET $5 LIMIT $6; + +-- name: delete-bounces +DELETE FROM bounces WHERE ARRAY_LENGTH($1::INT[], 1) IS NULL OR id = ANY($1); + +-- name: delete-bounces-by-subscriber +WITH sub AS ( + SELECT id FROM subscribers WHERE CASE WHEN $1 > 0 THEN id = $1 ELSE uuid = $2 END +) +DELETE FROM bounces WHERE subscriber_id = (SELECT id FROM sub); diff --git a/schema.sql b/schema.sql index 8a68b65..1b23937 100644 --- a/schema.sql +++ b/schema.sql @@ -5,6 +5,7 @@ DROP TYPE IF EXISTS subscription_status CASCADE; CREATE TYPE subscription_status DROP TYPE IF EXISTS campaign_status CASCADE; CREATE TYPE campaign_status AS ENUM ('draft', 'running', 'scheduled', 'paused', 'cancelled', 'finished'); DROP TYPE IF EXISTS campaign_type CASCADE; CREATE TYPE campaign_type AS ENUM ('regular', 'optin'); DROP TYPE IF EXISTS content_type CASCADE; CREATE TYPE content_type AS ENUM ('richtext', 'html', 'plain', 'markdown'); +DROP TYPE IF EXISTS bounce_type CASCADE; CREATE TYPE bounce_type AS ENUM ('soft', 'hard', 'complaint'); -- subscribers DROP TABLE IF EXISTS subscribers CASCADE; @@ -201,4 +202,28 @@ INSERT INTO settings (key, value) VALUES ('smtp', '[{"enabled":true, "host":"smtp.yoursite.com","port":25,"auth_protocol":"cram","username":"username","password":"password","hello_hostname":"","max_conns":10,"idle_timeout":"15s","wait_timeout":"5s","max_msg_retries":2,"tls_enabled":true,"tls_skip_verify":false,"email_headers":[]}, {"enabled":false, "host":"smtp2.yoursite.com","port":587,"auth_protocol":"plain","username":"username","password":"password","hello_hostname":"","max_conns":10,"idle_timeout":"15s","wait_timeout":"5s","max_msg_retries":2,"tls_enabled":false,"tls_skip_verify":false,"email_headers":[]}]'), - ('messengers', '[]'); + ('messengers', '[]'), + ('bounce.enabled', 'false'), + ('bounce.webhooks_enabled', 'false'), + ('bounce.count', '2'), + ('bounce.action', '"blocklist"'), + ('bounce.ses_enabled', 'false'), + ('bounce.sendgrid_enabled', 'false'), + ('bounce.sendgrid_key', '""'), + ('bounce.mailboxes', + '[{"enabled":false, "type": "pop", "host":"pop.yoursite.com","port":995,"auth_protocol":"userpass","username":"username","password":"password","return_path": "bounce@listmonk.yoursite.com","scan_interval":"15m","tls_enabled":true,"tls_skip_verify":false}]'); + +-- bounces +DROP TABLE IF EXISTS bounces CASCADE; +CREATE TABLE bounces ( + id SERIAL PRIMARY KEY, + subscriber_id INTEGER NOT NULL REFERENCES subscribers(id) ON DELETE CASCADE ON UPDATE CASCADE, + campaign_id INTEGER NULL REFERENCES campaigns(id) ON DELETE SET NULL ON UPDATE CASCADE, + type bounce_type NOT NULL DEFAULT 'hard', + source TEXT NOT NULL DEFAULT '', + meta JSONB NOT NULL DEFAULT '{}', + created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW() +); +DROP INDEX IF EXISTS idx_bounces_sub_id; CREATE INDEX idx_bounces_sub_id ON bounces(subscriber_id); +DROP INDEX IF EXISTS idx_bounces_camp_id; CREATE INDEX idx_bounces_camp_id ON bounces(campaign_id); +DROP INDEX IF EXISTS idx_bounces_source; CREATE INDEX idx_bounces_source ON bounces(source);
+ + +

+ {{ $t('globals.buttons.learnMore') }} → +

+ +
+
+
+ + + +
+
+
+
+ + + +
+
+ + + +
+
+
+