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.

docs: update README and update support contact

Jonas Kaninda092ea7aa16ad
diff --git a/README.md b/README.md
index 29d1b58..98a077e 100644
--- a/README.md
+++ b/README.md
@@ -40,18 +40,21 @@ curl -X POST http://localhost:9000/api/v1/emails/send \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
- "from": "[email protected]",
+ "from": "Acme <[email protected]>",
"to": ["[email protected]"],
"subject": "Hello from Posta",
"html": "<h1>Hello!</h1>"
}'
```
+> The `from`, `to`, and other address fields accept a plain address (`[email protected]`)
+> or RFC 5322 display-name format (`Acme <[email protected]>`).
+
Response:
```json
{
- "id": "email_01J8C8E5W3",
+ "id": "0ae4b04e-5c64-4b2f-bad6-460f8d5d98b3",
"status": "queued"
}
```
@@ -64,6 +67,7 @@ Response:
* REST API for transactional, batch, and templated emails
* Attachments, custom headers, and unsubscribe support
+* Web view ("view in browser") with signed, expiring links
* Scheduled sending and preview mode
* Async processing with Redis and Asynq
* Automatic retries and priority queues
@@ -81,6 +85,7 @@ Response:
* Versioned and multi-language templates
* Variable substitution and stylesheet inlining
+* System variables for web view and one-click unsubscribe links
* Import/export and preview support
### Campaigns
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
index cd4df6f..6159b8a 100644
--- a/docs/sidebars.ts
+++ b/docs/sidebars.ts
@@ -36,6 +36,7 @@ const sidebars: SidebarsConfig = {
'templates/stylesheets',
'templates/preview-and-test',
'templates/import-export',
+ 'templates/system-variables',
],
},
{
diff --git a/docs/static/img/screenshots/admin-platform-metrics-dark.png b/docs/static/img/screenshots/admin-platform-metrics-dark.png
index 049b51d..9e34a74 100644
Binary files a/docs/static/img/screenshots/admin-platform-metrics-dark.png and b/docs/static/img/screenshots/admin-platform-metrics-dark.png differ
diff --git a/docs/static/img/screenshots/admin-platform-metrics.png b/docs/static/img/screenshots/admin-platform-metrics.png
index fcfe370..7015fa7 100644
Binary files a/docs/static/img/screenshots/admin-platform-metrics.png and b/docs/static/img/screenshots/admin-platform-metrics.png differ
diff --git a/docs/static/img/screenshots/analytics.png b/docs/static/img/screenshots/analytics.png
index 8eb18e9..7c7bd7b 100644
Binary files a/docs/static/img/screenshots/analytics.png and b/docs/static/img/screenshots/analytics.png differ
diff --git a/docs/static/img/screenshots/template-detail.png b/docs/static/img/screenshots/template-detail.png
index 54340af..f45f756 100644
Binary files a/docs/static/img/screenshots/template-detail.png and b/docs/static/img/screenshots/template-detail.png differ
diff --git a/docs/static/img/screenshots/template-editor.png b/docs/static/img/screenshots/template-editor.png
index 48417de..a7a1328 100644
Binary files a/docs/static/img/screenshots/template-editor.png and b/docs/static/img/screenshots/template-editor.png differ
diff --git a/internal/config/config.go b/internal/config/config.go
index 3e12994..dc17b9e 100644
--- a/internal/config/config.go
+++ b/internal/config/config.go
@@ -316,9 +316,9 @@ func (c *Config) Initialize(app *okapi.Okapi) error {
URL: "http://www.apache.org/licenses/LICENSE-2.0",
},
Contact: okapi.Contact{
- Name: "Posta",
+ Name: "Support",
URL: "https://github.com/goposta/posta",
- Email: "[email protected]",
+ Email: "[email protected]",
},
Servers: apiServers,
SecuritySchemes: c.securitySchemes,