English Français العربية

io.github.zwebso/postlane

السجل الرسمي الإنتاجية

Send transactional email and read send activity through the Postlane API.

الشيفرة المصدرية الموقع التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package postlane-mcp
Claude Code 
claude mcp add postlane -e 'POSTLANE_API_KEY=<your postlane_api_key>' -- npx -y postlane-mcp@0.1.0
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "postlane": {
            "command": "npx",
            "args": [
                "-y",
                "postlane-mcp@0.1.0"
            ],
            "env": {
                "POSTLANE_API_KEY": "<your postlane_api_key>"
            }
        }
    }
}

متغيرات البيئة

  • POSTLANE_API_KEY إلزامي سري Bearer key from https://www.postlane.email/app/api-keys. It starts with pl_live_.

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. Postlane
  2. Send
  3. Cursor
  4. Development

Postlane

Postlane is a transactional email API. Applications use it to send welcome messages, address verification, password resets, and receipts from a verified domain.

Postlane is not an inbox, and it does not provide IMAP or hosted mailboxes.

Send

Create a key at API keys after you verify a sending domain. The secret is shown once and starts with pl_live_. Keep it on your server.

POST https://www.postlane.email/v1/emails
Authorization: Bearer pl_live_…
Content-Type: application/json
Idempotency-Key: welcome-user-123
{
  "from": "hello@send.yourdomain.com",
  "to": ["alex@example.com"],
  "subject": "Welcome",
  "html": "<h1>You’re in.</h1>"
}

A successful response is 202 with { "id": "em_…", "status": "queued" }. queued means the message was accepted for delivery. It does not mean the message is in the inbox. Repeating the same Idempotency-Key returns the original result and does not send again.

Errors use { "error": { "code", "message", "request_id", "retryable" } }. The same contract is published for agents at https://www.postlane.email/llms.txt.

Cursor

postlane-cursor/ is the Postlane plugin for Cursor. It teaches POST /v1/emails and exposes send_email, get_email, and list_emails. The API key is a plugin setting. It is not stored in this repository.

Development

npm install
npm run dev

Open http://localhost:5173. The first API request creates the local database schema. Local sends use a mock provider unless Email Sending is bound. accepted in that mode means the request was stored, not delivered.

npm test
npm run typecheck

Signed webhook delivery, attachments, and template versions are not part of the public API yet.

الأسئلة الشائعة

ما هو io.github.zwebso/postlane؟

Send transactional email and read send activity through the Postlane API.

كيف أثبّت io.github.zwebso/postlane؟

يعمل على جهازك. في Claude Code: claude mcp add postlane -e 'POSTLANE_API_KEY=<your postlane_api_key>' -- npx -y postlane-mcp@0.1.0. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.zwebso/postlane إلى مفتاح API؟

نعم. يتطلب POSTLANE_API_KEY، وتضبطها في إعداداته.

هل io.github.zwebso/postlane مفتوح المصدر؟

شيفرته علنية على GitHub، لكن المستودع لا يعلن ترخيصًا قياسيًا.

من يصون io.github.zwebso/postlane؟

ينشره zwebso. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.