Documentation
Everything you need to set up and manage your business email with shipmail.
Getting started
Quick start
From zero to sending email in 5 minutes.
Domain setup
Add your domain, configure DNS records, and verify ownership.
DNS setup
Configure MX, SPF, DKIM, and DMARC records at your registrar to receive and send email.
DNS records reference
Reference for every DNS record Shipmail needs and what each one does.
Mailboxes
Create, edit, and manage email addresses on your domains.
Billing
Plans, trials, payment failures, and mailbox suspension.
Troubleshooting
Solutions for common domain verification, delivery, and client connection issues.
Email clients
Features
Auto-reply
Set up automatic out-of-office or vacation replies on any mailbox.
Catch-all addresses
Receive email sent to any address on your domain.
Subaddressing
Use user+tag@domain.com to organize and filter incoming email.
Calendars (CalDAV)
Sync calendars with your email client or calendar app.
Contacts (CardDAV)
Sync contacts with your email client or address book.
Email filtering (Sieve)
Create server-side rules to sort, forward, or reject email.
Guides
SPF, DKIM, and DMARC setup
Understand and configure email authentication records for your domain.
IMAP and SMTP settings
Server hostnames, ports, and email client configuration.
Shared inbox setup
Create a shared mailbox for your team with support@, hello@, or billing@.
Migrate from Gmail
Move your email from Gmail or Google Workspace to shipmail.
Custom domain email setup
Add your domain, configure DNS records, and create your first mailbox.
API getting started
Create API keys, manage resources, and send email with the REST API and SDKs.
API
Overview
Base URL, authentication, request format, and conventions.
Authentication
Create API keys and authenticate requests with Bearer tokens.
Errors
Error envelope format, error types, and status codes.
Rate limits
Request quotas by tier and rate limit response headers.
Pagination
Cursor-based pagination for list endpoints.
Idempotency
Safely retry POST requests with idempotency keys.
Domains
Create, list, update, delete, and verify domains.
Mailboxes
Create, list, update, and delete mailboxes on your domains.
Messages
Send email and retrieve individual messages.
Threads
List threads, view thread messages, and reply to threads.
Webhooks
Subscribe to events with HTTPS webhooks.
Webhook verification
Verify webhook signatures and prevent replay attacks.
SDKs
TypeScript SDK
Official client library with typed resources, pagination, and error handling.
Python SDK
Sync and async clients for Python 3.10+. Auto-pagination, retries, and webhook verification.
CLI
Terminal commands for API health checks, domains, mailboxes, inbox messages, sending, webhooks, and raw API calls.
MCP server
Connect AI agents to shipmail over stdio with structured tools, resources, and prompts.