19 Commits

Author SHA1 Message Date
89a991f3e6 feat: add MCP server, CLI, and Resend migration docs (Wave 4)
packages/mcp-server (@scribase-mail/mcp-server, MIT):
- 16 tools: send_email, batch_send_emails, get/list/cancel/reschedule
  email, list/get/create/verify/delete domain, list/create contact,
  list/get broadcast, list/get received emails
- Stdio transport entry (scribase-mail-mcp bin, npx-ready)
- Streamable HTTP transport: createWebHandler() for Next.js/edge,
  createNodeHandler() for Express/bare Node; standalone server on MCP_PORT
- ScribaseMailClient fetch wrapper; resolveApiKey reads
  SCRIBASE_MAIL_API_KEY | RESEND_API_KEY
- 11 vitest tests (mocked fetch); all pass

packages/cli (@scribase-mail/cli, MIT):
- scribase-mail bin using commander
- Commands: login (stores key in ~/.config/scribase-mail/config.json
  mode 600), emails send/get/list/cancel/reschedule, domains
  add/verify/list/get/delete, api-keys list/create/delete
- Respects SCRIBASE_MAIL_API_KEY | RESEND_API_KEY |
  SCRIBASE_MAIL_BASE_URL | RESEND_BASE_URL
- 9 vitest tests (mocked fs); all pass

apps/docs:
- guides/resend-migration.mdx: 1-minute migration, API compat matrix,
  differences table, env vars reference
- guides/supabase-smtp.mdx: custom SMTP setup with step-by-step Supabase
  guide (both dashboard and self-hosted env vars)
- guides/neon.mdx: Next.js + Neon quickstart (App Router server action +
  Pages Router API route, scheduling, error handling)
- guides/mcp-server.mdx: Claude Desktop, Cursor, remote HTTP, Caddy
  rewrite, tool table, env vars
- guides/cli.mdx: full CLI usage reference with jq examples
- guides/webhooks.mdx: added Svix ↔ X-UseSend-Signature mapping note
- docs.json: navigation updated to include all 5 new guide pages

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 03:51:34 +03:00
f0ceeaa2e0 feat: Scribase Mail branding, docs, deploy prep and AGPL notices
- rename product to Scribase Mail across web app, emails, marketing and docs
- new monochrome mark/favicons and neutral black/white theme; remove emoji UI
- source code link (AGPL-3.0) in sidebar, login and unsubscribe pages
- rewrite marketing site and self-hosting docs for OCI Email Delivery,
  add OCI notes page (event sources, unavailable features)
- add NOTICE and MERGE.md crediting useSend and listing changes
- add deploy/compose.scribase-mail.yml (web+postgres+redis, 1.47 GB limits),
  deploy/.env.example, Caddy site and DEPLOY.md for mail.scribase.com
