postmarkwebhook

type Bounce struct {
	// Message supplies shared context; Email is the affected address here.
	// Example: _ = notification.MessageID
	Message
	// ID is the provider's numeric bounce or complaint identifier.
	// Example: _ = notification.ID
	ID int64 `json:"ID"`
	// Type is the provider category, such as HardBounce or SpamComplaint.
	// Example: _ = notification.Type
	Type string `json:"Type"`
	// Email is the affected recipient address.
	// Example: _ = notification.Email
	Email string `json:"Email"`
	// Description is the provider's explanation, not a client-safe error.
	// Example: _ = notification.Description
	Description string `json:"Description"`
	// BouncedAt is the provider's event time for bounces and complaints.
	// Example: _ = notification.BouncedAt.UTC()
	BouncedAt time.Time `json:"BouncedAt"`
	// Inactive reports whether Postmark deactivated the address.
	// Example: _ = notification.Inactive
	Inactive bool `json:"Inactive"`
}

type Delivery struct {
	// Message supplies shared message context.
	// Example: _ = notification.MessageID
	Message
	// DeliveredAt is the provider's acceptance time, decoded from ISO 8601.
	// Example: _ = notification.DeliveredAt.UTC()
	DeliveredAt time.Time `json:"DeliveredAt"`
	// Details contains the remote mail server's response and may be sensitive.
	// Example: _ = notification.Details
	Details string `json:"Details"`
}

type Email struct {
	// MessageID identifies the received email across processing retries.
	// Example: _ = notification.MessageID
	MessageID string `json:"MessageID"`
	// From is the sender's address claim, not an authenticated application user.
	// Example: _ = notification.From
	From string `json:"From"`
	// To contains the formatted recipient list.
	// Example: _ = notification.To
	To string `json:"To"`
	// Subject is untrusted message subject text.
	// Example: _ = notification.Subject
	Subject string `json:"Subject"`
	// Date retains the sender-selected timestamp format unchanged.
	// Example: _ = notification.Date
	Date string `json:"Date"`
	// TextBody is the plain text content, possibly empty.
	// Example: _ = notification.TextBody
	TextBody string `json:"TextBody"`
	// HTMLBody is unsanitized HTML; never render it without sanitization.
	// Example: _ = notification.HTMLBody
	HTMLBody string `json:"HtmlBody"`
	// StrippedTextReply is Postmark's extracted reply text when available.
	// Example: _ = notification.StrippedTextReply
	StrippedTextReply string `json:"StrippedTextReply"`
}

type Envelope struct {
	// RecordType selects the native event binding; inbound email uses "Inbound".
	// Example: _ = postmarkwebhook.Envelope{RecordType: "Open"}
	RecordType string
	// Body owns the original JSON, decoded only when the event is bound.
	// Example: _ = json.Unmarshal(envelope.Body, &notification)
	Body jsontext.Value
}

type Message struct {
	// MessageID identifies the email, not an individual open or click.
	// Example: _ = notification.MessageID
	MessageID string `json:"MessageID"`
	// MessageStream is the stream configured in Postmark.
	// Example: _ = notification.MessageStream
	MessageStream string `json:"MessageStream"`
	// Recipient is the destination address for delivery and tracking events.
	// Example: _ = notification.Recipient
	Recipient string `json:"Recipient"`
	// Tag is the application's optional message label.
	// Example: _ = notification.Tag
	Tag string `json:"Tag"`
	// Metadata carries application-supplied string attributes.
	// Example: _ = notification.Metadata["order"]
	Metadata map[string]string `json:"Metadata"`
	// ServerID identifies the server when supplied by the event type.
	// Example: _ = notification.ServerID
	ServerID int64 `json:"ServerID"`
}

type Subscription struct {
	// Message supplies stream and recipient context.
	// Example: _ = notification.Recipient
	Message
	// ChangedAt is when the suppression changed at Postmark.
	// Example: _ = notification.ChangedAt.UTC()
	ChangedAt time.Time `json:"ChangedAt"`
	// SuppressSending is the resulting suppression state.
	// Example: _ = notification.SuppressSending
	SuppressSending bool `json:"SuppressSending"`
	// Origin identifies what initiated the change, such as Recipient.
	// Example: _ = notification.Origin
	Origin string `json:"Origin"`
	// SuppressionReason contains the provider reason, when supplied.
	// Example: _ = notification.SuppressionReason
	SuppressionReason string `json:"SuppressionReason"`
}

type Tracking struct {
	// Message supplies shared message context.
	// Example: _ = notification.MessageID
	Message
	// ReceivedAt is the provider's observation time, not local receipt time.
	// Example: _ = notification.ReceivedAt.UTC()
	ReceivedAt time.Time `json:"ReceivedAt"`
	// FirstOpen distinguishes the first recorded open for the message.
	// Example: _ = notification.FirstOpen
	FirstOpen bool `json:"FirstOpen"`
	// OriginalLink is the original clicked URL and may contain private tokens.
	// Example: _ = notification.OriginalLink
	OriginalLink string `json:"OriginalLink"`
	// ClickLocation is the provider's body location, such as HTML.
	// Example: _ = notification.ClickLocation
	ClickLocation string `json:"ClickLocation"`
	// UserAgent describes the opener or clicker and is untrusted input.
	// Example: _ = notification.UserAgent
	UserAgent string `json:"UserAgent"`
}