Skip to content

armgit / posta

Public Imported from GitHub
0

Self-hosted email delivery platform that enables applications to send emails via HTTP APIs while handling SMTP delivery, templates, storage, security, and analytics. Fully self-hostable alternative to services like SendGrid or Mailgun.

2.3 KB
Raw Blame
// Copyright (c) 2026 Jonas Kaninda.
//
// This file is part of Posta.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: AGPL-3.0-or-later

package models

import "time"

// UnsubscribeList is a transactional opt-out scope. It is email-keyed (decoupled
// from Subscriber) and carries no membership: a recipient is never enrolled, the
// list is purely a suppression scope referenced by a send. A one-click on a link
// minted for an email that names a list writes a list-scoped Suppression, so the
// recipient's other transactional mail (receipts, password resets) keeps flowing.
//
// It is distinct from SubscriberList (campaign audiences, subscriber-keyed) and
// its SubscriberListUnsubscribe opt-out table.
type UnsubscribeList struct {
	ID uint `json:"id" gorm:"primaryKey"`
	// UUID is the opaque, non-enumerable public handle (for hosted pages / webhook
	// payloads). The authenticated API still references the list by id.
	UUID        string `json:"uuid" gorm:"type:uuid;default:gen_random_uuid();uniqueIndex;not null"`
	UserID      uint   `json:"user_id" gorm:"index;not null"`
	WorkspaceID *uint  `json:"workspace_id,omitempty" gorm:"index"`
	Name        string `json:"name" gorm:"not null"` // unique per scope (internal label)
	// PublicName is shown to recipients on the unsubscribe/preference page. Falls
	// back to Name when empty.
	PublicName  string     `json:"public_name,omitempty"`
	Description string     `json:"description"`
	Active      bool       `json:"active" gorm:"default:true;not null"`
	CreatedAt   time.Time  `json:"created_at"`
	UpdatedAt   *time.Time `json:"updated_at"`

	User User `json:"-" gorm:"foreignKey:UserID"`
}