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.

5.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 dto

// This file defines documentation-only payload shapes for the webhooks Posta
// POSTs to subscriber URLs.
type WebhookEvent struct {
	Event     string `json:"event"`
	EmailID   string `json:"email_id"`
	Timestamp string `json:"timestamp"`
}

// CampaignWebhookEvent is the payload for campaign lifecycle events
// (campaign.started, campaign.completed).
type CampaignWebhookEvent struct {
	Event      string `json:"event"`
	CampaignID uint   `json:"campaign_id"`
	Name       string `json:"name"`
	Timestamp  string `json:"timestamp"`
}

// ComplaintWebhookEvent is the payload for email.complained.
type ComplaintWebhookEvent struct {
	Event     string `json:"event"`
	EmailUUID string `json:"email_uuid"`
	Email     string `json:"email"`
	Timestamp string `json:"timestamp"`
}

// UnsubscribeWebhookEvent is the payload for email.unsubscribed.
type UnsubscribeWebhookEvent struct {
	Event     string `json:"event"`
	EmailUUID string `json:"email_uuid"`
	Email     string `json:"email"`
	ListID    *uint  `json:"list_id,omitempty"`
	Timestamp string `json:"timestamp"`
}

// InboundWebhookEvent is the payload for email.inbound.
type InboundWebhookEvent struct {
	Event       string                     `json:"event"`
	Timestamp   string                     `json:"timestamp"`
	InboundID   string                     `json:"inbound_id"`
	From        string                     `json:"from"`
	To          []string                   `json:"to"`
	Subject     string                     `json:"subject"`
	TextBody    string                     `json:"text_body,omitempty"`
	HTMLBody    string                     `json:"html_body,omitempty"`
	Headers     map[string]string          `json:"headers,omitempty"`
	Attachments []InboundWebhookAttachment `json:"attachments,omitempty"`
	Size        int64                      `json:"size"`
	MessageID   string                     `json:"message_id,omitempty"`
	Source      string                     `json:"source"`
	ReceivedAt  string                     `json:"received_at"`
}

// InboundWebhookAttachment describes an attachment in an InboundWebhookEvent.
type InboundWebhookAttachment struct {
	Filename    string `json:"filename"`
	ContentType string `json:"content_type"`
	Size        int64  `json:"size"`
	URL         string `json:"url,omitempty"`
}

// MessageWebhookEvent is the payload for message.received and message.spam.
type MessageWebhookEvent struct {
	Event       string                `json:"event"`
	Timestamp   string                `json:"timestamp"`
	MessageID   string                `json:"message_id"`
	FormID      string                `json:"form_id"`
	FormName    string                `json:"form_name"`
	SenderEmail string                `json:"sender_email,omitempty"`
	SenderName  string                `json:"sender_name,omitempty"`
	SenderPhone string                `json:"sender_phone,omitempty"`
	Subject     string                `json:"subject,omitempty"`
	Body        string                `json:"body,omitempty"`
	Fields      []MessageWebhookField `json:"fields,omitempty"`
	Status      string                `json:"status"`
	SpamScore   float64               `json:"spam_score"`
	ScanReasons []string              `json:"scan_reasons,omitempty"`
	ClientIP    string                `json:"client_ip,omitempty"`
	ReceivedAt  string                `json:"received_at"`
}

// MessageReplyWebhookEvent is the payload for message.replied (an operator
// answered from the dashboard) and message.reply_received (the submitter
// answered the thread by email).
type MessageReplyWebhookEvent struct {
	Event          string `json:"event"`
	Timestamp      string `json:"timestamp"`
	MessageID      string `json:"message_id"`
	ReplyID        string `json:"reply_id"`
	FormID         string `json:"form_id"`
	FormName       string `json:"form_name"`
	Kind           string `json:"kind" enum:"operator,inbound"`
	From           string `json:"from"`
	To             string `json:"to"`
	Subject        string `json:"subject,omitempty"`
	TextBody       string `json:"text_body,omitempty"`
	HTMLBody       string `json:"html_body,omitempty"`
	EmailID        string `json:"email_id,omitempty" doc:"The outbound email carrying an operator reply, for delivery status."`
	SenderMismatch bool   `json:"sender_mismatch,omitempty" doc:"An inbound reply came from an address other than the original submitter."`
	CreatedAt      string `json:"created_at"`
}

// MessageWebhookField is one submitted form field in a MessageWebhookEvent.
type MessageWebhookField struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}