- replace legacy provider env vars in turbo.json, CI, env examples, docker files
- OCI SDK packages as server externals for the standalone build

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 01:57:04 +03:00
KM Koushik
79f9049e40
docs: add campaign personalization guide (#374)
* docs: add campaign personalization guide

* docs: show best practices without accordions
2026-03-08 08:23:37 +11:00
Dave Stockley
ce8b780155
feat: add dashboard analytics to sdk and public api (#353) 2026-03-04 22:06:21 +11:00
Dave Stockley
7428a1fbfa
feat: add contactBooks to sdk, add delete campaign public endpoint (#352)
* feat: add contactBooks to sdk, add delete campaign public endpoint

* fix: pr review notes

* refactor: pr feedback

* feat: bulk delete/create contacts

* refactor: rename a few methods for consistency

* refactor: update openapi docs based on pr feedback

* refactor: update open api docs, based on pr feedback

* fix: delete campaign security issue

* refactor: delete campaign requires team id (from context)

* fix: enums
2026-03-04 07:10:43 +11:00
KM Koushik
e3e9635a5f
feat: add customizable contact double opt-in flow (#350)
* feat: add customizable contact double opt-in flow

* test: add double opt-in service coverage

* fix: address review comments for double opt-in PR

- Make pending status conditional on doubleOptInEnabled flag
- Backfill legacy unsubscribeReason for reliable pending detection
- Add doubleOptInContent to contact book listing select
- Fix duplicate toast on DOI editor subject save failure
- Harden searchParams parsing against string[] values
- Make default DOI template use link mark for clickable URL
- Make public API create+update atomic via transaction
- Prevent contact upsert failure when DOI email send fails
- Fix empty string template variable replacement

Co-authored-by: opencode <opencode@anthropic.com>

* fix: harden double opt-in confirmation safeguards

Preserve explicit unsubscribe intent in DOI flows and prevent confirmation links from re-subscribing opted-out contacts. Also sanitize subscribe-page error messaging and use timing-safe hash comparison for link verification.

* ui stuff

* fix: require doubleOptInUrl in double opt-in templates

* feat: add configurable from address for double opt-in emails

* feat: add resend confirmation flow for pending contacts

* fix: move subscribe confirmation to explicit POST flow

* test: add contact book public API endpoint coverage

* docs: add double opt-in documentation and update OpenAPI spec

Add a user guide for the double opt-in feature covering setup, contact
statuses, email customization, template variables, and best practices.
Update the OpenAPI spec to include doubleOptIn fields in all contactBook
request/response schemas.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: opencode <opencode@anthropic.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-01 00:34:20 +11:00
Vincent Vu
ed4a429a1d
fix(doc): Correct API reference in Go package documentation (#354)
* Correct API reference in Go package documentation

Updated description to reference the useSend API instead of Unsend API.

* Update documentation to reflect useSend branding

Added a issue to the package maintainer.

If maintainer isn't actively maintaining the package. Will fork it.

* fix(docs): remove community section and update Go SDK documentation

- Remove community section until content is ready.
- Update Go SDK docs to useSend implementation.
2026-02-17 07:43:13 +11:00
KM Koushik
8676965019
feat: add webhooks (#334) 2026-01-18 20:50:54 +11:00
Dave Stockley
6786ff003e
feat: contact books public api (#336)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-01-17 17:24:25 +11:00
Dave Stockley
68d951c55a
feat: v1/campaign public api endpoint (#335)
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
2026-01-11 09:37:57 +11:00
KM Koushik
367457997e
add changelog page (#275) 2025-10-19 06:57:23 +11:00
KM Koushik
a5ca3b2f87
add campaign api (#274)
Some checks failed
Publish Docker / Build and publish platform containers (map[context:. dockerfile:./docker/Dockerfile name:usesend], warp-ubuntu-latest-arm64-2x) (push) Has been cancelled
Publish Docker / Build and publish platform containers (map[context:. dockerfile:./docker/Dockerfile name:usesend], warp-ubuntu-latest-x64-2x) (push) Has been cancelled
Publish Docker / Build and publish platform containers (map[context:./apps/smtp-server dockerfile:./apps/smtp-server/Dockerfile name:smtp-proxy], warp-ubuntu-latest-arm64-2x) (push) Has been cancelled
Publish Docker / Build and publish platform containers (map[context:./apps/smtp-server dockerfile:./apps/smtp-server/Dockerfile name:smtp-proxy], warp-ubuntu-latest-x64-2x) (push) Has been cancelled
Publish Docker / Create and publish manifest (push) Has been cancelled
2025-10-18 10:31:43 +11:00
KM Koushik
2fe2d5cdab
update package version and response return tyupe for delete domain api (#272) 2025-10-11 06:37:24 +11:00
KM Koushik
76fdad6c81
feat: expose domain dns records via api (#259) 2025-09-27 09:40:14 +10:00
KM Koushik
4c4094619a
docs: remove MCP contextual options (#229) 2025-09-15 05:30:58 +10:00
KM Koushik
053fafb7cd
docs: add Railway self-hosting guide (#228) 2025-09-14 06:34:11 +10:00
KM Koushik
3158ddc51c
feat: add typed Python SDK (#213)
Some checks failed
Publish Docker / Build and publish platform containers (map[context:. dockerfile:./docker/Dockerfile name:usesend], warp-ubuntu-latest-arm64-2x) (push) Has been cancelled
Publish Docker / Build and publish platform containers (map[context:. dockerfile:./docker/Dockerfile name:usesend], warp-ubuntu-latest-x64-2x) (push) Has been cancelled
Publish Docker / Build and publish platform containers (map[context:./apps/smtp-server dockerfile:./apps/smtp-server/Dockerfile name:smtp-proxy], warp-ubuntu-latest-arm64-2x) (push) Has been cancelled
Publish Docker / Build and publish platform containers (map[context:./apps/smtp-server dockerfile:./apps/smtp-server/Dockerfile name:smtp-proxy], warp-ubuntu-latest-x64-2x) (push) Has been cancelled
Publish Docker / Create and publish manifest (push) Has been cancelled
2025-09-09 05:50:08 +10:00
KM Koushik
5b3022c27b update docs theme 2025-09-07 18:13:39 +10:00
KM Koushik
dbc9e3e976 update branding in docs 2025-09-03 22:46:03 +10:00