# Lumail.io
> The AI-native email platform for newsletters, automations, and transactional email.

Prefer MCP, the CLI, or the TypeScript SDK for live organization operations. Docs links below are markdown. Fetch only the pages you need; /llms-full.txt concatenates every page.

## Agents
- [Claude Code (Plugin)](https://lumail.io/docs/ai-integration/mcp-claude.md): Install the Lumail plugin in Claude Code. Browser sign-in, no API token.
- [Codex (Plugin)](https://lumail.io/docs/ai-integration/mcp-codex.md): Connect the Codex CLI and app over OAuth.
- [ChatGPT Plugin](https://lumail.io/docs/ai-integration/chatgpt-plugin.md): Connect Lumail as a ChatGPT OAuth app.
- [Cursor (MCP)](https://lumail.io/docs/ai-integration/mcp-cursor.md): Connect Cursor over MCP.
- [Skills (CLI)](https://lumail.io/docs/ai-integration/skills-cli.md): Skills plus CLI for visible terminal commands and reusable workflows.
- [SDK Introduction](https://lumail.io/docs/sdk/introduction.md): Typed TypeScript SDK for apps, backends, and automations.
- [API Reference](https://lumail.io/docs/api-reference.md): REST API reference.
- [Claude Code install](https://lumail.io/claude-code/install): Executable markdown install contract.
- [Codex install](https://lumail.io/codex/install): Executable markdown install contract.
- [CLI install](https://lumail.io/cli/install): Executable markdown install contract.
- [MCP install](https://lumail.io/mcp/install): Executable markdown install contract.

## Docs
- [Documentation](https://lumail.io/docs.md): Learn how to build with Lumail - the AI-powered email marketing platform for creators and small teams.
- [SMTP](https://lumail.io/docs/smtp.md): Connect SMTP-only tools to Lumail transactional email.
- [Surveys](https://lumail.io/docs/survey.md): One-click polls inside an email — buttons, yes/no, emoji, and NPS, each stacked the same way the recipient sees them.

## Ship with Email
- [Ship with Email](https://lumail.io/docs/playbooks.md): Turn a product release, offer, or changelog into an owned-list launch while the rest of the product ships.
- [Choose an Email MCP for Claude Code, Then Ship the Launch](https://lumail.io/docs/playbooks/email-mcp-claude-code-product-launch.md): Compare email MCPs by real launch work, connect Claude Code, and turn verified release evidence into a campaign your owned list can act on.
- [Send a Newsletter from Cursor, Then Ship the Launch](https://lumail.io/docs/playbooks/send-newsletter-from-cursor.md): Connect Cursor to your email stack, turn release evidence into a saved campaign, review the audience and render, and approve delivery deliberately.
- [Move a Launch List from Kit Without Paying for Dormant Subscribers](https://lumail.io/docs/playbooks/move-launch-list-from-kit.md): Test a send-volume-priced Kit alternative with one real launch before moving your audience, automations, and suppression history.

## Tutorials
- [Tutorials](https://lumail.io/docs/tutorials.md): Step-by-step guides to build real-world email marketing automations with Lumail.
- [Create an API Token](https://lumail.io/docs/tutorials/create-api-token.md): Step-by-step guide to generating API tokens for authenticating your Lumail API requests.
- [Send Transactional Email with SMTP](https://lumail.io/docs/tutorials/smtp-transactional-emails.md): Configure your organization to send transactional email through Lumail from SMTP-only tools.
- [Send React Email Templates with Lumail](https://lumail.io/docs/tutorials/react-email.md): Build transactional email templates as React components, render them to HTML, and send them through the Lumail transactional email API.
- [Build a V0 Capture Page](https://lumail.io/docs/tutorials/v0-capture-page.md): Guide to generating a Lumail-branded capture page with V0.dev and wiring it to the Subscribers API.
- [Dynamic Promo Codes with Webhooks](https://lumail.io/docs/tutorials/dynamic-promo-codes.md): Create unique, time-limited promo codes for each subscriber using workflow webhooks and custom fields.

## AI Integration
- [AI Integration](https://lumail.io/docs/ai-integration.md): Connect ChatGPT, Claude, Hermes, or OpenClaw to Lumail, or use the SDK and Tools API for custom integrations.
- [Claude Code (Plugin)](https://lumail.io/docs/ai-integration/mcp-claude.md): Install the Lumail plugin in Claude Code with OAuth—no API token to create, paste, or rotate.
- [Codex (Plugin)](https://lumail.io/docs/ai-integration/mcp-codex.md): Connect the Codex CLI and Codex app to Lumail over OAuth—no API token in config.toml.
- [ChatGPT Plugin](https://lumail.io/docs/ai-integration/chatgpt-plugin.md): Connect ChatGPT to Lumail with OAuth—no API token to copy or store.
- [Hermes](https://lumail.io/docs/ai-integration/hermes.md): Paste one prompt in Hermes Agent and it installs the Lumail CLI and skill, authenticates, and verifies the connection for you.
- [Skills (CLI)](https://lumail.io/docs/ai-integration/skills-cli.md): Install Lumail as a Claude Code skill with the CLI for terminal-based AI workflows - manage subscribers, campaigns, and emails from natural language.
- [OpenClaw](https://lumail.io/docs/ai-integration/openclaw.md): Install the Lumail skill and CLI via ClawHub for OpenClaw.
- [Cursor (MCP)](https://lumail.io/docs/ai-integration/mcp-cursor.md): Add Lumail tools to Cursor IDE for AI-assisted email marketing directly from your editor.
- [TypeScript SDK Integrations](https://lumail.io/docs/ai-integration/sdk-agents.md): Use the Lumail TypeScript SDK in web apps, backend services, scripts, and product automations.
- [Tools API (v2)](https://lumail.io/docs/ai-integration/tools-api.md): Call any Lumail tool via a single REST endpoint - works with any language or AI framework.
- [Examples & Recipes](https://lumail.io/docs/ai-integration/examples.md): Real-world AI agent workflows and automation patterns using Lumail's API.

## SDK
- [SDK Introduction](https://lumail.io/docs/sdk/introduction.md): Understand what the Lumail TypeScript SDK is for and when to use it in your application.
- [SDK Configuration](https://lumail.io/docs/sdk/configuration.md): Configure the Lumail TypeScript SDK client, API key, base URL, and runtime environment.
- [SDK Resources](https://lumail.io/docs/sdk/resources.md): Use the Lumail SDK resource clients for subscribers, campaigns, transactional emails, tags, and events.
- [SDK Tools](https://lumail.io/docs/sdk/tools.md): Call Lumail V2 tools from server-side TypeScript code through the SDK.
- [Errors and Retries](https://lumail.io/docs/sdk/errors-retries.md): Handle Lumail SDK typed errors, rate limits, and retry behavior.

## API Reference
- [API Reference](https://lumail.io/docs/api-reference.md): Complete API documentation for Lumail.io integration
- [API Tokens](https://lumail.io/docs/api-reference/api-tokens.md): Learn how to create and use API tokens to authenticate your API requests
- [TypeScript SDK](https://lumail.io/docs/api-reference/sdk.md): Official TypeScript SDK for the Lumail API - type-safe client with full autocompletion for subscribers, campaigns, emails, tags, events, and tools.
- [CLI](https://lumail.io/docs/api-reference/cli.md): Lumail command-line interface for managing subscribers, campaigns, emails, tags, events, and tools from your terminal.
- [MCP Server](https://lumail.io/docs/api-reference/mcp.md): Connect Claude, Cursor, ChatGPT, Codex, or another MCP client to Lumail's canonical email marketing tools.
- [Tools API (v2)](https://lumail.io/docs/api-reference/v2-tools.md): Execute any Lumail tool via REST API - unified endpoint for all operations
- [Admin Tools API](https://lumail.io/docs/api-reference/admin-tools.md): Internal automation API for Lumail administrators - execute admin tools across all organizations with a single endpoint
- [Rate Limits](https://lumail.io/docs/api-reference/api-limits.md): Understanding API rate limits, headers, and best practices for handling rate-limited requests
- [SMTP Endpoint](https://lumail.io/docs/api-reference/smtp.md): Send transactional email through Lumail from SMTP-only tools
- [Send Transactional Email](https://lumail.io/docs/api-reference/api-emails-send.md): Send individual transactional emails without requiring a campaign
- [Email Verification API](https://lumail.io/docs/api-reference/api-email-verify-post.md): Verify email addresses before adding them to your list
- [Create Subscriber](https://lumail.io/docs/api-reference/api-subscribers-post.md): Add a new subscriber to your Lumail account
- [Get Subscriber](https://lumail.io/docs/api-reference/api-subscribers-get.md): Retrieve a specific subscriber from your Lumail account
- [Update Subscriber](https://lumail.io/docs/api-reference/api-subscribers-patch.md): Update an existing subscriber in your Lumail account
- [Delete Subscriber](https://lumail.io/docs/api-reference/api-subscribers-delete.md): Remove a subscriber from your Lumail account
- [Add Tags to Subscriber](https://lumail.io/docs/api-reference/api-subscriber-tags-post.md): Add one or more tags to an existing subscriber
- [Remove Tags from Subscriber](https://lumail.io/docs/api-reference/api-subscriber-tags-delete.md): Remove one or more tags from an existing subscriber
- [Track Event](https://lumail.io/docs/api-reference/api-events-post.md): Record a new subscriber event in your Lumail account
- [Get Subscriber Events](https://lumail.io/docs/api-reference/api-subscriber-events-get.md): Retrieve the event history for a specific subscriber
- [Get All Tags](https://lumail.io/docs/api-reference/api-tags-get.md): Retrieve a list of all tags in your Lumail account
- [Create a Tag](https://lumail.io/docs/api-reference/api-tags-post.md): Create a new tag in your Lumail account
- [List All Campaigns](https://lumail.io/docs/api-reference/api-campaigns-get.md): Retrieve a paginated list of campaigns in your Lumail account
- [Create Campaign](https://lumail.io/docs/api-reference/api-campaigns-post.md): Create a new email campaign in your Lumail account
- [Get Campaign](https://lumail.io/docs/api-reference/api-campaign-get.md): Retrieve details for a specific campaign by ID
- [Update Campaign](https://lumail.io/docs/api-reference/api-campaign-patch.md): Update an existing campaign by ID
- [Delete Campaign](https://lumail.io/docs/api-reference/api-campaign-delete.md): Delete a campaign by ID
- [Send Campaign](https://lumail.io/docs/api-reference/api-campaign-send.md): Send or schedule a campaign for delivery
- [Send Email in HTML](https://lumail.io/docs/api-reference/api-emails-html.md): Send transactional emails using raw HTML content
- [Send Email in Markdown](https://lumail.io/docs/api-reference/api-emails-markdown.md): Send transactional emails using Markdown content format
- [Send Email in Tiptap](https://lumail.io/docs/api-reference/api-emails-tiptap.md): Send transactional emails using Tiptap JSON format (same as Lumail editor)
- [List Subscribers](https://lumail.io/docs/api-reference/api-subscribers-list.md): List subscribers in your Lumail account with optional filters
- [Get Tag by ID or Name](https://lumail.io/docs/api-reference/api-tag-get.md): Retrieve a specific tag with subscriber count from your Lumail account

## Integrations
- [Integrations](https://lumail.io/docs/integrations.md): Connect Lumail.io with your favorite platforms and tools
- [ClickFunnels Integration](https://lumail.io/docs/integrations/clickfunnel-integration.md): Automatically sync contacts, tags, and order events from ClickFunnels to Lumail using webhooks
- [SystemIO Integration](https://lumail.io/docs/integrations/systemio-integration.md): Automatically sync contacts and tags from SystemIO to Lumail using webhooks

## Features
- [Features](https://lumail.io/docs/features.md): Discover advanced features and capabilities of Lumail.io
- [Affiliate Program](https://lumail.io/docs/features/affiliate-program.md): Create your Lumail referral link and understand Creator, Pro, and Business rewards
- [Account Verification](https://lumail.io/docs/features/account-verification.md): How sending gets unlocked automatically when you verify your domain, and how your sender score keeps it unlocked
- [Language](https://lumail.io/docs/features/language.md): Switch unsubscribe, confirmation, and survey pages to French, Spanish, or German. Email body, footer, and the Unsubscribe link are your copy — they are not auto-translated.
- [Variables](https://lumail.io/docs/features/variables.md): Personalize your emails with dynamic variables and default values
- [Tag Action Links](https://lumail.io/docs/features/tag-action-links.md): Let subscribers add or remove tags by clicking a link in your email
- [Surveys](https://lumail.io/docs/features/surveys.md): Ask a one-question survey inside an email and read the answers per campaign
- [Content Deliverability Checker](https://lumail.io/docs/features/content-deliverability.md): A live 0–100 pre-flight in the editor. Fix spam traps before you hit send.
- [Sender Health](https://lumail.io/docs/features/sender-health.md): How Lumail measures sending health, receiving-server delivery, and domain authentication
- [Campaign Delivery Score](https://lumail.io/docs/features/deliverability-score.md): How the dashboard campaign delivery score is calculated, and how it differs from sender health
- [Email Engagement Score](https://lumail.io/docs/features/engagement-score.md): Learn how your email engagement score is calculated and how we track opens and clicks
- [Subscriber Events](https://lumail.io/docs/features/subscriber-events.md): Complete reference for all subscriber event types in Lumail
- [Revenue Tracking](https://lumail.io/docs/features/revenue-tracking.md): Track purchases and revenue from your subscribers
- [Email Sending Queue](https://lumail.io/docs/features/email-sending-queue.md): How Lumail queues campaigns and workflow emails, and in which order they are sent

## Deliverability
- [Deliverability alerts](https://lumail.io/docs/deliverability.md): How-to guides for every Lumail deliverability alert — what it means and what to change.
- [How to strengthen DMARC](https://lumail.io/docs/deliverability/how-to-strengthen-dmarc.md): Change p=none to quarantine or reject so spoofed mail is actually handled — including when the policy is inherited from your root domain.
- [How to add DMARC](https://lumail.io/docs/deliverability/how-to-add-dmarc.md): Publish a valid _dmarc TXT record so Lumail can verify DMARC on your sending domain.
- [How to fix DKIM](https://lumail.io/docs/deliverability/how-to-fix-dkim.md): Add the DKIM CNAME records from your Lumail domain page so mail is signed with a 2048-bit aligned key.
- [How to verify a sending domain](https://lumail.io/docs/deliverability/how-to-verify-sending-domain.md): Add the DNS records Lumail shows so the sending identity can be verified and used as From.
- [How to fix MAIL FROM](https://lumail.io/docs/deliverability/how-to-fix-mail-from.md): Add the MX and SPF records on ses.your-domain.com so bounce handling and SPF alignment work.
- [How to fix BIMI](https://lumail.io/docs/deliverability/how-to-fix-bimi.md): Fix or remove a malformed BIMI TXT record. BIMI is optional and never required for a healthy sender.
- [How to lower bounce rate](https://lumail.io/docs/deliverability/how-to-lower-bounce-rate.md): Clear invalid addresses when Lumail reports a sustained permanent bounce rate above 2% or 5%.
- [How to lower complaint rate](https://lumail.io/docs/deliverability/how-to-lower-complaint-rate.md): Stop mailing people who hit “this is spam” when reported complaints stay elevated.
- [How to fix delivery delays](https://lumail.io/docs/deliverability/how-to-fix-delivery-delays.md): What to do when receiving servers delay more than 10% of sent mail across consecutive windows.
- [How to fix blocklist bounces](https://lumail.io/docs/deliverability/how-to-fix-blocklist-bounces.md): What Lumail means by blocked-list or spam concentration in bounce diagnostics — and what to do.
- [How to fix sending infrastructure](https://lumail.io/docs/deliverability/how-to-fix-sending-infrastructure.md): What to do when bounce feedback, event tracking, or account sending is marked unhealthy in Lumail.
- [How to fix a dedicated IP](https://lumail.io/docs/deliverability/how-to-fix-dedicated-ip.md): What to do when the dedicated IP pool is missing, not ready, or warmup is stuck at 0%.
- [How to fix a failed send](https://lumail.io/docs/deliverability/how-to-fix-email-send-failure.md): What to do when a campaign, workflow, test, or transactional send is rejected.
- [How to fix a fallback-domain send](https://lumail.io/docs/deliverability/how-to-fix-fallback-domain.md): The primary sending domain failed and Lumail retried through a fallback domain. Fix the primary.
- [How to fix an invalid email parameter](https://lumail.io/docs/deliverability/how-to-fix-invalid-email.md): SES rejected from, to, subject, or headers. What to change before you retry.
- [How to fix sending rate or daily quota](https://lumail.io/docs/deliverability/how-to-fix-sending-rate.md): What to do when sends are throttled or the daily SES quota is exhausted.
- [How to fix a monthly email limit](https://lumail.io/docs/deliverability/how-to-fix-monthly-email-limit.md): Upgrade or wait for reset when you hit 80%, 95%, or 100% of the monthly email allowance.
- [How to fix a past-due payment pause](https://lumail.io/docs/deliverability/how-to-fix-past-due-payment.md): Sending and workflows stay parked until the outstanding invoice is paid.
- [How to fix an admin sending pause](https://lumail.io/docs/deliverability/how-to-fix-admin-sending-pause.md): An administrator paused sending. You cannot resume this from DNS or billing.
- [How to complete additional verification](https://lumail.io/docs/deliverability/how-to-complete-additional-verification.md): Restore sending after a deliverability check, a declined request, or an info request.
- [How to fix a failed campaign](https://lumail.io/docs/deliverability/how-to-fix-failed-campaign.md): The campaign finished processing but only some recipients were sent. How to find the hole and retry.
- [How to fix a campaign render error](https://lumail.io/docs/deliverability/how-to-fix-campaign-render-error.md): The campaign could not be prepared — invalid HTML or a render failure. What to edit before sending.

## Workflows
- [Creating Workflows](https://lumail.io/docs/workflows.md): Learn how to create and manage automated workflows for your subscribers
- [Workflow](https://lumail.io/docs/workflows/workflow.md): Complete guide to Workflow graphs, versions, runs, groups, goals, exits, agent tools, publishing, and verification.
- [Workflow Getting Started](https://lumail.io/docs/workflows/workflow-getting-started.md): Build, save, test, and publish your first graph-based workflow in Lumail.
- [Workflow Triggers](https://lumail.io/docs/workflows/workflow-triggers.md): Choose enrollment events, event filters, audience filters, and multiple entry points.
- [Workflow Manual Enrollment](https://lumail.io/docs/workflows/workflow-manual-enrollment.md): Filter subscribers, select all matches, and start a published workflow without waiting for a trigger.
- [Workflow Branching](https://lumail.io/docs/workflows/workflow-branching.md): Route subscribers with conditions, event waits, A/B splits, move-to-step jumps, goals, and exits.
- [Workflow A/B Testing](https://lumail.io/docs/workflows/workflow-ab-testing.md): Build weighted variants, define one conversion signal, and compare success rates correctly.
- [Workflow Goals](https://lumail.io/docs/workflows/workflow-goals.md): Define conversion goals, terminal goal steps, and event-driven success goals.
- [Workflow Exit Rules](https://lumail.io/docs/workflows/workflow-exit-rules.md): Stop active runs with global subscriber rules or explicit terminal exit steps.
- [Workflow Publishing and Versions](https://lumail.io/docs/workflows/workflow-publishing.md): Understand draft saves, immutable versions, activation, pausing, and safe updates.
- [Workflow Test Runs and Results](https://lumail.io/docs/workflows/workflow-testing.md): Use dry runs, timelines, dashboards, and version-aware checks to verify workflow behavior.
- [Wait Step](https://lumail.io/docs/workflows/workflow-wait-step.md): Configure duration, calendar, event, and audience waits in Workflow.
- [Email Step](https://lumail.io/docs/workflows/workflow-email-step.md): Configure owned Workflow emails, sending behavior, retries, personalization, and queue guarantees.
- [Action Step](https://lumail.io/docs/workflows/workflow-action-step.md): Manage tags, fields, enrollment, unsubscribe, and webhooks in Workflow.
- [Webhook Step](https://lumail.io/docs/workflows/workflow-webhook-step.md): Integrate external services with Workflow webhook actions.
- [Workflow Groups](https://lumail.io/docs/workflows/workflow-groups.md): Configure mutual exclusion, conflict strategies, chaining, and Workflow group tools.

## domains
- [Email Domains](https://lumail.io/docs/domains/email-domains.md): Configure your own domain for sending emails
- [Domains Overview](https://lumail.io/docs/domains.md): Configure email and web domains for your organization
- [Web Domains](https://lumail.io/docs/domains/web-domains.md): Serve capture pages on your own custom domain

## Optional
- [Blog](https://lumail.io/posts): Product writing and comparisons.
- [Changelog](https://lumail.io/changelog): Release notes.
- [Compare](https://lumail.io/compare): Lumail versus other email tools.
- [Pricing](https://lumail.io/pricing): Plans and limits.
- [Privacy](https://lumail.io/legal/privacy): Privacy policy.
- [Terms](https://lumail.io/legal/terms): Terms of service.