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.
Go email-relayemail-routinghttp-to-smtpmail-deliverymailchimp-alternativemailgun-alternativemailsendermailservermailtemplatemailtestpostmark-alternativesend-emailsendgrid-alternativesendmailtransactional-emailtransactional-outbox
docs: update core features capabilities
Jonas Kaninda5b86ecc59b2a
diff --git a/README.md b/README.mdindex 8df2317..c5849e2 100644--- a/README.md+++ b/README.md@@ -23,10 +23,11 @@## Overview-**Posta** is a self-hosted, developer-first email platform that handles both **outbound** and **inbound** email through a single HTTP API.+**Posta** is a self-hosted, developer-first email platform that handles **outbound**, **inbound**, and **relayed** email — driven by a single HTTP API, with SMTP available for the paths that need it.- **Outbound** — send transactional and marketing email over your own SMTP, with templates, localization, campaigns, subscriber lists, bounce and complaint handling, and delivery analytics.- **Inbound** — receive email at your domains, parse messages and attachments, and forward the structured payloads to your application via webhooks.+- **Relay** — point an existing SMTP client at Posta and its mail flows through the same outbound pipeline as the API, so you can migrate to the HTTP API at your own pace.It is designed as a fully self-hostable alternative to services like SendGrid, Mailgun, and Postmark — giving you complete ownership of your email infrastructure, data, and deliverability.@@ -86,6 +87,15 @@ Response:* Spam scoring & retry on failure* Real-time SSE stream for inbound notifications+### Email Relay++* Point an existing SMTP client at Posta — no code changes+* Relays into the same pipeline as the send API+* Domain verification, suppression & rate limits still apply+* Workspace-scoped credentials with IP allowlist+* Instant revocation, no redeploy+* Off by default — built for private networks+### Templates* Versioned and multi-language templates@@ -229,9 +239,12 @@ make dev-worker## API Documentation-* API Reference: [https://app.goposta.dev/docs](https://app.goposta.dev/docs)-* OpenAPI Spec: [https://app.goposta.dev/openapi.json](https://app.goposta.dev/openapi.json)-* Local: `/docs` on your Posta instance+Every Posta instance serves its own interactive API documentation:++* API Reference: `/docs` on your Posta instance+* OpenAPI Spec: `/openapi.json` on your Posta instance++Running locally with the default port, that is [http://localhost:9000/docs](http://localhost:9000/docs).---# Dashboarddiff --git a/docs/docs/admin/oauth-providers.md b/docs/docs/admin/oauth-providers.mdindex 5dbadf0..29f794c 100644--- a/docs/docs/admin/oauth-providers.md+++ b/docs/docs/admin/oauth-providers.md@@ -9,7 +9,7 @@ description: Configure OAuth / SSO providers for user authenticationAdministrators can configure OAuth 2.0 / OpenID Connect providers to allow users to log in via single sign-on. Any OIDC-compliant identity provider is supported.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Supported Provider Typesdiff --git a/docs/docs/admin/plans.md b/docs/docs/admin/plans.mdindex e335ced..453100e 100644--- a/docs/docs/admin/plans.md+++ b/docs/docs/admin/plans.md@@ -9,7 +9,7 @@ description: Configure plans with rate limits and resource quotasPlans define resource limits and rate quotas for workspaces. Administrators can create plans with different tiers and assign them to workspaces.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Creating a Plandiff --git a/docs/docs/admin/platform-settings.md b/docs/docs/admin/platform-settings.mdindex 2a68aa0..08fd221 100644--- a/docs/docs/admin/platform-settings.md+++ b/docs/docs/admin/platform-settings.md@@ -9,7 +9,7 @@ description: Configure platform-wide settingsAdministrators can configure platform-wide settings that affect all users via the dashboard or `GET/PUT /api/v1/admin/settings`.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Get Settingsdiff --git a/docs/docs/campaigns/ab-testing.md b/docs/docs/campaigns/ab-testing.mdindex 401d55a..430fda8 100644--- a/docs/docs/campaigns/ab-testing.md+++ b/docs/docs/campaigns/ab-testing.md@@ -9,7 +9,7 @@ description: Test email variants with split audience campaignsRun A/B tests by splitting your subscriber list across multiple email variants. Compare performance to find the most effective subject line, content, or design.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Creating an A/B Test Campaigndiff --git a/docs/docs/campaigns/overview.md b/docs/docs/campaigns/overview.mdindex ccc699e..e6cf0d3 100644--- a/docs/docs/campaigns/overview.md+++ b/docs/docs/campaigns/overview.md@@ -9,7 +9,7 @@ description: Create and send email campaigns to subscriber listsCampaigns let you send template-based emails to subscriber lists. They support scheduling, send rate control, A/B testing, and lifecycle management (pause, resume, cancel).:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Creating a Campaigndiff --git a/docs/docs/campaigns/sending.md b/docs/docs/campaigns/sending.mdindex 60513d6..921c113 100644--- a/docs/docs/campaigns/sending.md+++ b/docs/docs/campaigns/sending.md@@ -9,7 +9,7 @@ description: Send, pause, resume, and cancel campaignsManage the full lifecycle of a campaign: send, pause, resume, cancel, and duplicate.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Sending a Campaigndiff --git a/docs/docs/email-sending/attachments.md b/docs/docs/email-sending/attachments.mdindex 0c1b7f2..6c9e839 100644--- a/docs/docs/email-sending/attachments.md+++ b/docs/docs/email-sending/attachments.md@@ -9,7 +9,7 @@ description: Send emails with file attachmentsAttach files to emails by providing base64-encoded content in the `attachments` array.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Examplediff --git a/docs/docs/email-sending/batch-email.md b/docs/docs/email-sending/batch-email.mdindex 520716a..d0aead1 100644--- a/docs/docs/email-sending/batch-email.md+++ b/docs/docs/email-sending/batch-email.md@@ -9,7 +9,7 @@ description: Send emails to multiple recipients efficientlySend template-based emails to multiple recipients in a single API call, with per-recipient variable customization.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Examplediff --git a/docs/docs/email-sending/email-log.md b/docs/docs/email-sending/email-log.mdindex 6943a0a..a713c86 100644--- a/docs/docs/email-sending/email-log.md+++ b/docs/docs/email-sending/email-log.md@@ -16,7 +16,7 @@ X-Posta-Workspace-Id: 1```:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## List Emailsdiff --git a/docs/docs/email-sending/email-status.md b/docs/docs/email-sending/email-status.mdindex 2305b5f..cb2cb64 100644--- a/docs/docs/email-sending/email-status.md+++ b/docs/docs/email-sending/email-status.md@@ -9,7 +9,7 @@ description: Track email delivery statusCheck the delivery status of a sent email by its UUID.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Examplediff --git a/docs/docs/email-sending/email-verification.md b/docs/docs/email-sending/email-verification.mdindex e8e5dc2..04b40a4 100644--- a/docs/docs/email-sending/email-verification.md+++ b/docs/docs/email-sending/email-verification.md@@ -13,7 +13,7 @@ POST /api/v1/emails/verify```:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.::::::notediff --git a/docs/docs/email-sending/single-email.md b/docs/docs/email-sending/single-email.mdindex 000a20f..02a42d4 100644--- a/docs/docs/email-sending/single-email.md+++ b/docs/docs/email-sending/single-email.md@@ -9,7 +9,7 @@ description: Send a single email via the APISend a single email with HTML/text content, optional attachments, custom headers, and scheduled delivery.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Examplediff --git a/docs/docs/email-sending/template-email.md b/docs/docs/email-sending/template-email.mdindex fcf6fff..20a0a63 100644--- a/docs/docs/email-sending/template-email.md+++ b/docs/docs/email-sending/template-email.md@@ -9,7 +9,7 @@ description: Send emails using pre-defined templatesSend emails using pre-defined templates with variable substitution and multi-language support.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Examplediff --git a/docs/docs/getting-started/introduction.md b/docs/docs/getting-started/introduction.mdindex 3490839..c7ac35f 100644--- a/docs/docs/getting-started/introduction.md+++ b/docs/docs/getting-started/introduction.md@@ -20,6 +20,7 @@ description: What is Posta and why use it| Feature | Description ||---------|-------------|| **Email Delivery** | Send single, template, and batch emails via REST API with scheduled sending and automatic retries |+| **Email Relay** | Point an existing SMTP client at Posta and relay its mail through the same outbound pipeline as the API || **Templates** | Version-controlled templates with multi-language support, variable substitution, and stylesheet inlining || **SMTP Management** | Configure multiple SMTP servers with TLS support and shared pools || **Domain Verification** | SPF, DKIM, and DMARC record verification with verified sender enforcement |@@ -37,12 +38,12 @@ description: What is Posta and why use it## API Reference-Posta provides interactive API documentation:+Every Posta instance serves its own interactive API documentation:-- **Swagger UI** — [https://app.goposta.dev/docs](https://app.goposta.dev/docs)-- **OpenAPI spec** — [https://app.goposta.dev/openapi.json](https://app.goposta.dev/openapi.json)+- **API Reference** — `/docs` on your Posta instance+- **OpenAPI spec** — `/openapi.json` on your Posta instance-When running locally, the docs are available at `/docs` on your Posta instance.+Running locally with the default port, that is [http://localhost:9000/docs](http://localhost:9000/docs).## Architecturediff --git a/docs/docs/security/api-keys.md b/docs/docs/security/api-keys.mdindex 5b96427..e58223e 100644--- a/docs/docs/security/api-keys.md+++ b/docs/docs/security/api-keys.md@@ -9,7 +9,7 @@ description: Create and manage API keysAPI keys provide programmatic access to Posta's email sending and status APIs. Keys are scoped to a workspace and managed under `/api/v1/workspaces/current/api-keys`.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Creating a Keydiff --git a/docs/docs/smtp-domains/smtp-servers.md b/docs/docs/smtp-domains/smtp-servers.mdindex 9ba4d2f..ade56ca 100644--- a/docs/docs/smtp-domains/smtp-servers.md+++ b/docs/docs/smtp-domains/smtp-servers.md@@ -9,7 +9,7 @@ description: Configure SMTP servers for email deliveryConfigure one or more SMTP servers for email delivery. Posta routes emails through your configured SMTP servers.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Adding an SMTP Serverdiff --git a/docs/docs/subscribers/bulk-import.md b/docs/docs/subscribers/bulk-import.mdindex 2b71939..18876b7 100644--- a/docs/docs/subscribers/bulk-import.md+++ b/docs/docs/subscribers/bulk-import.md@@ -9,7 +9,7 @@ description: Import subscribers from JSON and CSV filesImport subscribers in bulk using JSON or CSV formats.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.::::::notediff --git a/docs/docs/subscribers/subscriber-lists.md b/docs/docs/subscribers/subscriber-lists.mdindex b56ec81..ffbb333 100644--- a/docs/docs/subscribers/subscriber-lists.md+++ b/docs/docs/subscribers/subscriber-lists.md@@ -9,7 +9,7 @@ description: Organize subscribers into static and dynamic listsSubscriber lists group subscribers for use in campaigns. Lists can be **static** (manually managed) or **dynamic** (rule-based segments).:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.::::::notediff --git a/docs/docs/subscribers/subscriber-management.md b/docs/docs/subscribers/subscriber-management.mdindex cf8038b..6e6e5c1 100644--- a/docs/docs/subscribers/subscriber-management.md+++ b/docs/docs/subscribers/subscriber-management.md@@ -9,7 +9,7 @@ description: Create and manage email subscribersSubscribers represent people who receive campaign emails. Each subscriber has an email, optional profile data, custom fields, and a status.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.::::::notediff --git a/docs/docs/webhooks/overview.md b/docs/docs/webhooks/overview.mdindex 2e147de..7a6e998 100644--- a/docs/docs/webhooks/overview.md+++ b/docs/docs/webhooks/overview.md@@ -9,7 +9,7 @@ description: Real-time webhooks for email eventsReceive real-time HTTP notifications when email events occur. Posta sends POST requests to your configured URLs with event details.:::tip-For the full request/response schema, see the interactive [API Reference](https://app.goposta.dev/docs).+For the full request/response schema, see the interactive API Reference at `/docs` on your Posta instance.:::## Creating a Webhookdiff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.tsindex 8a44496..08b138a 100644--- a/docs/docusaurus.config.ts+++ b/docs/docusaurus.config.ts@@ -60,11 +60,6 @@ const config: Config = {position: 'left',label: 'Documentation',},- {- href: 'https://app.goposta.dev/docs',- label: 'API Reference',- position: 'left',- },{to: '/docs/sdks/overview',label: 'SDKs',@@ -84,7 +79,6 @@ const config: Config = {title: 'Documentation',items: [{label: 'Getting Started', to: '/docs/getting-started/introduction'},- {label: 'API Reference', href: 'https://app.goposta.dev/docs'},{label: 'SDKs', to: '/docs/sdks/overview'},],},diff --git a/docs/sidebars.ts b/docs/sidebars.tsindex d54620f..84923ae 100644--- a/docs/sidebars.ts+++ b/docs/sidebars.ts@@ -169,11 +169,6 @@ const sidebars: SidebarsConfig = {'sdks/java',],},- {- type: 'link',- label: 'API Reference',- href: 'https://app.goposta.dev/docs',- },],};