---
title: "Docs"
description: "How Nextmail works, written down: setup, every feature in the product, the REST API, the SDK, the CLI and the MCP server."
url: "https://nextmail.sh/docs"
---

# Documentation

Every page of the Nextmail documentation, 1190 of them, listed by area. Each link is the page in Markdown.

## Get started

Account, domain, addresses, sending. Read in order the first time.

- [Welcome](https://nextmail.sh/docs/get-started/welcome.md): Nextmail is an email client built around domains you own rather than mailboxes we rent you. This is the whole product, written down.
- [Create an account](https://nextmail.sh/docs/get-started/account.md): The address you sign up with identifies you. It is not the mailbox you will read. That comes from the domain you connect next.
- [Connect a domain](https://nextmail.sh/docs/get-started/domain.md): Nextmail receives on domains you own. Free covers one, Starter 50, Business 500, Enterprise as many as you want. With catch-all on, every address on a verified domain works from the moment the DNS is live.
- [Addresses and mailboxes](https://nextmail.sh/docs/get-started/addresses.md): With catch-all on, an address exists as soon as something is sent to it. Listing one up front is about naming it, not permitting it.
- [Sending](https://nextmail.sh/docs/get-started/sending.md): You can send as any address on a verified domain, and replies go out from the address the mail arrived on by default.
- [AI](https://nextmail.sh/docs/get-started/ai.md): AI features run against your mailbox on every plan. Free spends 10 actions a day, Starter 50, Business 150, and Enterprise 300. With pay as you go on in Billing, every plan, Free included, keeps going past that at $0.25 per 100 extra actions, billed monthly and separately from the plan. An action is one thing you ask for: a draft, a rewrite, a translation, a search worded for you or one assistant turn. Mail is summarised and checked as it arrives, the sender card looks up an unfamiliar domain when you open its mail, and sending a message updates your writing-style profile; none of that counts against the allowance, and everything else waits for you to ask.

## Knowledge base

Every feature in the product, one page each, with the caps and the shortcuts.

- [Domains & addresses](https://nextmail.sh/docs/knowledge/addresses.md): Nextmail is built around the domain rather than the mailbox. You point one at us, and every address on it is real.
- [Catch-all addresses](https://nextmail.sh/docs/knowledge/addresses/catch-all.md): Every address on the domain receives, including ones that have never been created. One switch closes it.
- [Multiple domains](https://nextmail.sh/docs/knowledge/addresses/domains.md): Point several domains at one inbox, subdomains included.
- [DMARC policy](https://nextmail.sh/docs/knowledge/addresses/dmarc.md): A starter p=none record, printed to copy or written by a sync, never tightened for you.
- [Temporary addresses](https://nextmail.sh/docs/knowledge/addresses/temp-address.md): A free inbox that takes real mail for an hour, then closes, so a signup cannot follow you.
- [Send as any alias](https://nextmail.sh/docs/knowledge/addresses/alias-send.md): Reply from the exact address the mail arrived on.
- [Merged inboxes](https://nextmail.sh/docs/knowledge/addresses/merged.md): Read every address in one stream, or narrow to the two or three you actually work out of.
- [Forward an address elsewhere](https://nextmail.sh/docs/knowledge/addresses/address-forwarding.md): Point any address, or everything a domain accepts, at an outside mailbox instead of this one.
- [Workspace branding](https://nextmail.sh/docs/knowledge/addresses/workspace-brand.md): Put your own mark and logo in the sidebar, in place of ours.
- [Custom webmail domain](https://nextmail.sh/docs/knowledge/addresses/webmail-domain.md): Your team opens its mail at a subdomain of yours, such as mailbox.yourcompany.com, with your brand on it.
- [A free personal address](https://nextmail.sh/docs/knowledge/addresses/free-address.md): Every account comes with yourname@openemail.uk, an address that sends and receives, kept apart from your workspaces.
- [Move a domain between workspaces](https://nextmail.sh/docs/knowledge/addresses/domain-move.md): Take a domain, its addresses and all their mail from one of your workspaces to another.
- [Connected mailboxes](https://nextmail.sh/docs/knowledge/addresses/connected-mailboxes.md): Work a Gmail, Outlook, Yahoo, iCloud or other mailbox from Nextmail while its mail stays at the provider.
- [Your addresses in any mail app](https://nextmail.sh/docs/knowledge/addresses/mail-apps.md): Read and send from an address in Apple Mail, Outlook, Thunderbird, the Gmail app or your phone’s own mail app, signed in with an app password.
- [Mail on iPhone and iPad](https://nextmail.sh/docs/knowledge/addresses/mail-apps/iphone-ipad.md): Add an address to the Mail app on an iPhone or iPad with the profile or by hand, then choose how it files and fetches mail.
- [Mail on a Mac](https://nextmail.sh/docs/knowledge/addresses/mail-apps/mac.md): Add an address to Mail on a Mac with the profile or by hand, then check its server settings and mailbox behaviours.
- [Outlook](https://nextmail.sh/docs/knowledge/addresses/mail-apps/outlook.md): Add an address to the new and classic Outlook for Windows, to Outlook for Mac and to the Outlook app on iPhone and Android, as an IMAP account.
- [Thunderbird](https://nextmail.sh/docs/knowledge/addresses/mail-apps/thunderbird.md): Add an address to Thunderbird on Windows, macOS or Linux, field by field, and set its folders to work the way Nextmail does.
- [The Gmail app](https://nextmail.sh/docs/knowledge/addresses/mail-apps/gmail-app.md): Add an address to the Gmail app on Android or iPhone as an IMAP account of its own.
- [Gmail on the web](https://nextmail.sh/docs/knowledge/addresses/mail-apps/gmail-web.md): Receive the mail of an address in Gmail on the web by forwarding it, and send from it there with Send mail as and the SMTP server of Nextmail.
- [Android mail apps](https://nextmail.sh/docs/knowledge/addresses/mail-apps/android.md): Add an address to Samsung Email, Thunderbird for Android, K-9 Mail or any other mail app on Android.
- [Calendars over CalDAV](https://nextmail.sh/docs/knowledge/addresses/mail-apps/calendars.md): Keep the calendar of an address in step with Apple Calendar, Thunderbird, DAVx5 on Android and any other CalDAV app, signed in with an app password.
- [Folders, sync and sending](https://nextmail.sh/docs/knowledge/addresses/mail-apps/sync.md): What a mail app sees of an address, how its changes reach Nextmail, and the rules for the mail it sends.
- [Troubleshooting mail apps](https://nextmail.sh/docs/knowledge/addresses/mail-apps/troubleshooting.md): Every sign-in, connection, filing and sending error a mail app can show, what it means and how to fix it.
- [Reading & organising](https://nextmail.sh/docs/knowledge/reading.md): What happens between mail arriving and you deciding what to do about it.
- [Search by words or meaning](https://nextmail.sh/docs/knowledge/reading/search.md): Forgiving words, operators like from: and has:, and search by meaning, inside the folder you are reading.
- [Read in your language](https://nextmail.sh/docs/knowledge/reading/translate-read.md): A message you cannot read, turned into a language you can, without leaving it.
- [Labels](https://nextmail.sh/docs/knowledge/reading/labels.md): Name a label, pick a colour, and filter the list down to it.
- [AI labels](https://nextmail.sh/docs/knowledge/reading/ai-labels.md): Say what a label is for in plain words, and AI adds it to new mail that fits.
- [Inbox tabs](https://nextmail.sh/docs/knowledge/reading/inbox-tabs.md): The inbox sorted into Primary, Promotions, Updates, Social and Forums, so mail from people comes first.
- [Thread notes](https://nextmail.sh/docs/knowledge/reading/notes.md): Keep a private note attached to a thread.
- [Analytics & graphs](https://nextmail.sh/docs/knowledge/reading/insights.md): What your mailbox is actually doing, drawn rather than guessed at.
- [Contacts](https://nextmail.sh/docs/knowledge/reading/contacts.md): An address book that syncs with your phone, and the people you write to offered as you type.
- [Keyboard-first](https://nextmail.sh/docs/knowledge/reading/shortcuts.md): Search is /, the assistant is ⌘0, and the list moves under the arrow keys.
- [Sign-up forms for audiences](https://nextmail.sh/docs/knowledge/reading/audience-forms.md): A form on your website, or a hosted link, that adds whoever fills it in to an audience.
- [Snooze](https://nextmail.sh/docs/knowledge/reading/snooze.md): Put a conversation away until a time you pick, and find it back in the inbox then.
- [Mute](https://nextmail.sh/docs/knowledge/reading/mute.md): Silence a conversation you no longer need to follow. New replies skip the inbox and alert nobody.
- [Audiences](https://nextmail.sh/docs/knowledge/reading/audiences.md): Named lists of your contacts, filled by hand or from a CSV file, to send to and to watch grow.
- [New-mail alerts](https://nextmail.sh/docs/knowledge/reading/notifications.md): A desktop alert and a chime when mail arrives while Nextmail is open in a tab.
- [Verification codes](https://nextmail.sh/docs/knowledge/reading/verification-code.md): The sign-in code from a verification email, at the top of the message with a button to copy it.
- [Writing & sending](https://nextmail.sh/docs/knowledge/writing.md): The composer, and everything attached to the moment you hit send.
- [Templates](https://nextmail.sh/docs/knowledge/writing/templates.md): A body written once, versioned, and sent many times: from the composer, from your own code, or by an agent.
- [Send to an audience](https://nextmail.sh/docs/knowledge/writing/audience-send.md): One email to everybody in an audience, a separate copy for each person, with their own name in it.
- [Files](https://nextmail.sh/docs/knowledge/writing/files.md): Every attachment this mailbox holds, in one place you can search, download and clear out.
- [Per-address email settings](https://nextmail.sh/docs/knowledge/writing/mailbox-settings.md): Each address carries its own signature, footer and tracking. The catch-all covers what it catches, and one address’s choice copies to the rest in one step. Remote images and the blocklist can be set per address or per domain too.
- [Signature](https://nextmail.sh/docs/knowledge/writing/signature.md): Several sign-offs on each address you send from, with one picked for each message.
- [Writing tools](https://nextmail.sh/docs/knowledge/writing/writing-tools.md): Formatting, inline completion and emoji shortcodes in the composer.
- [Spelling and grammar](https://nextmail.sh/docs/knowledge/writing/proofread.md): Spelling, grammar and clarity suggestions as you write, checked on your own device.
- [Send in theirs](https://nextmail.sh/docs/knowledge/writing/translate-send.md): Write in your own language and have it arrive in the recipient’s.
- [Meetings & calendar](https://nextmail.sh/docs/knowledge/writing/calendar.md): A calendar at /mail/calendar in month, week and day views, holding both your meetings and the mail you have queued to go out later.
- [Drafts](https://nextmail.sh/docs/knowledge/writing/drafts.md): Autosaved three seconds after you stop typing, and reopened from the Drafts folder with the recipients, the subject, the body and the From address intact. The attachments stay behind.
- [Scheduled send](https://nextmail.sh/docs/knowledge/writing/schedule.md): Write it now, land it when they are awake.
- [Remind me if nobody replies](https://nextmail.sh/docs/knowledge/writing/reminders.md): Send a message and get it back at the top of the inbox if no reply has come by the time you pick.
- [Undo send](https://nextmail.sh/docs/knowledge/writing/undo.md): A window to change your mind, and the composer comes back exactly as it was.
- [See when mail you sent was opened](https://nextmail.sh/docs/knowledge/writing/open-tracking.md): Whether a message you sent has been opened, when, how many times and which of its links were followed. Off until you turn it on, and plain about the readings it cannot get.
- [Tracking on your own domain](https://nextmail.sh/docs/knowledge/writing/tracking-domain.md): Tracked links and the open pixel on a subdomain you choose, such as links.yourdomain.com, instead of the Nextmail address.
- [Files on your own domain](https://nextmail.sh/docs/knowledge/writing/storage-domain.md): Download links for the files you send on a subdomain you choose, such as files.yourdomain.com, instead of the Nextmail address.
- [Attachments](https://nextmail.sh/docs/knowledge/writing/attachments.md): Pick them with the paperclip, paste them in or drop them anywhere on the composer. A pasted image lands in the body rather than the file list. On Nextmail mailboxes incoming files sit in object storage, one object each, and a file is fetched only when you open or download it.
- [Checks before you send](https://nextmail.sh/docs/knowledge/writing/draft-checks.md): Your draft scored for spam, phishing and AI writing as you write it, the way a receiving server would read it.
- [Delivery status](https://nextmail.sh/docs/knowledge/writing/delivery-status.md): Which recipients a message you sent reached, and a warning in the list when one did not.
- [Broadcast reports](https://nextmail.sh/docs/knowledge/writing/broadcast-reports.md): Every send to an audience on a page of its own, with delivery, opens, clicks, unsubscribes and each person’s copy.
- [Sending analytics](https://nextmail.sh/docs/knowledge/writing/sending-analytics.md): What became of the mail you sent: delivered, bounced or reported as spam, by address and by how it was sent.
- [Sending lanes](https://nextmail.sh/docs/knowledge/writing/sending-lanes.md): App mail and newsletters travel separately, so a newsletter never delays a password reset.
- [Dedicated IP](https://nextmail.sh/docs/knowledge/writing/dedicated-ip.md): An IP address that only your workspace sends from, as a paid add-on for high volume.
- [Automations](https://nextmail.sh/docs/knowledge/writing/automations.md): Emails that send themselves when someone joins a list or does something in your product.
- [Booking pages](https://nextmail.sh/docs/knowledge/writing/booking.md): A link where people pick a free time and book a meeting on your calendar.
- [AI](https://nextmail.sh/docs/knowledge/ai.md): Everything here runs against your own mailbox, and none of it sends anything without you.
- [Ask your inbox](https://nextmail.sh/docs/knowledge/ai/ask.md): A chat that can act, not just answer. On every plan, Free included.
- [Tasks](https://nextmail.sh/docs/knowledge/ai/tasks.md): Give the assistant work to do by itself: on a schedule, when mail arrives, or once in the background.
- [Subject lines](https://nextmail.sh/docs/knowledge/ai/subject.md): Write the body, and the subject writes itself.
- [Draft from a note](https://nextmail.sh/docs/knowledge/ai/generate.md): Give it the gist and get the whole body back, in the first person as you.
- [Your writing style](https://nextmail.sh/docs/knowledge/ai/style.md): Drafts are shaped by how you actually write.
- [Suggested replies](https://nextmail.sh/docs/knowledge/ai/reply-suggestions.md): Short replies to the latest message, ready to send.
- [Thread summaries](https://nextmail.sh/docs/knowledge/ai/summaries.md): A few lines at the top of a conversation that say what it is about, brought up to date as it grows.
- [Rewrite with AI](https://nextmail.sh/docs/knowledge/ai/rewrite.md): Three or five other versions of your subject or your body, shorter, longer or in another tone, to pick from.
- [Connectors](https://nextmail.sh/docs/knowledge/ai/connectors.md): Connect the apps you work in, so the assistant can look things up in them and act there.
- [Safety & authenticity](https://nextmail.sh/docs/knowledge/safety.md): Two questions about a message you were not expecting: is the sender the domain it claims to be, and did a person write this. Both are answered on the message itself, next to the sender, rather than in a filter that quietly disappears things.
- [Verified sender](https://nextmail.sh/docs/knowledge/safety/verified-sender.md): A mark beside the sender when the sending domain’s published records line up.
- [Sender pictures](https://nextmail.sh/docs/knowledge/safety/sender-avatar.md): A real picture for everyone you correspond with when one can be found, and a mark seeded on their identity when it cannot.
- [Phishing & spam filtering](https://nextmail.sh/docs/knowledge/safety/spam-filter.md): Mail the sending domain itself disowns lands in Spam rather than the inbox.
- [Sender research & look-alike domains](https://nextmail.sh/docs/knowledge/safety/sender-research.md): Who is this, in fifty words, and is the domain a look-alike?
- [Written by AI](https://nextmail.sh/docs/knowledge/safety/ai-written.md): A label on the message when the words look generated rather than written.
- [Checks on every message](https://nextmail.sh/docs/knowledge/safety/message-checks.md): Every message you receive scored for spam, phishing and AI writing, with each check behind the scores listed.
- [Which service sent it](https://nextmail.sh/docs/knowledge/safety/sent-with.md): The mail service a message was sent with, beside the sender, and a note when it reached you through a forward.
- [Filters & blocking](https://nextmail.sh/docs/knowledge/filters.md): Spam filtering decides what is junk. This is the other half: what you have decided you do not want, however legitimate it is and whoever it is from.
- [Block a sender or a domain](https://nextmail.sh/docs/knowledge/filters/block-sender.md): One address, or everything from a domain, stopped before it reaches you.
- [Bad-language filter](https://nextmail.sh/docs/knowledge/filters/language-filter.md): Mail carrying the words you do not want to read does not open in front of you.
- [Rules you write yourself](https://nextmail.sh/docs/knowledge/filters/custom-filters.md): Your own conditions, and what should happen to anything that matches them.
- [Out of office](https://nextmail.sh/docs/knowledge/filters/out-of-office.md): An automatic reply from one address while you are away, with a start, an end and your own words.
- [Subscriptions](https://nextmail.sh/docs/knowledge/filters/subscriptions.md): Every newsletter and mailing list that writes to you, in one place to unsubscribe from, file away or block.
- [Developers](https://nextmail.sh/docs/knowledge/developers.md): Everything in the app is also a call your own code can make: send mail, scope keys, hear about events, and drive it from a typed client or an agent.
- [Email API](https://nextmail.sh/docs/knowledge/developers/email-api.md): Send one message or a hundred per call, now or later, and retry without sending twice.
- [API keys](https://nextmail.sh/docs/knowledge/developers/api-keys.md): A key per job, limited to the scopes and senders it needs, with every call logged.
- [REST API](https://nextmail.sh/docs/knowledge/developers/api.md): A documented HTTP API with issuable, scopable, revocable keys.
- [Webhooks](https://nextmail.sh/docs/knowledge/developers/webhooks.md): Tell your endpoint when mail arrives, instead of making you poll.
- [Typed SDKs](https://nextmail.sh/docs/knowledge/developers/sdk.md): TypeScript, Python, Ruby, PHP, Go, Java and C# clients, one method for every operation.
- [Command line](https://nextmail.sh/docs/knowledge/developers/cli.md): Your mailbox and every API operation, from a terminal or a script.
- [MCP server](https://nextmail.sh/docs/knowledge/developers/mcp.md): Point Claude, or any MCP client, at your mailbox.
- [OAuth for third-party clients](https://nextmail.sh/docs/knowledge/developers/oauth.md): Apps register themselves and sign in with PKCE, and you choose the workspace, addresses and permissions each one gets.
- [Move from Resend](https://nextmail.sh/docs/knowledge/developers/switch-from-resend.md): Bring your suppressions, audiences, contacts, templates and webhooks across with one key, with a checklist for your domains and API keys.
- [Move from Mailchimp](https://nextmail.sh/docs/knowledge/developers/switch-from-mailchimp.md): Bring your Mailchimp lists, subscribers and unsubscribes across with one key.
- [Convert your sending code](https://nextmail.sh/docs/knowledge/developers/code-converter.md): Paste code that sends through Resend, SendGrid, Postmark or Mailgun, and get it back written for Nextmail.
- [Try it in the docs](https://nextmail.sh/docs/knowledge/developers/api-playground.md): Send a real request from any page of the API reference, with a temporary key that lasts an hour and is scoped to that call.
- [Address checker](https://nextmail.sh/docs/knowledge/developers/address-check.md): Whether an address is worth sending to, before the first message.
- [Events from your app](https://nextmail.sh/docs/knowledge/developers/contact-events.md): Tell Nextmail what a contact did in your product, to start an automation or end a wait.
- [Switch from SendGrid](https://nextmail.sh/docs/knowledge/developers/switch-from-sendgrid.md): Keep the SendGrid SDK and send through Nextmail. Change its base URL and its key, and your sending code stays as it is.
- [Switch from Postmark](https://nextmail.sh/docs/knowledge/developers/switch-from-postmark.md): Keep the Postmark library and send through Nextmail. Change its host and its server token, and your sending code stays as it is.
- [Switch from Mailgun](https://nextmail.sh/docs/knowledge/developers/switch-from-mailgun.md): Keep the Mailgun SDK and send through Nextmail. Change its base URL and its key, and your sending code stays as it is.
- [Workspaces & team](https://nextmail.sh/docs/knowledge/team.md): A workspace holds your domains, the mailboxes on them, and the people who read them. Sharing is per address or per whole domain, and a whole domain covers every address made on it later.
- [Share an address](https://nextmail.sh/docs/knowledge/team/share.md): Hand billing@ to the person who does the billing.
- [Scoped visibility](https://nextmail.sh/docs/knowledge/team/scope.md): One address means one address.
- [Roles & permissions levels](https://nextmail.sh/docs/knowledge/team/roles.md): A role says what somebody may do; an address grant says what they may do it to.
- [Invitations](https://nextmail.sh/docs/knowledge/team/invites.md): Share with someone who has not signed up yet and have them invited.
- [Several workspaces](https://nextmail.sh/docs/knowledge/team/workspaces.md): Run each business in its own workspace, with its own domains, mail, team, plan and invoices, and switch between them from the sidebar.
- [A password for one address](https://nextmail.sh/docs/knowledge/team/address-login.md): Let somebody sign in as one address, such as someone covering support@, with a password you set, and reach nothing else.
- [Privacy & ownership](https://nextmail.sh/docs/knowledge/trust.md): Privacy first is a claim every mail company makes, so here it is as a list of things you can go and check: what is stripped out of a message before you see it, what is never fetched on your behalf, and what happens to your mail when you stop paying us.
- [Tracking pixels stripped](https://nextmail.sh/docs/knowledge/trust/no-tracking.md): The invisible image that tells a sender you opened their mail is gone before you see the message.
- [Remote image control](https://nextmail.sh/docs/knowledge/trust/external-images.md): Stop a sender fetching anything from their own server while you read.
- [Choose which emails we send you](https://nextmail.sh/docs/knowledge/trust/email-preferences.md): Per-category switches in Account → Notifications, and the ones that matter are honestly marked as unswitchable.
- [Your mail on object storage](https://nextmail.sh/docs/knowledge/trust/storage.md): Full message bodies and attachment bytes on R2, indexed per mailbox.
- [Take your mail with you](https://nextmail.sh/docs/knowledge/trust/export.md): One download from the Export page with everything in it: every message and attachment as mbox files another mail app opens, plus your contacts, calendar, labels, rules, templates, notes and settings.
- [Transport encryption](https://nextmail.sh/docs/knowledge/trust/tls.md): Mail moves over TLS on the hops we run, and transport alone never turns the padlock green, because nothing on this backend can read the transport off a delivery.
- [Encryption at rest](https://nextmail.sh/docs/knowledge/trust/at-rest.md): Bodies, attachments and what you write are sealed before they are stored, so a copy of the database is ciphertext rather than mail.
- [End-to-end encryption](https://nextmail.sh/docs/knowledge/trust/e2ee.md): OpenPGP keys made in your browser. Mail you send to another Nextmail address can be sealed before it leaves the tab, and sealed mail addressed to you opens in the reading pane, decrypted on your machine. The keys are never ours to hand over.
- [Account security](https://nextmail.sh/docs/knowledge/trust/account-security.md): A code from your authenticator app on top of your password, and ten recovery codes for the day the phone is gone.
- [Bring your old mailbox](https://nextmail.sh/docs/knowledge/trust/import.md): Bring the mail you already have: copy it straight from the old mailbox by signing in, or upload a Google Takeout export or an .mbox file, threaded and dated as it was.
- [Import from Gmail](https://nextmail.sh/docs/knowledge/trust/import/gmail.md): Copy a Gmail or Google Workspace mailbox with an app password, labels included.
- [Import from Outlook and Microsoft 365](https://nextmail.sh/docs/knowledge/trust/import/outlook.md): Copy an Outlook.com or Microsoft 365 mailbox with a Microsoft sign-in, no password needed.
- [Import from iCloud Mail](https://nextmail.sh/docs/knowledge/trust/import/icloud.md): Copy an iCloud mailbox, its contacts and its calendars with an app-specific password.
- [Import from Yahoo Mail](https://nextmail.sh/docs/knowledge/trust/import/yahoo.md): Copy a Yahoo mailbox, its contacts and its calendars with an app password.
- [Import from Fastmail](https://nextmail.sh/docs/knowledge/trust/import/fastmail.md): Copy a Fastmail mailbox, its contacts and its calendars with an app password.
- [Import from AOL Mail](https://nextmail.sh/docs/knowledge/trust/import/aol.md): Copy an AOL mailbox with an app password.
- [Import from Zoho Mail](https://nextmail.sh/docs/knowledge/trust/import/zoho.md): Copy a Zoho Mail mailbox with an app password.
- [Import from any other mail server](https://nextmail.sh/docs/knowledge/trust/import/other.md): Copy a mailbox from any provider or server that offers IMAP.

## MCP server

Connect a client to your mailbox. The endpoints, and the tools it registers.

- [MCP server](https://nextmail.sh/docs/mcp/overview.md): Your mailbox behind the Model Context Protocol, so Claude, or any MCP client, can read, search, write and label through your own account.
- [Connect a client](https://nextmail.sh/docs/mcp/connect.md): Two transports, one server.
- [What it can reach](https://nextmail.sh/docs/mcp/scope.md): The honest boundary.
- [Tools](https://nextmail.sh/docs/mcp/tools.md): Everything the server registers, grouped by what it is for. If a tool is not here, it is not on this server.
- [Connections](https://nextmail.sh/docs/mcp/tools/connections.md): Which mailbox the other tools act on.
- [Reading](https://nextmail.sh/docs/mcp/tools/reading.md): Finding and reading mail.
- [Writing](https://nextmail.sh/docs/mcp/tools/writing.md): Composing, translating and sending.
- [Organising](https://nextmail.sh/docs/mcp/tools/organising.md): Labels and read state.
- [Templates](https://nextmail.sh/docs/mcp/tools/templates.md): A body written once, sent many times.
- [Rules](https://nextmail.sh/docs/mcp/tools/rules.md): What happens to mail as it arrives.
- [Tracking](https://nextmail.sh/docs/mcp/tools/tracking.md): What became of the mail this mailbox sent.
- [Contacts](https://nextmail.sh/docs/mcp/tools/contacts.md): The address book this mailbox writes to.
- [Audiences](https://nextmail.sh/docs/mcp/tools/audiences.md): Named lists the contacts are grouped into.
- [Sending to audiences](https://nextmail.sh/docs/mcp/tools/broadcasts.md): One email to everybody in one or more audiences, a separate copy for each person.
- [Keys and webhooks](https://nextmail.sh/docs/mcp/tools/keys.md): The credentials and endpoints this workspace has issued.
- [Workspace and people](https://nextmail.sh/docs/mcp/tools/workspace.md): Who is asking, what they may do, and who else is here.
- [Files](https://nextmail.sh/docs/mcp/tools/files.md): Every file the mailbox holds.
- [Suppressions](https://nextmail.sh/docs/mcp/tools/suppressions.md): The addresses this workspace will not send to, and the people who unsubscribed.
- [Domains](https://nextmail.sh/docs/mcp/tools/domains.md): Adding domains, the DNS records they need, their logo, their addresses, the web app address and the workspace brand.
- [Forms](https://nextmail.sh/docs/mcp/tools/forms.md): Sign-up forms, the people who fill them in, and their numbers.
- [Notes](https://nextmail.sh/docs/mcp/tools/notes.md): Private notes pinned to a thread.
- [Team inbox](https://nextmail.sh/docs/mcp/tools/team-inbox.md): Assign threads, mark them done and comment as a team.
- [Domain checks](https://nextmail.sh/docs/mcp/tools/domain-checks.md): The public mail records of any domain.
- [Drafts](https://nextmail.sh/docs/mcp/tools/drafts.md): Unsent messages saved in the mailbox.
- [Support](https://nextmail.sh/docs/mcp/tools/support.md): Write to the people who build Nextmail.
- [Encryption](https://nextmail.sh/docs/mcp/tools/encryption.md): The public keys that let senders seal mail to you.
- [Sent and scheduled](https://nextmail.sh/docs/mcp/tools/sent.md): Mail that went out or is waiting to.
- [Assistant chats](https://nextmail.sh/docs/mcp/tools/chats.md): The conversations held with the assistant in the app.
- [Exports](https://nextmail.sh/docs/mcp/tools/exports.md): A zip of the whole workspace.
- [Analytics](https://nextmail.sh/docs/mcp/tools/analytics.md): How mail arrives, and what became of the mail sent.
- [Subscriptions](https://nextmail.sh/docs/mcp/tools/subscriptions.md): The newsletters and mailing lists the mailbox receives.
- [Imports](https://nextmail.sh/docs/mcp/tools/imports.md): Old mail coming in, and moves from another provider.
- [Connected mailboxes](https://nextmail.sh/docs/mcp/tools/connected-mailboxes.md): Mailboxes that stay at Gmail or another provider and are worked from here.
- [Calendar](https://nextmail.sh/docs/mcp/tools/calendar.md): Events, invitations, calendar links and subscriptions.
- [Billing](https://nextmail.sh/docs/mcp/tools/billing.md): The plan, pay as you go, invoices, and the links to pay.
- [Your account](https://nextmail.sh/docs/mcp/tools/account.md): The workspaces, email, photo, username, apps, invitations, signed-in devices and passkeys of the person.
- [Knowledge base](https://nextmail.sh/docs/mcp/tools/knowledge.md): The notes, files and web pages the AI writes from.
- [Temporary mail](https://nextmail.sh/docs/mcp/tools/temp-mail.md): Disposable inboxes for a sign-up or a test.
- [Automations](https://nextmail.sh/docs/mcp/tools/automations.md): Emails and steps that run by themselves for each contact, and the events that start them.
- [Tasks](https://nextmail.sh/docs/mcp/tools/tasks.md): Instructions the assistant runs by itself, the runs they make, and what those runs ask a person to approve.
- [Booking pages](https://nextmail.sh/docs/mcp/tools/bookings.md): Public pages where guests book meetings on a calendar, their open times, and the bookings they take.
- [Connectors](https://nextmail.sh/docs/mcp/tools/connectors.md): Outside apps connected for a person or a workspace, the actions they offer, and the calls made through them.

## API

Send mail and drive a mailbox from your own code, with a workspace key.

- [API](https://nextmail.sh/docs/api/overview.md): Send mail and drive a mailbox from your own code, with a workspace API key.
- [Quickstart](https://nextmail.sh/docs/api/quickstart.md): A key and a first send.
- [Authentication](https://nextmail.sh/docs/api/authentication.md): Two credentials, and the ways a request is refused.
- [Scopes](https://nextmail.sh/docs/api/scopes.md): What a key is allowed to do.
- [Errors](https://nextmail.sh/docs/api/errors.md): One shape, two levels, and a request id on everything.
- [Idempotency](https://nextmail.sh/docs/api/idempotency.md): Making a retry safe.
- [Changelog](https://nextmail.sh/docs/api/changelog.md): What changed in the API, newest first.
- [Deprecations](https://nextmail.sh/docs/api/deprecations.md): What can change, and how much notice you get.
- [Emails](https://nextmail.sh/docs/api/emails.md): Send, schedule, cancel and retrieve messages, see what became of them, and send them in the recipient’s language.
- [Send an email](https://nextmail.sh/docs/api/emails/send.md): POST /emails: one message, now or later.
- [Send a batch](https://nextmail.sh/docs/api/emails/batch.md): Up to 100 at once.
- [Preview a translation](https://nextmail.sh/docs/api/emails/translate.md): What `translate` on a send would produce, with nothing sent and nothing stored.
- [Schedule and cancel](https://nextmail.sh/docs/api/emails/schedule.md): Send later, move it, or stop it.
- [List and retrieve](https://nextmail.sh/docs/api/emails/list.md): Find messages, and see what became of one.
- [Open and click tracking](https://nextmail.sh/docs/api/emails/tracking.md): GET /tracking: whether a message was read, and what was followed.
- [Languages](https://nextmail.sh/docs/api/languages.md): Every language a message can be sent in. No parameters, no cursor, no scope.
- [Write an email with AI](https://nextmail.sh/docs/api/emails/compose.md): The body of an email from a prompt, in the style of the mail you send.
- [Rewrite part of an email with AI](https://nextmail.sh/docs/api/emails/rewrite.md): Up to five different versions of a subject or a body.
- [Suggest a subject line](https://nextmail.sh/docs/api/emails/subject.md): A short subject for the body of an email.
- [Send over SMTP](https://nextmail.sh/docs/api/emails/smtp.md): The same send as POST /emails, for software that speaks SMTP.
- [Mailbox](https://nextmail.sh/docs/api/mailbox.md): Everything that is not a send.
- [Threads](https://nextmail.sh/docs/api/threads.md): Read and organise mail.
- [List drafts](https://nextmail.sh/docs/api/drafts/list.md): Rows are ids. Fetch one to read it.
- [Create a draft](https://nextmail.sh/docs/api/drafts/create.md): Recipients are arrays here, even though the store keeps them joined.
- [Retrieve a draft](https://nextmail.sh/docs/api/drafts/get.md): Recipients, subject, body, the thread it belongs to, the sender, and the names of any attachments.
- [Update a draft](https://nextmail.sh/docs/api/drafts/update.md): A partial update: fields you omit are left exactly as they were.
- [Delete a draft](https://nextmail.sh/docs/api/drafts/delete.md): Gone. There is no bin for drafts.
- [Send a draft](https://nextmail.sh/docs/api/drafts/send.md): Pass the id as `draftId`. The draft supplies the content, the request supplies the envelope.
- [List labels](https://nextmail.sh/docs/api/labels/list.md): Every label in the workspace, sorted by name, with its colour and how many conversations carry it, a page at a time.
- [List label colours](https://nextmail.sh/docs/api/labels/colors.md): The palette the app offers: fourteen solid colours and seven gradients.
- [Retrieve a label](https://nextmail.sh/docs/api/labels/get.md): One label by id, in the same shape as a row of the list.
- [Create a label](https://nextmail.sh/docs/api/labels/create.md): Give it a name and, if you like, a colour: a hex value or a gradient token.
- [Update a label](https://nextmail.sh/docs/api/labels/update.md): Rename, recolour, or both. A field left out stays as it is.
- [Delete a label](https://nextmail.sh/docs/api/labels/delete.md): The label goes, and comes off every conversation that carried it. The conversations stay where they are.
- [Try a label on recent mail](https://nextmail.sh/docs/api/labels/test.md): What a label that AI applies would catch in the newest inbox mail, without labelling anything.
- [List templates](https://nextmail.sh/docs/api/templates/list.md): Every template on the connection, newest first, keyset paginated.
- [Create a template](https://nextmail.sh/docs/api/templates/create.md): A draft unless you ask for it to be published. A draft can be previewed and cannot be sent.
- [Retrieve a template](https://nextmail.sh/docs/api/templates/get.md): Takes the id or the slug. The newest version comes back in full, body included.
- [Update a template](https://nextmail.sh/docs/api/templates/update.md): Metadata is patched in place. Touching the body of a published template mints a new draft.
- [Delete a template](https://nextmail.sh/docs/api/templates/delete.md): The template and every version of it. Mail already sent from it is untouched.
- [List versions](https://nextmail.sh/docs/api/templates/versions.md): Every revision, newest first and a page at a time, with the declared keys each one expects.
- [Read one version](https://nextmail.sh/docs/api/templates/version.md): One revision with its body, so you can see what an old version holds without restoring it.
- [Publish a version](https://nextmail.sh/docs/api/templates/publish.md): Freezes the current draft and makes it what a send resolves.
- [Preview a template](https://nextmail.sh/docs/api/templates/preview.md): Exactly the HTML a send would produce, without sending it.
- [Send with a template](https://nextmail.sh/docs/api/templates/send.md): The stored body supplies the message; the request supplies the envelope and the values.
- [List template images](https://nextmail.sh/docs/api/templates/images.md): The images uploaded for templates, newest first.
- [Upload a template image](https://nextmail.sh/docs/api/templates/upload-image.md): Store an image and get its public address for a template.
- [Design a template from a brief](https://nextmail.sh/docs/api/templates/design.md): A designer builds a new block template from what you write.
- [Change a template’s design](https://nextmail.sh/docs/api/templates/redesign.md): A designer applies your instructions and leaves the rest alone.
- [List rules](https://nextmail.sh/docs/api/rules/list.md): Every rule on the connection, in the order they are evaluated.
- [Create a rule](https://nextmail.sh/docs/api/rules/create.md): Conditions on one side, actions on the other. Enabled unless you say otherwise.
- [Retrieve a rule](https://nextmail.sh/docs/api/rules/get.md): One rule in full, with its conditions, its actions and how often it has fired.
- [Update a rule](https://nextmail.sh/docs/api/rules/update.md): Every field is optional, and `conditions` and `actions` replace whole.
- [Delete a rule](https://nextmail.sh/docs/api/rules/delete.md): The rule goes; what it already did to your mail stays.
- [Reorder rules](https://nextmail.sh/docs/api/rules/reorder.md): The whole order in one call, because a rule list only means anything in order.
- [Test a rule](https://nextmail.sh/docs/api/rules/test.md): Which of your recent messages this rule would have caught. It changes nothing.
- [List rule runs](https://nextmail.sh/docs/api/rules/runs.md): What your rules have actually done, one row per rule per message.
- [List contacts](https://nextmail.sh/docs/api/contacts/list.md): The workspace address book, most recently seen first, with contacts that have never been mailed last. Every key on the workspace reads the same rows, so a contact saved by one member is a contact every member and every key sees. Paging is keyset: `limit` goes up to 200 and defaults to 50, and `nextCursor` goes back as `cursor` while `hasMore` is true.
- [List people](https://nextmail.sh/docs/api/contacts/people.md): Everyone the Contacts page in the app lists: the saved contacts, and every address seen in mail as the sender or a recipient of a thread's newest message, with how many threads each shares with the mailbox and when mail last moved. A person seen in mail and saved is one row. Paging is keyset: `limit` goes up to 100 and defaults to 25, and `nextCursor` goes back as `cursor` while `hasMore` is true.
- [Retrieve a contact](https://nextmail.sh/docs/api/contacts/get.md): Addresses are stored lowercased and the lookup matches that way, so case in the path does not matter. The single-contact response also carries `audiences`, every list the contact is in.
- [Create a contact](https://nextmail.sh/docs/api/contacts/create.md): Saves one address in the workspace address book. The address is the identity, so there is no id to choose and none in the response. It is trimmed and lowercased before it is stored, and the contact is saved with `source` set to `manual`. The new contact joins the built-in default audience as it is written, plus anything named in `audienceIds`.
- [Save a contact](https://nextmail.sh/docs/api/contacts/save.md): Does what Add to contacts and Keep in contacts do in the app, and is safe whatever state the address is in. An address that is not a contact yet becomes one, answered with `201`. One recorded from a send becomes `manual`, and one already saved keeps what it has, answered with `200`. A deleted address is brought back. The body is optional.
- [Update a contact](https://nextmail.sh/docs/api/contacts/update.md): A partial update, never an upsert. A field you leave out keeps its stored value and an explicit `null` clears it, so `{"notes": null}` empties the notes while `{}` changes nothing. An address not in the book is a `404`.
- [Set a contact's audiences](https://nextmail.sh/docs/api/contacts/audiences.md): Says exactly which audiences one contact is in, in one call. The contact joins every audience in `audienceIds` it is not in yet and leaves every other one. The default audience is always kept, so an empty list leaves the contact in the default audience alone.
- [Set a contact photo](https://nextmail.sh/docs/api/contacts/photo-set.md): Uploads the photo shown for a contact, replacing any there was. The body is the image itself, not JSON, with its type in `Content-Type`: `image/png`, `image/jpeg`, `image/webp` or `image/gif`, up to 5 MB. It is fitted into a 512 pixel square and stored as WebP, and an animated image keeps its first frame.
- [Remove a contact photo](https://nextmail.sh/docs/api/contacts/photo-remove.md): Takes the photo off the contact and deletes the stored image, the way Remove does on a contact in the app.
- [Block a contact](https://nextmail.sh/docs/api/contacts/block.md): Puts the address on the workspace blocklist, the one `PATCH /settings` edits as `blockedSenders`, so mail from it is refused from then on. This is Block on a contact in the app. The address does not have to be a contact.
- [Unblock a contact](https://nextmail.sh/docs/api/contacts/unblock.md): Takes every workspace blocklist rule that blocks the address off the list, and lists them in `removed`. This is Unblock on a contact in the app.
- [List conversations with a contact](https://nextmail.sh/docs/api/contacts/threads.md): Every thread the address wrote or was written to, in every folder: the Mail tab on a contact in the app. The address does not have to be a saved contact. `limit` goes up to 100 and defaults to 25, and `nextCursor` goes back as `cursor` while `hasMore` is true.
- [Read activity with a contact](https://nextmail.sh/docs/api/contacts/activity.md): The numbers behind the Activity tab on a contact in the app, over a window that ends now: messages received from the address and sent to it per bucket, the threads that moved, the threads waiting on a reply from the mailbox, when each side last wrote, and the median time each side takes to answer.
- [Delete a contact](https://nextmail.sh/docs/api/contacts/delete.md): Deletes somebody from the contacts the way Delete does in the app. A saved contact goes, and in the same transaction every audience membership it held, including the built-in default one, and its photo. The address is then hidden: it leaves `GET /contacts/people`, and mail sent to it from the app composer no longer records it. No mail moves, and the address can still be written to.
- [Delete contacts in bulk](https://nextmail.sh/docs/api/contacts/batch-delete.md): Deletes up to 200 addresses in one call, each the way `DELETE /contacts/{email}` deletes one: a saved contact goes with its notes, photo and audience memberships, and every address is hidden, so a send does not record it again.
- [List audiences](https://nextmail.sh/docs/api/audiences/list.md): An audience is a named list of contacts in this workspace. Every contact is in the built-in default audience from the moment it exists, and `builtin` is what names that row; the rest are yours to make, fill and delete. The default audience comes first, then the rest newest first. Send to one or more of them with `POST /broadcasts`.
- [Create an audience](https://nextmail.sh/docs/api/audiences/create.md): Makes a new, empty audience and returns it with its id. `name` is trimmed and must then be 1 to 120 characters. `description` is optional free text for whoever reads the list later. Names are not checked for duplicates, because an audience is addressed by its id.
- [Retrieve an audience](https://nextmail.sh/docs/api/audiences/get.md): The same shape as a list row, with a fresh `contactCount`. This is the cheap way to watch a count move without pulling the contacts behind it.
- [Update an audience](https://nextmail.sh/docs/api/audiences/update.md): A partial update. A field you leave out keeps its stored value and an explicit `null` clears it. The built-in default audience can be renamed and described like any other, and renaming it changes neither `builtin` nor what it holds.
- [Delete an audience](https://nextmail.sh/docs/api/audiences/delete.md): Deletes the audience and drops every membership it held, in one transaction. The contacts themselves are not touched: they stay in the address book, in the default audience, and in any other audience they were in.
- [Empty an audience](https://nextmail.sh/docs/api/audiences/empty.md): Takes every contact out of the audience in one transaction. The audience stays, with its id, name and description, and every contact stays in the address book, in the default audience and in its other audiences.
- [Read audience growth](https://nextmail.sh/docs/api/audiences/growth.md): How many contacts joined each audience over a window that ends now, counted by day, hour or minute: the growth chart on the audiences page. An audience records when somebody joined and never when they left, so every figure counts the people still in the list today by the date they joined, and a line never falls.
- [List an audience's contacts](https://nextmail.sh/docs/api/audiences/contacts.md): The contacts themselves rather than membership records, each with `addedAt`, the moment it joined this audience. By default they come in the same order as the contacts list: most recently seen first, with contacts that have never been mailed last. `limit` goes up to 200 and defaults to 50, and `cursor` takes the previous page's `nextCursor`, so every contact in the audience is reachable. Reading the default audience here returns the whole address book.
- [Add a contact to an audience](https://nextmail.sh/docs/api/audiences/add.md): Takes an address already in the workspace book and returns the membership, with the contact it points at. There is one membership per audience and contact, so adding somebody already in the audience answers `200` with the original `addedAt` rather than adding a second one or failing. That makes the call safe to retry.
- [Add contacts to an audience in bulk](https://nextmail.sh/docs/api/audiences/add-batch.md): Puts up to 200 contacts in one audience in one call, by address. Like the single add, it takes addresses that are already in the workspace book and never creates a contact: an address that is not one comes back in `missing` and nothing is written for it, while the rest of the call still goes through.
- [Import contacts into an audience](https://nextmail.sh/docs/api/audiences/import.md): The CSV import on the audience page, over the API. Every well-formed address becomes a contact if it is not one yet, and every one lands in this audience, up to 500 rows per call. Send a longer list in several calls.
- [Remove a contact from an audience](https://nextmail.sh/docs/api/audiences/remove.md): Drops one membership and leaves everything else alone. The contact stays in the address book, stays in the default audience and stays in every other audience it was in.
- [Remove contacts from an audience in bulk](https://nextmail.sh/docs/api/audiences/remove-batch.md): Takes up to 200 contacts out of one audience in one call, by address. Every one of them stays in the address book, in the default audience and in every other audience it was in.
- [How forms work](https://nextmail.sh/docs/api/forms/overview.md): Sign-up forms put people into your audiences. Build one here, share it as a link, embed it on any site, or post to it from your own code.
- [List forms](https://nextmail.sh/docs/api/forms/list.md): Every sign-up form in the workspace, newest first, without the document or settings. `stats` is counted at the moment of the read.
- [Create a form](https://nextmail.sh/docs/api/forms/create.md): Makes a draft from `document`, from a `starter`, or from a one-field email form when you send neither, and returns the whole form. Send `publish: true` to put it live in the same call.
- [Retrieve a form](https://nextmail.sh/docs/api/forms/get.md): The whole form: the draft `document`, the `publishedDocument` visitors see, `settings`, the audiences by name and fresh `stats`.
- [Update a form](https://nextmail.sh/docs/api/forms/update.md): A partial update. `document` replaces the draft whole, and a live form keeps showing its published copy until you publish. `settings` is merged field by field and takes effect at once.
- [Delete a form](https://nextmail.sh/docs/api/forms/delete.md): Deletes the form and every submission it holds. Its page and embed stop working at once. The people it added stay in your contacts and audiences.
- [Publish a form](https://nextmail.sh/docs/api/forms/publish.md): Copies the draft to `publishedDocument` and sets the form `live`, so the page, the embed and the subscribe endpoint use the new version. Publishing a paused form opens it again.
- [Pause or resume a form](https://nextmail.sh/docs/api/forms/pause.md): Pausing stops a published form taking sign-ups. Its page stays up and shows the closed message from its copy. `POST /forms/{id}/resume` opens it again with the version published last.
- [Duplicate a form](https://nextmail.sh/docs/api/forms/duplicate.md): Makes a new draft with the same document and settings, and "copy" after the name. Submissions and statistics stay with the original.
- [Design a form from a brief](https://nextmail.sh/docs/api/forms/design.md): A designer builds a new sign-up form from a written brief and saves it as a draft, as Create with AI does on the Forms page of the app.
- [Change a form’s design](https://nextmail.sh/docs/api/forms/redesign.md): A designer applies written instructions to the draft of a form and leaves the rest alone, as Ask AI does in the form builder of the app.
- [Form starters](https://nextmail.sh/docs/api/forms/starters.md): The starting points the app offers when somebody makes a form: a newsletter, a waitlist, an event, early access, a contact form and a blank one. They ship with the product, so the list is the same for every workspace.
- [Form analytics](https://nextmail.sh/docs/api/forms/analytics.md): Views, submissions and people added over a window, in buckets, with totals and the conversion rate.
- [List submissions](https://nextmail.sh/docs/api/forms/submissions.md): Every sign-up the form stored, newest first, with each answer as it was sent.
- [Retrieve or delete a submission](https://nextmail.sh/docs/api/forms/submission.md): One sign-up with every answer. `DELETE` on the same path deletes it.
- [Delete submissions](https://nextmail.sh/docs/api/forms/delete-submissions.md): Deletes up to 200 submissions of one form in a single call and says how many went.
- [Approve a submission](https://nextmail.sh/docs/api/forms/approve.md): Adds the person of a pending sign-up to its audiences without waiting for them to confirm, for when you know them.
- [Resend a confirmation](https://nextmail.sh/docs/api/forms/resend.md): Emails a pending sign-up a fresh confirmation link from the form's sender.
- [Sign up through a form](https://nextmail.sh/docs/api/forms/subscribe.md): Where a published form's visitors post. It takes no credential, so call it from a browser or your own server, from any origin.
- [Send to audiences](https://nextmail.sh/docs/api/broadcasts/send.md): Sends one message to everybody in one or more audiences, as a separate copy for each person and personalised from each contact. Every copy has exactly one recipient and no cc or bcc, so nobody sees who else it went to, and every copy is an ordinary email with its own `msg_` id, events, tracking and webhooks. The call answers `202` straight away and the sending runs in the background, so follow it with `GET /broadcasts/{id}`.
- [Count who a broadcast would reach](https://nextmail.sh/docs/api/broadcasts/preview.md): The numbers a send to these audiences would start from, without sending or writing anything: how many people it would reach, how many are skipped because they unsubscribed, and how many because their address is suppressed. A contact in several of the audiences counts once.
- [List broadcasts](https://nextmail.sh/docs/api/broadcasts/list.md): Every broadcast in this workspace, newest first, one page at a time, each with live `counts`. `audienceId` keeps the ones that were sent to that audience, alone or beside others.
- [Retrieve a broadcast](https://nextmail.sh/docs/api/broadcasts/get.md): One broadcast with `counts` read live from its copies, which makes this the call to poll while it sends.
- [List the recipients of a broadcast](https://nextmail.sh/docs/api/broadcasts/recipients.md): Everybody the broadcast went to, one row per copy, sorted by address: the copy id, its status, when it was sent and delivered, whether it bounced or was reported as spam, how often it was opened and clicked, and whether the person unsubscribed after it went out.
- [Retrieve one copy of a broadcast](https://nextmail.sh/docs/api/broadcasts/recipient.md): One person's copy: the same row `GET /broadcasts/{id}/recipients` lists, plus the subject, HTML and text exactly as that person received them, with the merge fields filled in and their own unsubscribe link.
- [Broadcast statistics](https://nextmail.sh/docs/api/broadcasts/stats.md): How the broadcast performed: copies sent, delivered, bounced, reported as spam and failed, and how many people opened, clicked and unsubscribed, as totals and as a series cut to `grain`.
- [Broadcast analytics](https://nextmail.sh/docs/api/broadcasts/analytics.md): How the broadcasts sent over a window that ends now did, added up and counted by day, hour or minute, with one row per broadcast to compare them: the Analytics tab of the Broadcasts page.
- [Cancel a broadcast](https://nextmail.sh/docs/api/broadcasts/cancel.md): Stops a broadcast that is `scheduled`, `queued` or `sending`, including one that has reached everybody while some copies are still waiting to go. Nobody else is added, and every copy still waiting is cancelled.
- [How automations work](https://nextmail.sh/docs/api/automations/overview.md): An automation mails people one at a time as things happen: somebody joins a list, fills in a form, does something in your product, or has a birthday. You describe the path once and each person walks it at their own pace.
- [List automations](https://nextmail.sh/docs/api/automations/list.md): Every automation in the workspace, most recently changed first, without the definition or settings.
- [Create an automation](https://nextmail.sh/docs/api/automations/create.md): Makes a draft from a `definition`, from a `starter`, or an empty one when you send neither, and returns the whole automation. Nothing runs until you publish it.
- [Retrieve an automation](https://nextmail.sh/docs/api/automations/get.md): One automation in full: the draft `definition`, the `published` version that is running, the settings, the numbers and what is wrong with the draft.
- [Update an automation](https://nextmail.sh/docs/api/automations/update.md): Changes the name, the description, the settings or the draft definition. Settings apply at once. A new definition replaces the whole draft and changes nothing for the people inside until you publish.
- [Publish an automation](https://nextmail.sh/docs/api/automations/publish.md): Freezes the draft as the next version and turns the automation on. People enter from this moment, and nobody who met the trigger earlier is added.
- [Pause, resume and archive](https://nextmail.sh/docs/api/automations/pause.md): Pausing stops a live automation without losing anybody: nobody new enters and everybody inside holds at their step. Resuming carries on from there, and archiving retires the automation for good.
- [Duplicate an automation](https://nextmail.sh/docs/api/automations/duplicate.md): Copies an automation into a new draft with the same definition and settings, and none of its versions, people or numbers.
- [Delete an automation](https://nextmail.sh/docs/api/automations/delete.md): Deletes an automation for good, with its versions, the record of who went through it and its numbers. The emails it already sent are kept, like any other email.
- [Send a test email](https://nextmail.sh/docs/api/automations/test.md): Sends one email step of the draft to an address of your choice, filled in with sample values, so you can read it before anybody else does.
- [Versions](https://nextmail.sh/docs/api/automations/versions.md): Every version that was published, newest first, each with the definition it froze. Restoring one copies it back into the draft.
- [Automation starters](https://nextmail.sh/docs/api/automations/starters.md): The starting points the app offers when somebody makes an automation: a welcome series, a trial follow-up, a birthday email and a win-back. They ship with the product, so the list is the same for every workspace.
- [Automation stats](https://nextmail.sh/docs/api/automations/stats.md): How an automation is doing inside a window: totals, a row for each step and a point for each day.
- [All automations at once](https://nextmail.sh/docs/api/automations/analytics.md): Every automation of the workspace side by side over a window: totals, a row for each automation and a point for each day.
- [Run log](https://nextmail.sh/docs/api/automations/runs.md): Everything an automation did, newest first: each person entering, every step it ran for them, and each person finishing.
- [People in an automation](https://nextmail.sh/docs/api/automations/enrollments.md): The people who entered an automation, newest first, with the step each one is on. One enrollment read by id also carries every step it ran.
- [Add and remove people](https://nextmail.sh/docs/api/automations/enroll.md): Puts a contact into a live automation at its first step, whatever its trigger, or takes somebody out before they finish.
- [Send an event](https://nextmail.sh/docs/api/automations/events.md): Records that a contact did something in your product. The event starts every live automation whose trigger names it and moves on anybody who was waiting for it.
- [Read events](https://nextmail.sh/docs/api/automations/event-history.md): The events one contact did, newest first, and the event names the workspace has sent, for choosing one in a trigger.
- [How tasks work](https://nextmail.sh/docs/api/tasks/overview.md): A task is an instruction the assistant follows by itself: every morning, whenever mail arrives, or once in the background. You say what to do in plain words and how much it may do without asking, and each run leaves a record of every step it took.
- [List tasks](https://nextmail.sh/docs/api/tasks/list.md): Every task in the workspace, most recently changed first.
- [Create a task](https://nextmail.sh/docs/api/tasks/create.md): Saves an instruction with a trigger and turns it on. A schedule task runs at its next time, and a mail task from the next message that arrives.
- [Retrieve a task](https://nextmail.sh/docs/api/tasks/get.md): One task with its trigger, its settings, and when it last ran and will run next.
- [Update a task](https://nextmail.sh/docs/api/tasks/update.md): Changes a task. Send only the fields that change.
- [Delete a task](https://nextmail.sh/docs/api/tasks/delete.md): Deletes a task for good, with every run it made, their transcripts and their approval requests. Mail it sent or sorted stays as it is.
- [Pause and resume](https://nextmail.sh/docs/api/tasks/pause.md): Pausing stops a task from starting runs. Resuming turns it back on and clears its count of failed runs.
- [Run a task now](https://nextmail.sh/docs/api/tasks/run.md): Starts a run of a task at once, whatever its trigger, and returns the run. A paused task can be run this way too.
- [List runs](https://nextmail.sh/docs/api/tasks/runs.md): Runs across the workspace, newest first, without their transcripts.
- [Start a one-off run](https://nextmail.sh/docs/api/tasks/start-run.md): Hands the assistant one job to do in the background, with no task saved. Use it for work that takes too long to wait for in a chat.
- [Retrieve a run](https://nextmail.sh/docs/api/tasks/run-detail.md): One run with its transcript and every approval request it made.
- [Cancel a run](https://nextmail.sh/docs/api/tasks/cancel-run.md): Stops a run that is queued, running or waiting, and cancels the approval requests it left open.
- [List approval requests](https://nextmail.sh/docs/api/tasks/approvals.md): What runs are waiting for a person to allow, newest first.
- [Approve or deny a request](https://nextmail.sh/docs/api/tasks/approve.md): Answers what a run asked. Approving carries the action out as the run wrote it, or with your words in place of its own.
- [List domains](https://nextmail.sh/docs/api/domains/list.md): Every domain on the workspace, with its receiving, sending, tracking and files state.
- [Retrieve a domain](https://nextmail.sh/docs/api/domains/get.md): Adds the addresses on it, every DNS record the domain needs with what the last check found, and the DMARC reading.
- [Update a domain](https://nextmail.sh/docs/api/domains/update.md): Turns the catch-all on or off, sets, checks again or removes the domain’s custom tracking domain and custom files domain, and sets its DMARC policy and the name its mail goes out under.
- [Add a domain](https://nextmail.sh/docs/api/domains/create.md): Adds a domain to the workspace and returns it with every DNS record it needs. The domain starts unverified, with its catch-all on, and verifies on its own once the records answer in public DNS.
- [Check a domain now](https://nextmail.sh/docs/api/domains/verify.md): Checks the domain’s DNS at once and returns it with what the check found. On an unverified domain that is the verification records, and on a verified one the signing records and whether mail from it can be sent. No body.
- [Remove a domain](https://nextmail.sh/docs/api/domains/delete.md): Removes the domain from the workspace. Its addresses stop receiving, mail from it can no longer be sent, its tracking and files domains stop answering, and `domain.deleted` fires. Mail already received stays in the mailbox.
- [List addresses](https://nextmail.sh/docs/api/domains/addresses/list.md): The addresses that exist on the domain, alphabetically, a page at a time with `limit` and `cursor`.
- [Create an address](https://nextmail.sh/docs/api/domains/addresses/create.md): Creates an address on the domain. It receives as soon as the domain does, and it can be sent from once the domain can send.
- [Retrieve an address](https://nextmail.sh/docs/api/domains/addresses/get.md): One address on the domain.
- [Update an address](https://nextmail.sh/docs/api/domains/addresses/update.md): Renames the address in the app, turns it off and on, or chooses where its mail goes. A field left out keeps its value.
- [Remove an address](https://nextmail.sh/docs/api/domains/addresses/delete.md): Removes the address. It stops receiving, anyone it was shared with loses it, and a sign-in set up for it stops working. Mail it already received stays in the mailbox.
- [Retrieve the web app address](https://nextmail.sh/docs/api/app-host/get.md): The web app address of the workspace, whether people can sign in there, and the DNS records it needs. With none set, `status` is `none` and `domains` lists the verified domains of the workspace.
- [Set the web app address](https://nextmail.sh/docs/api/app-host/set.md): Sets the web app address of the workspace, replacing any it had, and returns it with the DNS records to publish.
- [Check the web app address now](https://nextmail.sh/docs/api/app-host/verify.md): Checks the web app address at once, whether its DNS records answer and its certificate is issued, and returns it with what the check found. No body.
- [Remove the web app address](https://nextmail.sh/docs/api/app-host/delete.md): Removes the web app address. Everyone signed in there is signed out and the address stops opening the workspace, while nextmail.sh keeps working for the same people.
- [Retrieve the brand](https://nextmail.sh/docs/api/branding/get.md): The brand of the workspace: a link to each brand image, the primary and secondary fonts, and the background of the sign-in page.
- [Change the fonts and the sign-in background](https://nextmail.sh/docs/api/branding/update.md): Changes the fonts, the sign-in page background or both, and returns the brand. A field left out keeps its value.
- [Upload a brand image](https://nextmail.sh/docs/api/branding/upload-image.md): Uploads one brand image, replacing the one there was, and returns the brand. The body is the image itself, not JSON.
- [Remove a brand image](https://nextmail.sh/docs/api/branding/remove-image.md): Removes one brand image and deletes the stored file, so the default shows in its place, and returns the brand.
- [Forward an address](https://nextmail.sh/docs/api/domains/addresses/forwards.md): Where the mail of an address goes besides its mailbox. Every destination confirms by email before it receives anything.
- [List who reaches an address](https://nextmail.sh/docs/api/domains/addresses/members.md): Everybody who can read the mail of an address, and how each one reaches it.
- [Sign in as one address](https://nextmail.sh/docs/api/domains/addresses/login.md): A password of its own lets somebody sign in to Nextmail as one address, and read and send only its mail.
- [DNS connections](https://nextmail.sh/docs/api/dns-connections.md): The DNS provider accounts connected to the workspace, through which Nextmail writes the records of a domain itself. One is connected in the app, because the provider asks the person to sign in.
- [Set up the DNS of a domain](https://nextmail.sh/docs/api/domains/dns.md): Whether Nextmail writes the records of a domain itself, through which connected zone, and where each kind of record stands.
- [List suppressed addresses](https://nextmail.sh/docs/api/suppressions/list.md): The addresses this workspace will not send to, newest first.
- [Retrieve a suppressed address](https://nextmail.sh/docs/api/suppressions/get.md): One row of the suppression list, by id.
- [Add a suppressed address](https://nextmail.sh/docs/api/suppressions/add.md): Stop sending to an address, by hand.
- [Remove a suppressed address](https://nextmail.sh/docs/api/suppressions/remove.md): Allow mail to an address again.
- [List files](https://nextmail.sh/docs/api/files/list.md): Every file the mailbox holds: attachments sent and received, and uploads.
- [Retrieve a file](https://nextmail.sh/docs/api/files/get.md): One file, by id.
- [Download a file](https://nextmail.sh/docs/api/files/content.md): The bytes, exactly as stored.
- [List the download links of a file](https://nextmail.sh/docs/api/files/links.md): How often each copy sent as a link was fetched.
- [Publish a file at a public link](https://nextmail.sh/docs/api/files/create-link.md): Makes a public download link that opens the file with no sign-in, for an image or a document referenced from an email or a web page.
- [Revoke a public link](https://nextmail.sh/docs/api/files/revoke-link.md): Stops a download link from working, for good, including in mail that already went out with it.
- [File stats](https://nextmail.sh/docs/api/files/stats.md): The numbers on the Analytics tab of the Files page.
- [Upload a file](https://nextmail.sh/docs/api/files/upload.md): Stores a file in the workspace, the way the Upload button on the Files page does. The body is the file itself, not JSON and not multipart, with its type in `Content-Type`.
- [Delete a file](https://nextmail.sh/docs/api/files/delete.md): Deletes an upload that nothing depends on. Its bytes go, and there is no undo.
- [Delete files in bulk](https://nextmail.sh/docs/api/files/batch-delete.md): Deletes up to 100 files in one call, each the way `DELETE /files/{id}` deletes one, as selecting several on the Files page does.
- [Revoke every link to a file](https://nextmail.sh/docs/api/files/revoke-links.md): Makes the file private: every public link to it stops working, including in mail already sent.
- [List the notes on a thread](https://nextmail.sh/docs/api/notes/list.md): The private notes on one thread, pinned ones first.
- [Add a note to a thread](https://nextmail.sh/docs/api/notes/create.md): Pin a private note to a thread.
- [Change a note](https://nextmail.sh/docs/api/notes/update.md): Its text, its colour or whether it is pinned.
- [Delete a note](https://nextmail.sh/docs/api/notes/delete.md): Gone for good. There is no bin for notes.
- [Arrange the notes on a thread](https://nextmail.sh/docs/api/notes/reorder.md): Every note, first to last.
- [Read the team on a thread](https://nextmail.sh/docs/api/team/get.md): Who has it, who is replying and who can see it.
- [Assign a thread](https://nextmail.sh/docs/api/team/assign.md): Give it to one person who can see it.
- [Unassign a thread](https://nextmail.sh/docs/api/team/unassign.md): Leave it with nobody.
- [Mark a thread done](https://nextmail.sh/docs/api/team/done.md): Archive it for everyone.
- [Reopen a thread](https://nextmail.sh/docs/api/team/reopen.md): Back to the inbox for everyone.
- [List the comments on a thread](https://nextmail.sh/docs/api/team/comments/list.md): Team comments, oldest first.
- [Comment on a thread](https://nextmail.sh/docs/api/team/comments/create.md): Write to the team, not the sender.
- [Change a comment](https://nextmail.sh/docs/api/team/comments/update.md): Its text and its mentions.
- [Delete a comment](https://nextmail.sh/docs/api/team/comments/delete.md): Gone for good.
- [How the knowledge base works](https://nextmail.sh/docs/api/knowledge/overview.md): The notes, files and web pages the AI uses when it suggests replies, drafts email and answers in the assistant, kept for the whole workspace, one domain or one address.
- [List knowledge items](https://nextmail.sh/docs/api/knowledge/list.md): The items in the knowledge base, newest first, a page at a time.
- [List knowledge levels](https://nextmail.sh/docs/api/knowledge/levels.md): Every level you can see, how many items each holds and whether you may change items there.
- [Read knowledge base usage](https://nextmail.sh/docs/api/knowledge/usage.md): How many items and characters of text the workspace keeps, against what its plan allows.
- [Search the knowledge base](https://nextmail.sh/docs/api/knowledge/search.md): The passages that best answer a question, found the way the AI finds them.
- [Add a note](https://nextmail.sh/docs/api/knowledge/notes.md): A note of up to 20,000 characters at one level, usually ready within a second or two.
- [Add a link](https://nextmail.sh/docs/api/knowledge/links.md): A public web page, fetched and read in the background.
- [Upload a file](https://nextmail.sh/docs/api/knowledge/files.md): A document or an image, sent as the request body and read in the background.
- [Get a knowledge item](https://nextmail.sh/docs/api/knowledge/get.md): One item with its text.
- [Change a knowledge item](https://nextmail.sh/docs/api/knowledge/update.md): Its title, the text of a note, the page of a link, its level or whether a note is pinned.
- [Delete a knowledge item](https://nextmail.sh/docs/api/knowledge/delete.md): Gone for good, with its file and its passages.
- [Read a knowledge item again](https://nextmail.sh/docs/api/knowledge/refresh.md): Fetches a link again, reads a file again or indexes a note again.
- [Count the mail in each folder](https://nextmail.sh/docs/api/threads/counts.md): What the sidebar of the app shows, for every folder, label and address.
- [Read the summary of a thread](https://nextmail.sh/docs/api/threads/summary.md): The short AI summary the reading pane shows above a thread.
- [Take a thread out of the Bin](https://nextmail.sh/docs/api/threads/restore.md): Back to the inbox, out of the Bin and out of Spam.
- [Delete a thread for good](https://nextmail.sh/docs/api/threads/delete.md): Every message in it, with its attachments. There is no undo.
- [Suggest replies to a thread](https://nextmail.sh/docs/api/threads/reply-suggestions.md): The short replies the reading pane offers under the latest message.
- [Read what is known about a sender](https://nextmail.sh/docs/api/senders/get.md): The line the reading pane shows under an unfamiliar sender.
- [Look a sender up](https://nextmail.sh/docs/api/senders/research.md): Search the web for the organisation behind a domain and keep what was found.
- [Check the DMARC policy of a domain](https://nextmail.sh/docs/api/tools/dmarc.md): What the DMARC record of any domain says, and what is wrong with it.
- [Check the BIMI logo of a domain](https://nextmail.sh/docs/api/tools/bimi.md): Whether inboxes can draw the logo a domain publishes, and what stops them.
- [Check the deliverability of a domain](https://nextmail.sh/docs/api/tools/deliverability.md): The records a receiving mailbox reads before it trusts mail from a domain, scored.
- [Read the sign-in code in a message](https://nextmail.sh/docs/api/tools/verification-code.md): The verification code in a message you pass in, when the reader is sure of it.
- [Estimate what Nextmail costs](https://nextmail.sh/docs/api/tools/cost.md): Every plan priced for a usage, and the cheapest one that fits.
- [Check an email address](https://nextmail.sh/docs/api/tools/address.md): Whether an address is worth sending to, before the first message.
- [Write to Nextmail support](https://nextmail.sh/docs/api/support/send.md): A message to the people who build Nextmail, answered by email.
- [List your published keys](https://nextmail.sh/docs/api/encryption/list-keys.md): The OpenPGP public keys published for your addresses, newest first.
- [Publish a public key](https://nextmail.sh/docs/api/encryption/publish-key.md): Lets senders seal mail to one of your addresses.
- [Find the keys to seal mail to](https://nextmail.sh/docs/api/encryption/lookup-keys.md): The live public keys of each recipient, before a message is sealed.
- [List the assistant chats](https://nextmail.sh/docs/api/chats/list.md): The conversations held with the assistant in the app, newest first.
- [Retrieve a chat](https://nextmail.sh/docs/api/chats/get.md): One chat with the assistant, by id.
- [Rename a chat](https://nextmail.sh/docs/api/chats/rename.md): Gives a chat a new title.
- [Delete a chat](https://nextmail.sh/docs/api/chats/delete.md): The chat and every message in it, for good.
- [See what an export would hold](https://nextmail.sh/docs/api/exports/preview.md): Whether an export can start now, and how much it would hold.
- [List the exports](https://nextmail.sh/docs/api/exports/list.md): Every export of the workspace, newest first.
- [Retrieve an export](https://nextmail.sh/docs/api/exports/get.md): One export, with its status and progress.
- [Start an export](https://nextmail.sh/docs/api/exports/start.md): A zip of the whole workspace, made in the background.
- [Download an export](https://nextmail.sh/docs/api/exports/download.md): The zip of a ready export.
- [Read how mail arrives](https://nextmail.sh/docs/api/analytics/mailbox.md): How mail arrives, as the Analytics page of the app shows it.
- [Read what became of sent mail](https://nextmail.sh/docs/api/analytics/sending.md): What became of the mail sent, as the Analytics page of the app shows it.
- [List subscriptions](https://nextmail.sh/docs/api/subscriptions/list.md): The newsletters and mailing lists the mailbox receives, as the Subscriptions page shows them.
- [List subscriptions by domain](https://nextmail.sh/docs/api/subscriptions/list-domains.md): One row per sender domain, so a company that writes from several addresses is one row.
- [Keep subscriptions](https://nextmail.sh/docs/api/subscriptions/keep.md): What Keep does on the Subscriptions page.
- [Unsubscribe from a sender](https://nextmail.sh/docs/api/subscriptions/unsubscribe.md): What the Unsubscribe button of the Subscriptions page does.
- [Unsubscribe from several senders](https://nextmail.sh/docs/api/subscriptions/unsubscribe-many.md): What Unsubscribe does on a selection of the Subscriptions page.
- [Unsubscribe from a whole domain](https://nextmail.sh/docs/api/subscriptions/unsubscribe-domain.md): Every sender on one domain at once, as the domain view of the Subscriptions page does.
- [Move what a sender sent](https://nextmail.sh/docs/api/subscriptions/move.md): Clear a sender out of the inbox, and keep it out.
- [Move what several senders sent](https://nextmail.sh/docs/api/subscriptions/move-many.md): What Archive does on a selection of the Subscriptions page.
- [Unsubscribe from the sender of a thread](https://nextmail.sh/docs/api/threads/unsubscribe.md): What the Unsubscribe button of the reading pane does.
- [List the calendar](https://nextmail.sh/docs/api/calendar/list.md): Every occurrence between two moments, a repeating event once for each time it happens, sorted by start.
- [Retrieve an event](https://nextmail.sh/docs/api/calendar/get.md): One event with its attendees and their answers, how it repeats and its reminders.
- [Create an event](https://nextmail.sh/docs/api/calendar/create.md): Puts an event on the calendar, as New event does in the app, and invites the attendees.
- [Change an event](https://nextmail.sh/docs/api/calendar/update.md): Changes an event you organise and sends the update to everyone invited.
- [Cancel a meeting](https://nextmail.sh/docs/api/calendar/cancel.md): Calls off a meeting you organise and tells everyone invited, as Cancel meeting does in the app.
- [Remove an event](https://nextmail.sh/docs/api/calendar/delete.md): Takes an event off the calendar for good, as Remove does in the app. Nobody else is told.
- [Answer an invitation](https://nextmail.sh/docs/api/calendar/respond.md): Accepts, declines or tentatively accepts an invitation, and tells the organiser.
- [The event a thread carries](https://nextmail.sh/docs/api/calendar/thread-event.md): The calendar event that came with an invitation in a thread, as the invitation card of the reading pane shows it.
- [Decline a proposed time](https://nextmail.sh/docs/api/calendar/decline-proposal.md): Keeps the original time of a meeting you organise after a guest proposed another one, and tells the guest.
- [Calendar links](https://nextmail.sh/docs/api/calendar/feeds.md): Secret links that publish your calendar to Google Calendar, Outlook or Apple Calendar.
- [Calendar subscriptions](https://nextmail.sh/docs/api/calendar/subscriptions.md): Other calendars you subscribe to by link, whose events show on your calendar read-only.
- [Read the plan](https://nextmail.sh/docs/api/billing/get.md): The plan of the workspace, what it includes and how much of it is used.
- [List the plans](https://nextmail.sh/docs/api/billing/plans.md): Every plan, cheapest first, with its price and what it includes.
- [Read the usage history](https://nextmail.sh/docs/api/billing/usage.md): Sends and AI actions per day, and what pay as you go extras cost per month.
- [List the billing alerts](https://nextmail.sh/docs/api/billing/alerts.md): What the billing banner of the app would say now, most urgent first.
- [Read pay as you go](https://nextmail.sh/docs/api/billing/pay-as-you-go.md): Whether usage past the allowances is billed, and what it costs so far.
- [Turn pay as you go on or off](https://nextmail.sh/docs/api/billing/pay-as-you-go-switch.md): The switch on Billing, and the card it needs the first time.
- [Set the pay as you go limit](https://nextmail.sh/docs/api/billing/pay-as-you-go-limit.md): How much extras may cost in a calendar month.
- [List the charges](https://nextmail.sh/docs/api/billing/invoices.md): Every charge of the workspace, each with its invoice.
- [Get the invoice of a charge](https://nextmail.sh/docs/api/billing/invoice.md): The link to the PDF, as JSON.
- [Save the billing details of a charge](https://nextmail.sh/docs/api/billing/invoice-details.md): The name and address billed, kept for later charges too.
- [Start a checkout](https://nextmail.sh/docs/api/billing/checkout.md): The link that buys a paid plan.
- [Open the billing portal](https://nextmail.sh/docs/api/billing/portal.md): The link where the plan is changed or cancelled.
- [List add-ons](https://nextmail.sh/docs/api/billing/add-ons.md): What can be bought on top of the plan: today, a dedicated sending IP.
- [Read out of office replies](https://nextmail.sh/docs/api/out-of-office/list.md): Every out of office reply saved in the workspace, or the one of a single address.
- [Set an out of office reply](https://nextmail.sh/docs/api/out-of-office/set.md): Save the reply of one address or catch-all, replacing whatever was saved.
- [Remove an out of office reply](https://nextmail.sh/docs/api/out-of-office/clear.md): The saved reply of one address or catch-all goes, and nothing is answered from it any more.
- [List the sending lanes](https://nextmail.sh/docs/api/sending/streams.md): The two lanes mail travels in, with their bounce and complaint numbers.
- [List dedicated IPs](https://nextmail.sh/docs/api/sending/dedicated-ips.md): The IP addresses only this workspace sends from, and how far their warm-up is.
- [List signatures](https://nextmail.sh/docs/api/signatures/list.md): Every signature in the workspace, or the signatures of one address.
- [Create a signature](https://nextmail.sh/docs/api/signatures/create.md): Add a named signature to an address or to a catch-all.
- [Read a signature](https://nextmail.sh/docs/api/signatures/get.md): One signature by its id.
- [Update a signature](https://nextmail.sh/docs/api/signatures/update.md): Rename it, rewrite its HTML, or change what it is the default for.
- [Delete a signature](https://nextmail.sh/docs/api/signatures/delete.md): The signature goes for good, and a default it held is left empty.
- [Copy a signature to other addresses](https://nextmail.sh/docs/api/signatures/copy.md): Put the same signature on other addresses, replacing the one with the same name there.
- [How booking pages work](https://nextmail.sh/docs/api/bookings/overview.md): A booking page is a public link where somebody picks a free time and books a meeting on a person’s calendar. The API manages the pages, reads the times they offer, and answers the bookings guests make.
- [List and read booking pages](https://nextmail.sh/docs/api/bookings/pages.md): Every booking page of the person, oldest first, or one page by its id.
- [Create a booking page](https://nextmail.sh/docs/api/bookings/create-page.md): Makes a page that takes bookings at once. Only `name` is required.
- [Update or delete a booking page](https://nextmail.sh/docs/api/bookings/update-page.md): Changes the name, the link, the status or any setting of a page, or removes the page.
- [Upload or remove the background photo](https://nextmail.sh/docs/api/bookings/background.md): Sets the photo that fills a booking page behind its card, or deletes it. The body is the image itself, not JSON.
- [List open times](https://nextmail.sh/docs/api/bookings/times.md): The start times a guest could book on a page in a window.
- [List and read bookings](https://nextmail.sh/docs/api/bookings/list.md): The meetings guests booked, for every page of the person or for one.
- [Approve or decline a booking](https://nextmail.sh/docs/api/bookings/approve.md): Answers a booking that waits for approval, on a page whose `config.approval` is true.
- [Cancel a booking or send its email again](https://nextmail.sh/docs/api/bookings/cancel.md): Calls off a meeting that has not ended, or sends the guest the latest email about their booking once more.
- [Reschedule a booking](https://nextmail.sh/docs/api/bookings/reschedule.md): Moves a meeting that has not started to a new time the page offers, and tells the guest.
- [Read booking analytics](https://nextmail.sh/docs/api/bookings/analytics.md): How the booking pages did over a window, and what is still to come.
- [How connectors work](https://nextmail.sh/docs/api/connectors/overview.md): A connector is an outside app, such as Slack, Notion or Google Drive, that a person connected so the assistant can look things up in it and act there. The API lists the apps that can be connected, starts and manages connections, runs their actions, and reads the record of what was done.
- [List apps that can be connected](https://nextmail.sh/docs/api/connectors/apps.md): The apps that can be connected, most used first, one app by its slug, and the categories they are sorted into.
- [List and read connectors](https://nextmail.sh/docs/api/connectors/list.md): The connectors the caller can reach, or one connector by its id.
- [Connect or reconnect an app](https://nextmail.sh/docs/api/connectors/connect.md): Starts connecting an app and returns the connector with the link a person finishes on. Reconnecting returns a fresh link for a connector that stopped working.
- [Update or disconnect a connector](https://nextmail.sh/docs/api/connectors/update.md): Renames a connector, pauses or resumes it, or changes its access. Disconnecting removes it for good.
- [Find what a connector can do](https://nextmail.sh/docs/api/connectors/actions.md): The actions of the app behind a connector, and the input one of them takes.
- [Run an action](https://nextmail.sh/docs/api/connectors/run.md): Runs one action in the connected app and returns what the app answered.
- [List what was done through connectors](https://nextmail.sh/docs/api/connectors/calls.md): Every action that ran through a connector the caller can reach, newest first.
- [Roles & access](https://nextmail.sh/docs/api/roles.md): What a person or a key may DO, and which addresses they may do it to. Two axes, two resources, and both have to agree before a message goes out.
- [List roles](https://nextmail.sh/docs/api/roles/list.md): Every role on the workspace, built-ins first, with how many people and keys hold each.
- [Create a role](https://nextmail.sh/docs/api/roles/create.md): A name and a list of permissions. What comes back is longer than what you sent.
- [Retrieve a role](https://nextmail.sh/docs/api/roles/get.md): One role in full, with its whole permission list and what currently holds it.
- [Update a role](https://nextmail.sh/docs/api/roles/update.md): Every field optional, and `permissions` replaces the whole list.
- [Delete a role](https://nextmail.sh/docs/api/roles/delete.md): Any role but the owner, and only once you have said where its holders go.
- [List permissions](https://nextmail.sh/docs/api/roles/permissions.md): The whole vocabulary, with the sentence and the heading each entry renders under.
- [List members](https://nextmail.sh/docs/api/members/list.md): Everybody in the workspace, the role each holds, and the addresses each was given.
- [Invite a member](https://nextmail.sh/docs/api/members/add.md): By email, with a role, and optionally with addresses and whole domains that land when they accept.
- [Retrieve a member](https://nextmail.sh/docs/api/members/get.md): One person, their role and their addresses, by account id.
- [Change a member’s role](https://nextmail.sh/docs/api/members/update.md): The role and nothing else. Addresses are the other axis and have their own calls.
- [Remove a member](https://nextmail.sh/docs/api/members/remove.md): Both axes at once: the role, and every address grant they hold here.
- [Grant and revoke an address](https://nextmail.sh/docs/api/members/addresses.md): The second axis: which addresses one person may reach, and at which level.
- [List pending invitations](https://nextmail.sh/docs/api/members/invitations.md): The invitations nobody has accepted yet, by email.
- [Withdraw an invitation](https://nextmail.sh/docs/api/members/invitations-revoke.md): The link stops working at once.
- [Send an invitation again](https://nextmail.sh/docs/api/members/invitations-resend.md): A new link and fourteen more days.
- [Grant and revoke a domain](https://nextmail.sh/docs/api/members/domains.md): A whole domain at once: every address on it, including ones added later.
- [Keys & webhook logs](https://nextmail.sh/docs/api/developer.md): The API keys of the workspace, and the logs of its webhooks.
- [API keys](https://nextmail.sh/docs/api/keys.md): Read, create, change, rotate and revoke keys, and read what they did.
- [Webhook deliveries and activity](https://nextmail.sh/docs/api/webhooks/logs.md): Every delivery attempt and every change to an endpoint, filtered the way the console filters them.
- [Webhook events and stats](https://nextmail.sh/docs/api/webhooks/events.md): The events an endpoint can subscribe to, and how the deliveries went.
- [Disposable inboxes](https://nextmail.sh/docs/api/temp-mail.md): A working address for somebody who has not got one: no account, no key, and a lease that ends within a day.
- [List pooled domains](https://nextmail.sh/docs/api/temp-mail/domains.md): The domains a disposable address can be issued on, and the call you make before you have anything to authenticate with.
- [Create an inbox](https://nextmail.sh/docs/api/temp-mail/create.md): Issues an address and returns the token that reads it. Every field is optional, including the body.
- [Retrieve an inbox](https://nextmail.sh/docs/api/temp-mail/get.md): The lease, the message count and the extensions left. The state a client draws around the list.
- [Extend the lease](https://nextmail.sh/docs/api/temp-mail/extend.md): Another hour on the expiry, up to the day a lease is capped at. No body.
- [Destroy an inbox](https://nextmail.sh/docs/api/temp-mail/destroy.md): Moves the mail the inbox shows to the bin now. The lease runs on.
- [List messages](https://nextmail.sh/docs/api/temp-mail/messages.md): What has arrived, newest first, metadata only. This is the call to poll.
- [Retrieve a message](https://nextmail.sh/docs/api/temp-mail/message.md): One message with its body. Retrieving it does not mark it seen.
- [Delete a message](https://nextmail.sh/docs/api/temp-mail/message-delete.md): One message, moved to the bin of the mailbox that runs the pool.
- [List attachments](https://nextmail.sh/docs/api/temp-mail/attachments.md): The parts on one message: names, types and sizes, and no bytes.
- [Your account](https://nextmail.sh/docs/api/account.md): The person behind the key or the app: the workspaces they can open, the email they get, their photo and username, the apps they connected, the invitations waiting for them, and the devices, passkeys and security log of their sign-in. An API key acts for the workspace owner, and an app for the person who connected it.
- [List your workspaces](https://nextmail.sh/docs/api/workspaces/list.md): Every workspace the person can open, the ones they own first, as the workspace switcher of the app lists them.
- [Create a workspace](https://nextmail.sh/docs/api/workspaces/create.md): A new workspace owned by the person, on the Free plan, which the app opens for them from then on.
- [Read the workspace the app opens](https://nextmail.sh/docs/api/workspaces/active.md): The workspace the app opens for the person when they sign in.
- [Choose the workspace the app opens](https://nextmail.sh/docs/api/workspaces/set-active.md): Switches the workspace the app opens for the person, as the workspace switcher does.
- [Delete the workspace](https://nextmail.sh/docs/api/workspaces/delete.md): Deletes the workspace the key or the app belongs to, with everything in it, and cancels its plan.
- [Read your notification settings](https://nextmail.sh/docs/api/account/notifications.md): Which kinds of email Nextmail sends the person, and the workspaces muted on their phone.
- [Turn a kind of email on or off](https://nextmail.sh/docs/api/account/email-notification.md): Stops or starts one kind of email Nextmail sends the person.
- [Mute a workspace on your phone](https://nextmail.sh/docs/api/account/push-notification.md): Stops or starts the phone notifications about the mail of one workspace.
- [Set your profile photo](https://nextmail.sh/docs/api/account/photo-set.md): Uploads the profile photo of the person, replacing any there was. The body is the image itself, not JSON, with its type in `Content-Type`: `image/png`, `image/jpeg`, `image/webp` or `image/gif`, up to 5 MB.
- [Remove your profile photo](https://nextmail.sh/docs/api/account/photo-remove.md): Removes the profile photo and deletes the stored image.
- [Read your username](https://nextmail.sh/docs/api/account/username.md): The username of the person and the free address it gives them.
- [Choose your username](https://nextmail.sh/docs/api/account/username-set.md): Sets the username of the person for good, and with it their free address.
- [Check a username](https://nextmail.sh/docs/api/account/username-check.md): Whether the person could choose a username, without choosing it.
- [List your connected apps](https://nextmail.sh/docs/api/account/connected-apps.md): Every app the person connected with OAuth, as Account, Connected apps lists them.
- [Remove a connected app](https://nextmail.sh/docs/api/account/connected-app-remove.md): Deletes every token the app holds and the access the person gave it.
- [List your invitations](https://nextmail.sh/docs/api/account/invitations.md): The invitations to join a workspace that are waiting for the person.
- [Accept an invitation](https://nextmail.sh/docs/api/account/invitation-accept.md): Joins the workspace with the role and the addresses the invitation gives.
- [Decline an invitation](https://nextmail.sh/docs/api/account/invitation-decline.md): Turns an invitation down, so its link stops working.
- [Reference](https://nextmail.sh/docs/api/reference.md): The spec, and every operation.
- [OpenAPI](https://nextmail.sh/docs/api/reference/openapi.md): The machine-readable reference.
- [Emails](https://nextmail.sh/docs/api/reference/emails.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Tracking](https://nextmail.sh/docs/api/reference/tracking.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Templates](https://nextmail.sh/docs/api/reference/templates.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Rules](https://nextmail.sh/docs/api/reference/rules.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Threads](https://nextmail.sh/docs/api/reference/threads.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Drafts](https://nextmail.sh/docs/api/reference/drafts.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Labels](https://nextmail.sh/docs/api/reference/labels.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Contacts](https://nextmail.sh/docs/api/reference/contacts.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Audiences](https://nextmail.sh/docs/api/reference/audiences.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Forms](https://nextmail.sh/docs/api/reference/forms.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Broadcasts](https://nextmail.sh/docs/api/reference/broadcasts.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Domains](https://nextmail.sh/docs/api/reference/domains.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Webhooks](https://nextmail.sh/docs/api/reference/webhooks.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Imports](https://nextmail.sh/docs/api/reference/imports.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Calendar](https://nextmail.sh/docs/api/reference/calendar.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Languages](https://nextmail.sh/docs/api/reference/languages.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Settings](https://nextmail.sh/docs/api/reference/settings.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Roles](https://nextmail.sh/docs/api/reference/roles.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Members](https://nextmail.sh/docs/api/reference/members.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Account](https://nextmail.sh/docs/api/reference/account.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Security](https://nextmail.sh/docs/api/reference/security.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Suppressions](https://nextmail.sh/docs/api/reference/suppressions.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Files](https://nextmail.sh/docs/api/reference/files.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [API keys](https://nextmail.sh/docs/api/reference/api-keys.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Temp mail](https://nextmail.sh/docs/api/reference/temp-mail.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Notes](https://nextmail.sh/docs/api/reference/notes.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Team inbox](https://nextmail.sh/docs/api/reference/team-inbox.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Senders](https://nextmail.sh/docs/api/reference/senders.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Analytics](https://nextmail.sh/docs/api/reference/analytics.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Subscriptions](https://nextmail.sh/docs/api/reference/subscriptions.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Tools](https://nextmail.sh/docs/api/reference/tools.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Sending](https://nextmail.sh/docs/api/reference/sending.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Support](https://nextmail.sh/docs/api/reference/support.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Encryption](https://nextmail.sh/docs/api/reference/encryption.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Chats](https://nextmail.sh/docs/api/reference/chats.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Exports](https://nextmail.sh/docs/api/reference/exports.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Workspaces](https://nextmail.sh/docs/api/reference/workspaces.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Your account](https://nextmail.sh/docs/api/reference/your-account.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Billing](https://nextmail.sh/docs/api/reference/billing.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Knowledge](https://nextmail.sh/docs/api/reference/knowledge.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Automations](https://nextmail.sh/docs/api/reference/automations.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Events](https://nextmail.sh/docs/api/reference/events.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Tasks](https://nextmail.sh/docs/api/reference/tasks.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Booking pages](https://nextmail.sh/docs/api/reference/booking-pages.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Connectors](https://nextmail.sh/docs/api/reference/connectors.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.
- [Connected mailboxes](https://nextmail.sh/docs/api/reference/connected-mailboxes.md): Every operation in this group: what it accepts, what it returns and the errors it can answer with.

## TypeScript

A typed TypeScript client over the API. One method for every endpoint.

- [SDK](https://nextmail.sh/docs/sdk.md): A typed TypeScript client for the Nextmail API. Zero dependencies, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/sdk/install.md): One package, no dependencies, every server runtime.
- [Configuration](https://nextmail.sh/docs/sdk/configuration.md): Three ways to build a client, every option, and what it refuses before a request is sent.
- [Errors](https://nextmail.sh/docs/sdk/errors.md): Every failure throws. Two classes, and a request id on every API error.
- [Retries and idempotency](https://nextmail.sh/docs/sdk/retries.md): What is retried, what is deliberately not, and why a retried send cannot duplicate.
- [Send an email](https://nextmail.sh/docs/sdk/emails/send.md): `emails.send`: one message, now or later.
- [Send a batch](https://nextmail.sh/docs/sdk/emails/batch.md): `emails.sendBatch`: up to 100 messages, results per item.
- [Schedule and cancel](https://nextmail.sh/docs/sdk/emails/schedule.md): `scheduledAt`, `emails.reschedule` and `emails.cancel`.
- [List and get](https://nextmail.sh/docs/sdk/emails/list.md): `emails.list`, `emails.listAll`, `emails.iterate`, `emails.get` and `emails.listEvents`.
- [Open and click tracking](https://nextmail.sh/docs/sdk/emails/tracking.md): `emails.getTracking` and the whole `tracking` resource.
- [Threads](https://nextmail.sh/docs/sdk/threads.md): `threads.list`, `listAll`, `iterate`, `get`, `update`, `trash`, `snooze`, `unsnooze` and `listAttachments`.
- [Drafts](https://nextmail.sh/docs/sdk/drafts.md): `drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` and `delete`.
- [Labels](https://nextmail.sh/docs/sdk/labels.md): `labels.list`, `listAll`, `iterate`, `listColors`, `get`, `create`, `update` and `delete`.
- [Contacts](https://nextmail.sh/docs/sdk/contacts.md): `contacts.list`, `get`, `create`, `save`, `update`, `setAudiences`, `delete`, `deleteMany`, `listPeople`, `setPhoto`, `removePhoto`, `block`, `unblock`, `listThreads` and `activity`.
- [Audiences](https://nextmail.sh/docs/sdk/audiences.md): `audiences.list`, `get`, `create`, `update`, `delete`, `empty`, `growth`, `listContacts`, `addContact`, `addContacts`, `importContacts`, `removeContact` and `removeContacts`.
- [Forms](https://nextmail.sh/docs/sdk/forms.md): `forms.list`, `get`, `create`, `update`, `delete`, `publish`, `pause`, `resume`, `duplicate`, `analytics`, `listStarters`, `getStarter`, `listSubmissions`, `getSubmission`, `deleteSubmission`, `deleteSubmissions`, `approveSubmission`, `resendConfirmation` and `subscribe`.
- [Broadcasts](https://nextmail.sh/docs/sdk/broadcasts.md): `broadcasts.preview`, `send`, `list`, `listAll`, `iterate`, `get`, `listRecipients`, `listAllRecipients`, `iterateRecipients`, `getRecipient`, `stats`, `analytics` and `cancel`.
- [Automations](https://nextmail.sh/docs/sdk/automations.md): `automations.list`, `get`, `create`, `update`, `publish`, `pause`, `resume`, `archive`, `duplicate`, `delete`, `sendTest`, `stats`, `analytics`, `listRuns`, `listVersions`, `restoreVersion`, `listStarters`, `listEnrollments`, `getEnrollment`, `enroll` and `exitEnrollment`, with `events.send`, `sendBatch` and `listNames`.
- [Tasks](https://nextmail.sh/docs/sdk/tasks.md): `tasks.list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`, `pause`, `resume` and `run`, with `listRuns`, `listAllRuns`, `iterateRuns`, `getRun`, `startRun` and `cancelRun` for runs, and `listApprovals`, `listAllApprovals`, `iterateApprovals`, `getApproval`, `approve` and `deny` for what runs ask.
- [Booking pages](https://nextmail.sh/docs/sdk/bookings.md): `bookings.listPages`, `getPage`, `createPage`, `updatePage`, `deletePage` and `listTimes` for the pages, and `list`, `listAll`, `iterate`, `get`, `approve`, `decline`, `cancel` and `resendEmail` for the meetings guests book on them.
- [Connectors](https://nextmail.sh/docs/sdk/connectors.md): `connectors.listApps`, `listAllApps`, `iterateApps`, `getApp` and `listCategories` for the apps that can be connected, `list`, `get`, `connect`, `update`, `disconnect` and `reconnect` for the connectors, `listActions`, `getAction` and `runAction` for what they can do, and `listCalls`, `listAllCalls` and `iterateCalls` for what was done.
- [Domains](https://nextmail.sh/docs/sdk/domains.md): `domains.list`, `listAll`, `iterate`, `get` and `update`.
- [Roles](https://nextmail.sh/docs/sdk/roles.md): `roles.list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete` and `listPermissions`.
- [Members](https://nextmail.sh/docs/sdk/members.md): `members.list`, `listAll`, `iterate`, `get`, `add`, `update`, `remove`, `grantAddress`, `revokeAddress`, and the invitation methods beside them.
- [API keys](https://nextmail.sh/docs/sdk/keys.md): `keys.list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`, `rotate` and `revoke`, and the request log and activity readers.
- [Suppressions](https://nextmail.sh/docs/sdk/suppressions.md): `suppressions.list`, `listAll`, `iterate`, `get`, `add` and `remove`.
- [Files](https://nextmail.sh/docs/sdk/files.md): `files.list`, `listAll`, `iterate`, `get`, `download`, `listLinks`, `listAllLinks`, `iterateLinks`, `createLink`, `revokeLink`, `stats`, `upload`, `delete` and `deleteMany`.
- [Endpoints](https://nextmail.sh/docs/sdk/webhooks/endpoints.md): `webhooks.list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`, `rotateSecret`, `test`, `getDelivery` and `replayDelivery`, and the delivery and activity logs.
- [Verifying a delivery](https://nextmail.sh/docs/sdk/webhooks/verify.md): `verifyWebhookSignature`: constant-time, with a replay window, and the parsed event back.
- [Every method](https://nextmail.sh/docs/sdk/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Types and helpers](https://nextmail.sh/docs/sdk/reference/types.md): What else the package exports.
- [Changelog](https://nextmail.sh/docs/sdk/changelog.md): Every release of the package, newest first.
- [Other languages](https://nextmail.sh/docs/sdk/reference/other-languages.md): Python, Ruby, PHP, Go, Java and C# have packages of their own. Everything else generates from the spec.
- [nextmail.me](https://nextmail.sh/docs/sdk/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.security](https://nextmail.sh/docs/sdk/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.keys](https://nextmail.sh/docs/sdk/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.addresses](https://nextmail.sh/docs/sdk/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.languages](https://nextmail.sh/docs/sdk/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.emails](https://nextmail.sh/docs/sdk/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.templates](https://nextmail.sh/docs/sdk/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tracking](https://nextmail.sh/docs/sdk/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.threads](https://nextmail.sh/docs/sdk/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.followUps](https://nextmail.sh/docs/sdk/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.drafts](https://nextmail.sh/docs/sdk/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.labels](https://nextmail.sh/docs/sdk/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.contacts](https://nextmail.sh/docs/sdk/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.audiences](https://nextmail.sh/docs/sdk/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.segments](https://nextmail.sh/docs/sdk/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.forms](https://nextmail.sh/docs/sdk/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.automations](https://nextmail.sh/docs/sdk/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.events](https://nextmail.sh/docs/sdk/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.broadcasts](https://nextmail.sh/docs/sdk/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.domains](https://nextmail.sh/docs/sdk/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.appHost](https://nextmail.sh/docs/sdk/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.branding](https://nextmail.sh/docs/sdk/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.rules](https://nextmail.sh/docs/sdk/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.webhooks](https://nextmail.sh/docs/sdk/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.imports](https://nextmail.sh/docs/sdk/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.providerImports](https://nextmail.sh/docs/sdk/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.calendar](https://nextmail.sh/docs/sdk/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.settings](https://nextmail.sh/docs/sdk/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.outOfOffice](https://nextmail.sh/docs/sdk/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.roles](https://nextmail.sh/docs/sdk/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.members](https://nextmail.sh/docs/sdk/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.suppressions](https://nextmail.sh/docs/sdk/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.sending](https://nextmail.sh/docs/sdk/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.files](https://nextmail.sh/docs/sdk/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.knowledge](https://nextmail.sh/docs/sdk/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tempMail](https://nextmail.sh/docs/sdk/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tools](https://nextmail.sh/docs/sdk/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.support](https://nextmail.sh/docs/sdk/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.encryption](https://nextmail.sh/docs/sdk/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.senders](https://nextmail.sh/docs/sdk/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.chats](https://nextmail.sh/docs/sdk/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.analytics](https://nextmail.sh/docs/sdk/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.subscriptions](https://nextmail.sh/docs/sdk/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.exports](https://nextmail.sh/docs/sdk/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.dnsConnections](https://nextmail.sh/docs/sdk/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.billing](https://nextmail.sh/docs/sdk/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.workspaces](https://nextmail.sh/docs/sdk/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.account](https://nextmail.sh/docs/sdk/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.signatures](https://nextmail.sh/docs/sdk/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tasks](https://nextmail.sh/docs/sdk/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.bookings](https://nextmail.sh/docs/sdk/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.connectors](https://nextmail.sh/docs/sdk/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.connectedMailboxes](https://nextmail.sh/docs/sdk/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## Python

The `nextmail` package for Python 3.10 and up. Sync and async clients, one method for every endpoint.

- [Python SDK](https://nextmail.sh/docs/python.md): The official Python client for the Nextmail API. Sync and async, typed throughout, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/python/install.md): One package, three dependencies, Python 3.10 and up.
- [Configuration](https://nextmail.sh/docs/python/configuration.md): Three ways to build a client, every option, and what it refuses before a request is sent.
- [Errors](https://nextmail.sh/docs/python/errors.md): Every failure raises. Two classes, and a request id on every API error.
- [Retries and idempotency](https://nextmail.sh/docs/python/retries.md): What is retried, what is deliberately not, and why a retried send cannot duplicate.
- [Async](https://nextmail.sh/docs/python/async.md): `AsyncNextmail`: every method of `Nextmail`, awaited, on asyncio or trio.
- [Pagination](https://nextmail.sh/docs/python/pagination.md): `list` for one page, `list_all` for every page, and `iterate` for one item at a time.
- [Frameworks](https://nextmail.sh/docs/python/frameworks.md): Django, Flask and FastAPI, a webhook endpoint, and background jobs that never send twice.
- [Send an email](https://nextmail.sh/docs/python/emails/send.md): `emails.send`: one message, now or later.
- [Send a batch](https://nextmail.sh/docs/python/emails/batch.md): `emails.send_batch`: up to 100 messages, results per item.
- [Schedule and cancel](https://nextmail.sh/docs/python/emails/schedule.md): `scheduledAt`, `emails.reschedule` and `emails.cancel`.
- [List and get](https://nextmail.sh/docs/python/emails/list.md): `emails.list`, `emails.list_all`, `emails.iterate`, `emails.get` and `emails.list_events`.
- [Open and click tracking](https://nextmail.sh/docs/python/emails/tracking.md): `emails.get_tracking` and the whole `tracking` resource.
- [Threads](https://nextmail.sh/docs/python/threads.md): `threads.list`, `list_all`, `iterate`, `get`, `update`, `trash`, `snooze`, `unsnooze` and `list_attachments`.
- [Drafts](https://nextmail.sh/docs/python/drafts.md): `drafts.list`, `list_all`, `iterate`, `get`, `create`, `update` and `delete`.
- [Labels](https://nextmail.sh/docs/python/labels.md): `labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` and `delete`.
- [Contacts](https://nextmail.sh/docs/python/contacts.md): `contacts.list`, `get`, `create`, `save`, `update`, `set_audiences`, `delete`, `delete_many`, `list_people`, `set_photo`, `remove_photo`, `block`, `unblock`, `list_threads` and `activity`.
- [Audiences](https://nextmail.sh/docs/python/audiences.md): `audiences.list`, `get`, `create`, `update`, `delete`, `empty`, `growth`, `list_contacts`, `add_contact`, `add_contacts`, `import_contacts`, `remove_contact` and `remove_contacts`.
- [Forms](https://nextmail.sh/docs/python/forms.md): `forms.list`, `get`, `create`, `update`, `delete`, `publish`, `pause`, `resume`, `duplicate`, `analytics`, `list_starters`, `get_starter`, `list_submissions`, `get_submission`, `delete_submission`, `delete_submissions`, `approve_submission`, `resend_confirmation` and `subscribe`.
- [Broadcasts](https://nextmail.sh/docs/python/broadcasts.md): `broadcasts.preview`, `send`, `list`, `list_all`, `iterate`, `get`, `list_recipients`, `list_all_recipients`, `iterate_recipients`, `get_recipient`, `stats`, `analytics` and `cancel`.
- [Automations](https://nextmail.sh/docs/python/automations.md): `automations.list`, `get`, `create`, `update`, `publish`, `pause`, `resume`, `archive`, `duplicate`, `delete`, `send_test`, `stats`, `list_versions`, `restore_version`, `list_starters`, `list_enrollments`, `get_enrollment`, `enroll` and `exit_enrollment`, with `events.send`, `send_batch` and `list_names`.
- [Tasks](https://nextmail.sh/docs/python/tasks.md): `tasks.list`, `get`, `create`, `update`, `delete`, `pause`, `resume`, `run`, `list_runs`, `get_run`, `start_run`, `cancel_run`, `list_approvals`, `get_approval`, `approve` and `deny`.
- [Domains](https://nextmail.sh/docs/python/domains.md): `domains.list`, `list_all`, `iterate`, `get` and `update`.
- [Roles](https://nextmail.sh/docs/python/roles.md): `roles.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete` and `list_permissions`.
- [Members](https://nextmail.sh/docs/python/members.md): `members.list`, `list_all`, `iterate`, `get`, `add`, `update`, `remove`, `grant_address`, `revoke_address`, and the invitation methods beside them.
- [API keys](https://nextmail.sh/docs/python/keys.md): `keys.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete`, `rotate` and `revoke`, and the request log and activity readers.
- [Suppressions](https://nextmail.sh/docs/python/suppressions.md): `suppressions.list`, `list_all`, `iterate`, `get`, `add` and `remove`.
- [Files](https://nextmail.sh/docs/python/files.md): `files.list`, `list_all`, `iterate`, `get`, `download`, `list_links`, `list_all_links`, `iterate_links`, `create_link`, `revoke_link`, `stats`, `upload`, `delete` and `delete_many`.
- [Endpoints](https://nextmail.sh/docs/python/webhooks/endpoints.md): `webhooks.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete`, `rotate_secret`, `test`, `get_delivery` and `replay_delivery`, and the delivery and activity logs.
- [Verifying a delivery](https://nextmail.sh/docs/python/webhooks/verify.md): `verify_webhook_signature`: constant-time, with a replay window, and the parsed event back.
- [Every method](https://nextmail.sh/docs/python/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Types and helpers](https://nextmail.sh/docs/python/reference/types.md): What else the package exports.
- [Changelog](https://nextmail.sh/docs/python/changelog.md): Every release of the package, newest first.
- [nextmail.me](https://nextmail.sh/docs/python/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.security](https://nextmail.sh/docs/python/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.keys](https://nextmail.sh/docs/python/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.addresses](https://nextmail.sh/docs/python/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.languages](https://nextmail.sh/docs/python/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.emails](https://nextmail.sh/docs/python/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.templates](https://nextmail.sh/docs/python/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tracking](https://nextmail.sh/docs/python/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.threads](https://nextmail.sh/docs/python/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.follow_ups](https://nextmail.sh/docs/python/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.drafts](https://nextmail.sh/docs/python/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.labels](https://nextmail.sh/docs/python/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.contacts](https://nextmail.sh/docs/python/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.audiences](https://nextmail.sh/docs/python/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.segments](https://nextmail.sh/docs/python/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.forms](https://nextmail.sh/docs/python/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.automations](https://nextmail.sh/docs/python/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.events](https://nextmail.sh/docs/python/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.broadcasts](https://nextmail.sh/docs/python/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.domains](https://nextmail.sh/docs/python/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.app_host](https://nextmail.sh/docs/python/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.branding](https://nextmail.sh/docs/python/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.rules](https://nextmail.sh/docs/python/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.webhooks](https://nextmail.sh/docs/python/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.imports](https://nextmail.sh/docs/python/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.provider_imports](https://nextmail.sh/docs/python/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.calendar](https://nextmail.sh/docs/python/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.settings](https://nextmail.sh/docs/python/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.out_of_office](https://nextmail.sh/docs/python/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.roles](https://nextmail.sh/docs/python/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.members](https://nextmail.sh/docs/python/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.suppressions](https://nextmail.sh/docs/python/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.sending](https://nextmail.sh/docs/python/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.files](https://nextmail.sh/docs/python/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.knowledge](https://nextmail.sh/docs/python/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.temp_mail](https://nextmail.sh/docs/python/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tools](https://nextmail.sh/docs/python/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.support](https://nextmail.sh/docs/python/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.encryption](https://nextmail.sh/docs/python/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.senders](https://nextmail.sh/docs/python/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.chats](https://nextmail.sh/docs/python/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.analytics](https://nextmail.sh/docs/python/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.subscriptions](https://nextmail.sh/docs/python/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.exports](https://nextmail.sh/docs/python/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.dns_connections](https://nextmail.sh/docs/python/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.billing](https://nextmail.sh/docs/python/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.workspaces](https://nextmail.sh/docs/python/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.account](https://nextmail.sh/docs/python/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.signatures](https://nextmail.sh/docs/python/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.tasks](https://nextmail.sh/docs/python/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.bookings](https://nextmail.sh/docs/python/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.connectors](https://nextmail.sh/docs/python/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [nextmail.connected_mailboxes](https://nextmail.sh/docs/python/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## Ruby

The `nextmail` gem for Ruby 3.2 and up. One method for every endpoint, with keyword arguments.

- [Ruby gem](https://nextmail.sh/docs/ruby.md): The official Ruby client for the Nextmail API. No runtime dependencies, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/ruby/install.md): One gem, no runtime dependencies, Ruby 3.2 and up.
- [Configuration](https://nextmail.sh/docs/ruby/configuration.md): Three ways to build a client, every option, and what it refuses before a request is sent.
- [Errors](https://nextmail.sh/docs/ruby/errors.md): Every failure raises. One class for a refusal, one for no answer, and a request id on every API error.
- [Retries and idempotency](https://nextmail.sh/docs/ruby/retries.md): What is retried, what is deliberately not, and why a retried send cannot duplicate.
- [Pagination](https://nextmail.sh/docs/ruby/pagination.md): One page, every page, or one item at a time, on every list that pages.
- [Rails and Rack](https://nextmail.sh/docs/ruby/rails.md): An initializer, a job that cannot send twice, a webhook controller, and tests that never reach the network.
- [Send an email](https://nextmail.sh/docs/ruby/emails/send.md): `emails.send`: one message, now or later.
- [Send a batch](https://nextmail.sh/docs/ruby/emails/batch.md): `emails.send_batch`: up to 100 messages, results per item.
- [Schedule and cancel](https://nextmail.sh/docs/ruby/emails/schedule.md): `scheduledAt`, `emails.reschedule`, `emails.update` and `emails.cancel`.
- [List and get](https://nextmail.sh/docs/ruby/emails/list.md): `emails.list`, `emails.list_all`, `emails.iterate`, `emails.get` and `emails.list_events`.
- [Open and click tracking](https://nextmail.sh/docs/ruby/emails/tracking.md): `emails.get_tracking` and the whole `tracking` namespace.
- [Threads](https://nextmail.sh/docs/ruby/threads.md): `threads.list`, `list_all`, `iterate`, `get`, `update`, `trash`, `snooze`, `unsnooze` and `list_attachments`.
- [Drafts](https://nextmail.sh/docs/ruby/drafts.md): `drafts.list`, `list_all`, `iterate`, `get`, `create`, `update` and `delete`.
- [Labels](https://nextmail.sh/docs/ruby/labels.md): `labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` and `delete`.
- [Contacts](https://nextmail.sh/docs/ruby/contacts.md): `contacts.list`, `get`, `create`, `save`, `update`, `set_audiences`, `delete`, `delete_many`, `list_people`, `set_photo`, `remove_photo`, `block`, `unblock`, `list_threads` and `activity`.
- [Audiences](https://nextmail.sh/docs/ruby/audiences.md): `audiences.list`, `get`, `create`, `update`, `delete`, `empty`, `growth`, `list_contacts`, `add_contact`, `add_contacts`, `import_contacts`, `remove_contact` and `remove_contacts`.
- [Forms](https://nextmail.sh/docs/ruby/forms.md): `forms.list`, `get`, `create`, `update`, `delete`, `publish`, `pause`, `resume`, `duplicate`, `analytics`, `list_starters`, `get_starter`, `list_submissions`, `get_submission`, `delete_submission`, `delete_submissions`, `approve_submission`, `resend_confirmation` and `subscribe`.
- [Broadcasts](https://nextmail.sh/docs/ruby/broadcasts.md): `broadcasts.preview`, `send`, `list`, `list_all`, `iterate`, `get`, `list_recipients`, `list_all_recipients`, `iterate_recipients`, `get_recipient`, `stats`, `analytics` and `cancel`.
- [Automations](https://nextmail.sh/docs/ruby/automations.md): `automations.list`, `get`, `create`, `update`, `publish`, `pause`, `resume`, `archive`, `duplicate`, `delete`, `send_test`, `stats`, `list_versions`, `restore_version`, `list_starters`, `list_enrollments`, `get_enrollment`, `enroll` and `exit_enrollment`, with `events.send`, `send_batch` and `list_names`.
- [Tasks](https://nextmail.sh/docs/ruby/tasks.md): `tasks.list`, `get`, `create`, `update`, `delete`, `pause`, `resume`, `run`, `list_runs`, `get_run`, `start_run`, `cancel_run`, `list_approvals`, `get_approval`, `approve` and `deny`.
- [Domains](https://nextmail.sh/docs/ruby/domains.md): `domains.list`, `list_all`, `iterate`, `get` and `update`.
- [Roles](https://nextmail.sh/docs/ruby/roles.md): `roles.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete` and `list_permissions`.
- [Members](https://nextmail.sh/docs/ruby/members.md): `members.list`, `list_all`, `iterate`, `get`, `add`, `update`, `remove`, `grant_address`, `revoke_address`, and the invitation methods beside them.
- [API keys](https://nextmail.sh/docs/ruby/keys.md): `keys.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete`, `rotate` and `revoke`, and the request log and activity readers.
- [Suppressions](https://nextmail.sh/docs/ruby/suppressions.md): `suppressions.list`, `list_all`, `iterate`, `get`, `add` and `remove`.
- [Files](https://nextmail.sh/docs/ruby/files.md): `files.list`, `list_all`, `iterate`, `get`, `download`, `list_links`, `list_all_links`, `iterate_links`, `create_link`, `revoke_link`, `stats`, `upload`, `delete` and `delete_many`.
- [Endpoints](https://nextmail.sh/docs/ruby/webhooks/endpoints.md): `webhooks.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete`, `rotate_secret`, `test`, `get_delivery` and `replay_delivery`, and the delivery and activity logs.
- [Verifying a delivery](https://nextmail.sh/docs/ruby/webhooks/verify.md): `Nextmail.verify_webhook_signature`: constant-time, with a replay window, and the parsed event back.
- [Every method](https://nextmail.sh/docs/ruby/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Helpers and constants](https://nextmail.sh/docs/ruby/reference/helpers.md): What else the gem defines besides the client.
- [Changelog](https://nextmail.sh/docs/ruby/changelog.md): Every release of the gem, newest first.
- [client.me](https://nextmail.sh/docs/ruby/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.security](https://nextmail.sh/docs/ruby/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.keys](https://nextmail.sh/docs/ruby/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.addresses](https://nextmail.sh/docs/ruby/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.languages](https://nextmail.sh/docs/ruby/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.emails](https://nextmail.sh/docs/ruby/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.templates](https://nextmail.sh/docs/ruby/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tracking](https://nextmail.sh/docs/ruby/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.threads](https://nextmail.sh/docs/ruby/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.follow_ups](https://nextmail.sh/docs/ruby/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.drafts](https://nextmail.sh/docs/ruby/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.labels](https://nextmail.sh/docs/ruby/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.contacts](https://nextmail.sh/docs/ruby/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.audiences](https://nextmail.sh/docs/ruby/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.segments](https://nextmail.sh/docs/ruby/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.forms](https://nextmail.sh/docs/ruby/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.automations](https://nextmail.sh/docs/ruby/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.events](https://nextmail.sh/docs/ruby/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.broadcasts](https://nextmail.sh/docs/ruby/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.domains](https://nextmail.sh/docs/ruby/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.app_host](https://nextmail.sh/docs/ruby/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.branding](https://nextmail.sh/docs/ruby/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.rules](https://nextmail.sh/docs/ruby/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.webhooks](https://nextmail.sh/docs/ruby/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.imports](https://nextmail.sh/docs/ruby/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.provider_imports](https://nextmail.sh/docs/ruby/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.calendar](https://nextmail.sh/docs/ruby/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.settings](https://nextmail.sh/docs/ruby/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.out_of_office](https://nextmail.sh/docs/ruby/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.roles](https://nextmail.sh/docs/ruby/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.members](https://nextmail.sh/docs/ruby/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.suppressions](https://nextmail.sh/docs/ruby/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.sending](https://nextmail.sh/docs/ruby/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.files](https://nextmail.sh/docs/ruby/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.knowledge](https://nextmail.sh/docs/ruby/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.temp_mail](https://nextmail.sh/docs/ruby/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tools](https://nextmail.sh/docs/ruby/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.support](https://nextmail.sh/docs/ruby/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.encryption](https://nextmail.sh/docs/ruby/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.senders](https://nextmail.sh/docs/ruby/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.chats](https://nextmail.sh/docs/ruby/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.analytics](https://nextmail.sh/docs/ruby/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.subscriptions](https://nextmail.sh/docs/ruby/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.exports](https://nextmail.sh/docs/ruby/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.dns_connections](https://nextmail.sh/docs/ruby/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.billing](https://nextmail.sh/docs/ruby/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.workspaces](https://nextmail.sh/docs/ruby/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.account](https://nextmail.sh/docs/ruby/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.signatures](https://nextmail.sh/docs/ruby/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tasks](https://nextmail.sh/docs/ruby/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.bookings](https://nextmail.sh/docs/ruby/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.connectors](https://nextmail.sh/docs/ruby/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.connected_mailboxes](https://nextmail.sh/docs/ruby/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## PHP

The `nextmail/sdk` Composer package for PHP 8.2 and up. One method for every endpoint, with named arguments.

- [PHP SDK](https://nextmail.sh/docs/php.md): The official PHP client for the Nextmail API. One Composer package with no runtime dependencies beyond cURL, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/php/install.md): One Composer package, PHP 8.2 and up, with the curl and json extensions.
- [Configuration](https://nextmail.sh/docs/php/configuration.md): How to build a client, every option, and what it refuses before a request is sent.
- [Errors](https://nextmail.sh/docs/php/errors.md): Every failure throws. One class for a refusal, one for no answer, and a request id on every API error.
- [Retries and idempotency](https://nextmail.sh/docs/php/retries.md): What is retried, what is deliberately not, and why a retried send cannot duplicate.
- [Pagination](https://nextmail.sh/docs/php/pagination.md): One page, every page, or one item at a time, on every list that pages.
- [Laravel and Symfony](https://nextmail.sh/docs/php/frameworks.md): One client in the container, a job that cannot send twice, a webhook controller, and tests that never reach the network.
- [HTTP clients](https://nextmail.sh/docs/php/http-clients.md): cURL by default, any PSR-18 client when you would rather use your own, and a fake for tests.
- [Send an email](https://nextmail.sh/docs/php/emails/send.md): `emails->send`: one message, now or later.
- [Send a batch](https://nextmail.sh/docs/php/emails/batch.md): `emails->sendBatch`: up to 100 messages, results per item.
- [Schedule and cancel](https://nextmail.sh/docs/php/emails/schedule.md): `scheduledAt`, `emails->reschedule`, `emails->update` and `emails->cancel`.
- [List and get](https://nextmail.sh/docs/php/emails/list.md): `emails->list`, `emails->listAll`, `emails->iterate`, `emails->get` and `emails->listEvents`.
- [Open and click tracking](https://nextmail.sh/docs/php/emails/tracking.md): `emails->getTracking` and the whole `tracking` namespace.
- [Threads](https://nextmail.sh/docs/php/threads.md): `threads->list`, `listAll`, `iterate`, `get`, `update`, `trash`, `snooze`, `unsnooze` and `listAttachments`.
- [Drafts](https://nextmail.sh/docs/php/drafts.md): `drafts->list`, `listAll`, `iterate`, `get`, `create`, `update` and `delete`.
- [Labels](https://nextmail.sh/docs/php/labels.md): `labels->list`, `listAll`, `iterate`, `listColors`, `get`, `create`, `update` and `delete`.
- [Contacts](https://nextmail.sh/docs/php/contacts.md): `contacts->list`, `get`, `create`, `save`, `update`, `setAudiences`, `delete`, `deleteMany`, `listPeople`, `setPhoto`, `removePhoto`, `block`, `unblock`, `listThreads` and `activity`.
- [Audiences](https://nextmail.sh/docs/php/audiences.md): `audiences->list`, `get`, `create`, `update`, `delete`, `empty`, `growth`, `listContacts`, `addContact`, `addContacts`, `importContacts`, `removeContact` and `removeContacts`.
- [Forms](https://nextmail.sh/docs/php/forms.md): `forms->list`, `listAll`, `iterate`, `get`, `create`, `design`, `redesign`, `update`, `delete`, `publish`, `pause`, `resume`, `duplicate`, `analytics`, `listStarters`, `getStarter`, `listSubmissions`, `getSubmission`, `deleteSubmission`, `deleteSubmissions`, `approveSubmission`, `resendConfirmation` and `subscribe`.
- [Broadcasts](https://nextmail.sh/docs/php/broadcasts.md): `broadcasts->preview`, `send`, `list`, `listAll`, `iterate`, `get`, `listRecipients`, `listAllRecipients`, `iterateRecipients`, `getRecipient`, `stats`, `analytics` and `cancel`.
- [Automations](https://nextmail.sh/docs/php/automations.md): `automations->list`, `get`, `create`, `update`, `publish`, `pause`, `resume`, `archive`, `duplicate`, `delete`, `sendTest`, `stats`, `listVersions`, `restoreVersion`, `listStarters`, `listEnrollments`, `getEnrollment`, `enroll` and `exitEnrollment`, with `events->send`, `sendBatch` and `listNames`.
- [Tasks](https://nextmail.sh/docs/php/tasks.md): `tasks->list`, `get`, `create`, `update`, `delete`, `pause`, `resume`, `run`, `listRuns`, `getRun`, `startRun`, `cancelRun`, `listApprovals`, `getApproval`, `approve` and `deny`.
- [Domains](https://nextmail.sh/docs/php/domains.md): `domains->list`, `listAll`, `iterate`, `get` and `update`.
- [Roles](https://nextmail.sh/docs/php/roles.md): `roles->list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete` and `listPermissions`.
- [Members](https://nextmail.sh/docs/php/members.md): `members->list`, `listAll`, `iterate`, `get`, `add`, `update`, `remove`, `grantAddress`, `revokeAddress`, `grantDomain`, `revokeDomain` and the invitation methods beside them.
- [API keys](https://nextmail.sh/docs/php/keys.md): `keys->list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`, `rotate` and `revoke`, and the request log, activity and stats readers.
- [Suppressions](https://nextmail.sh/docs/php/suppressions.md): `suppressions->list`, `listAll`, `iterate`, `get`, `add` and `remove`.
- [Files](https://nextmail.sh/docs/php/files.md): `files->list`, `listAll`, `iterate`, `get`, `download`, `listLinks`, `listAllLinks`, `iterateLinks`, `createLink`, `revokeLink`, `revokeAllLinks`, `stats`, `upload`, `delete` and `deleteMany`.
- [Endpoints](https://nextmail.sh/docs/php/webhooks/endpoints.md): `webhooks->list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`, `rotateSecret`, `test`, `getDelivery` and `replayDelivery`, and the delivery and activity logs.
- [Verifying a delivery](https://nextmail.sh/docs/php/webhooks/verify.md): `Nextmail::verifyWebhookSignature`: constant-time, with a replay window, and the parsed event back.
- [Every method](https://nextmail.sh/docs/php/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Helpers and constants](https://nextmail.sh/docs/php/reference/helpers.md): What else the package defines besides the client’s methods.
- [Changelog](https://nextmail.sh/docs/php/changelog.md): Every release of the package, newest first.
- [$client->me](https://nextmail.sh/docs/php/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->security](https://nextmail.sh/docs/php/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->keys](https://nextmail.sh/docs/php/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->addresses](https://nextmail.sh/docs/php/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->languages](https://nextmail.sh/docs/php/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->emails](https://nextmail.sh/docs/php/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->templates](https://nextmail.sh/docs/php/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->tracking](https://nextmail.sh/docs/php/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->threads](https://nextmail.sh/docs/php/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->followUps](https://nextmail.sh/docs/php/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->drafts](https://nextmail.sh/docs/php/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->labels](https://nextmail.sh/docs/php/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->contacts](https://nextmail.sh/docs/php/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->audiences](https://nextmail.sh/docs/php/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->segments](https://nextmail.sh/docs/php/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->forms](https://nextmail.sh/docs/php/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->automations](https://nextmail.sh/docs/php/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->events](https://nextmail.sh/docs/php/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->broadcasts](https://nextmail.sh/docs/php/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->domains](https://nextmail.sh/docs/php/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->appHost](https://nextmail.sh/docs/php/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->branding](https://nextmail.sh/docs/php/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->rules](https://nextmail.sh/docs/php/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->webhooks](https://nextmail.sh/docs/php/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->imports](https://nextmail.sh/docs/php/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->providerImports](https://nextmail.sh/docs/php/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->calendar](https://nextmail.sh/docs/php/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->settings](https://nextmail.sh/docs/php/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->outOfOffice](https://nextmail.sh/docs/php/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->roles](https://nextmail.sh/docs/php/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->members](https://nextmail.sh/docs/php/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->suppressions](https://nextmail.sh/docs/php/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->sending](https://nextmail.sh/docs/php/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->files](https://nextmail.sh/docs/php/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->knowledge](https://nextmail.sh/docs/php/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->tempMail](https://nextmail.sh/docs/php/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->tools](https://nextmail.sh/docs/php/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->support](https://nextmail.sh/docs/php/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->encryption](https://nextmail.sh/docs/php/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->senders](https://nextmail.sh/docs/php/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->chats](https://nextmail.sh/docs/php/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->analytics](https://nextmail.sh/docs/php/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->subscriptions](https://nextmail.sh/docs/php/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->exports](https://nextmail.sh/docs/php/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->dnsConnections](https://nextmail.sh/docs/php/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->billing](https://nextmail.sh/docs/php/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->workspaces](https://nextmail.sh/docs/php/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->account](https://nextmail.sh/docs/php/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->signatures](https://nextmail.sh/docs/php/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->tasks](https://nextmail.sh/docs/php/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->bookings](https://nextmail.sh/docs/php/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->connectors](https://nextmail.sh/docs/php/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [$client->connectedMailboxes](https://nextmail.sh/docs/php/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## Go

The `nextmail-go` module for Go 1.24 and up. One method for every endpoint, with options as functions.

- [Go SDK](https://nextmail.sh/docs/go.md): The official Go client for the Nextmail API. One module with nothing outside the standard library, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/go/install.md): One module, Go 1.24 and up, and nothing outside the standard library.
- [Configuration](https://nextmail.sh/docs/go/configuration.md): Every option of the client, what it reads from the environment, and what it refuses.
- [Errors and retries](https://nextmail.sh/docs/go/errors.md): One error type for every failure, a sentinel for every kind, and retries that cannot send twice.
- [Pagination](https://nextmail.sh/docs/go/pagination.md): One page, every page, or one item at a time.
- [Send an email](https://nextmail.sh/docs/go/emails/send.md): One message now or later, with attachments, or a hundred in one request.
- [Verify webhooks](https://nextmail.sh/docs/go/webhooks/verify.md): Check the signature of a delivery before you trust what it says.
- [Every method](https://nextmail.sh/docs/go/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Helpers and constants](https://nextmail.sh/docs/go/reference/helpers.md): What else the package defines besides the client’s methods.
- [Changelog](https://nextmail.sh/docs/go/changelog.md): Every release of the package, newest first.
- [client.Me](https://nextmail.sh/docs/go/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Security](https://nextmail.sh/docs/go/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Keys](https://nextmail.sh/docs/go/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Addresses](https://nextmail.sh/docs/go/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Languages](https://nextmail.sh/docs/go/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Emails](https://nextmail.sh/docs/go/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Templates](https://nextmail.sh/docs/go/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Tracking](https://nextmail.sh/docs/go/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Threads](https://nextmail.sh/docs/go/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.FollowUps](https://nextmail.sh/docs/go/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Drafts](https://nextmail.sh/docs/go/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Labels](https://nextmail.sh/docs/go/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Contacts](https://nextmail.sh/docs/go/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Audiences](https://nextmail.sh/docs/go/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Segments](https://nextmail.sh/docs/go/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Forms](https://nextmail.sh/docs/go/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Automations](https://nextmail.sh/docs/go/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Events](https://nextmail.sh/docs/go/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Broadcasts](https://nextmail.sh/docs/go/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Domains](https://nextmail.sh/docs/go/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.AppHost](https://nextmail.sh/docs/go/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Branding](https://nextmail.sh/docs/go/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Rules](https://nextmail.sh/docs/go/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Webhooks](https://nextmail.sh/docs/go/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Imports](https://nextmail.sh/docs/go/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.ProviderImports](https://nextmail.sh/docs/go/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Calendar](https://nextmail.sh/docs/go/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Settings](https://nextmail.sh/docs/go/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.OutOfOffice](https://nextmail.sh/docs/go/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Roles](https://nextmail.sh/docs/go/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Members](https://nextmail.sh/docs/go/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Suppressions](https://nextmail.sh/docs/go/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Sending](https://nextmail.sh/docs/go/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Files](https://nextmail.sh/docs/go/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Knowledge](https://nextmail.sh/docs/go/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.TempMail](https://nextmail.sh/docs/go/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Tools](https://nextmail.sh/docs/go/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Support](https://nextmail.sh/docs/go/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Encryption](https://nextmail.sh/docs/go/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Senders](https://nextmail.sh/docs/go/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Chats](https://nextmail.sh/docs/go/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Analytics](https://nextmail.sh/docs/go/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Subscriptions](https://nextmail.sh/docs/go/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Exports](https://nextmail.sh/docs/go/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.DNSConnections](https://nextmail.sh/docs/go/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Billing](https://nextmail.sh/docs/go/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Workspaces](https://nextmail.sh/docs/go/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Account](https://nextmail.sh/docs/go/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Signatures](https://nextmail.sh/docs/go/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Tasks](https://nextmail.sh/docs/go/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Bookings](https://nextmail.sh/docs/go/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Connectors](https://nextmail.sh/docs/go/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.ConnectedMailboxes](https://nextmail.sh/docs/go/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## Java

The `sh.nextmail:nextmail` artifact for Java 17 and up. One method for every endpoint, with no dependencies.

- [Java SDK](https://nextmail.sh/docs/java.md): The official Java client for the Nextmail API. One artifact with no dependencies, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/java/install.md): One artifact on Maven Central, Java 17 and up, with no dependencies.
- [Configuration](https://nextmail.sh/docs/java/configuration.md): Every option of the client, what it reads from the environment, and what it refuses.
- [Errors and retries](https://nextmail.sh/docs/java/errors.md): An exception class for every kind of refusal, and retries that cannot send twice.
- [Pagination](https://nextmail.sh/docs/java/pagination.md): One page, every page, or one item at a time.
- [Send an email](https://nextmail.sh/docs/java/emails/send.md): One message now or later, with attachments, or a hundred in one request.
- [Verify webhooks](https://nextmail.sh/docs/java/webhooks/verify.md): Check the signature of a delivery before you trust what it says.
- [Every method](https://nextmail.sh/docs/java/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Helpers and constants](https://nextmail.sh/docs/java/reference/helpers.md): What else the package defines besides the client’s methods.
- [Changelog](https://nextmail.sh/docs/java/changelog.md): Every release of the package, newest first.
- [client.me()](https://nextmail.sh/docs/java/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.security()](https://nextmail.sh/docs/java/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.keys()](https://nextmail.sh/docs/java/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.addresses()](https://nextmail.sh/docs/java/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.languages()](https://nextmail.sh/docs/java/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.emails()](https://nextmail.sh/docs/java/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.templates()](https://nextmail.sh/docs/java/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tracking()](https://nextmail.sh/docs/java/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.threads()](https://nextmail.sh/docs/java/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.followUps()](https://nextmail.sh/docs/java/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.drafts()](https://nextmail.sh/docs/java/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.labels()](https://nextmail.sh/docs/java/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.contacts()](https://nextmail.sh/docs/java/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.audiences()](https://nextmail.sh/docs/java/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.segments()](https://nextmail.sh/docs/java/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.forms()](https://nextmail.sh/docs/java/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.automations()](https://nextmail.sh/docs/java/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.events()](https://nextmail.sh/docs/java/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.broadcasts()](https://nextmail.sh/docs/java/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.domains()](https://nextmail.sh/docs/java/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.appHost()](https://nextmail.sh/docs/java/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.branding()](https://nextmail.sh/docs/java/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.rules()](https://nextmail.sh/docs/java/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.webhooks()](https://nextmail.sh/docs/java/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.imports()](https://nextmail.sh/docs/java/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.providerImports()](https://nextmail.sh/docs/java/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.calendar()](https://nextmail.sh/docs/java/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.settings()](https://nextmail.sh/docs/java/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.outOfOffice()](https://nextmail.sh/docs/java/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.roles()](https://nextmail.sh/docs/java/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.members()](https://nextmail.sh/docs/java/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.suppressions()](https://nextmail.sh/docs/java/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.sending()](https://nextmail.sh/docs/java/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.files()](https://nextmail.sh/docs/java/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.knowledge()](https://nextmail.sh/docs/java/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tempMail()](https://nextmail.sh/docs/java/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tools()](https://nextmail.sh/docs/java/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.support()](https://nextmail.sh/docs/java/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.encryption()](https://nextmail.sh/docs/java/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.senders()](https://nextmail.sh/docs/java/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.chats()](https://nextmail.sh/docs/java/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.analytics()](https://nextmail.sh/docs/java/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.subscriptions()](https://nextmail.sh/docs/java/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.exports()](https://nextmail.sh/docs/java/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.dnsConnections()](https://nextmail.sh/docs/java/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.billing()](https://nextmail.sh/docs/java/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.workspaces()](https://nextmail.sh/docs/java/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.account()](https://nextmail.sh/docs/java/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.signatures()](https://nextmail.sh/docs/java/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.tasks()](https://nextmail.sh/docs/java/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.bookings()](https://nextmail.sh/docs/java/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.connectors()](https://nextmail.sh/docs/java/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.connectedMailboxes()](https://nextmail.sh/docs/java/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## C#

The `Nextmail` NuGet package for .NET 8 and up, and for .NET Standard 2.0. One method for every endpoint, with named arguments.

- [C# SDK](https://nextmail.sh/docs/csharp.md): The official .NET client for the Nextmail API. One NuGet package with no dependencies on .NET 8 and later, and one method for every endpoint.
- [Install](https://nextmail.sh/docs/csharp/install.md): One NuGet package for .NET 8 and later and for .NET Standard 2.0, with no dependencies on .NET 8.
- [Configuration](https://nextmail.sh/docs/csharp/configuration.md): Every option of the client, what it reads from the environment, and what it refuses.
- [Errors and retries](https://nextmail.sh/docs/csharp/errors.md): One exception type for every refusal, a property for every kind, and retries that cannot send twice.
- [Pagination](https://nextmail.sh/docs/csharp/pagination.md): One page, every page, or one item at a time.
- [Send an email](https://nextmail.sh/docs/csharp/emails/send.md): One message now or later, with attachments, or a hundred in one request.
- [Verify webhooks](https://nextmail.sh/docs/csharp/webhooks/verify.md): Check the signature of a delivery before you trust what it says.
- [Every method](https://nextmail.sh/docs/csharp/reference/methods.md): All 684, one row each, against the endpoint each one calls.
- [Helpers and constants](https://nextmail.sh/docs/csharp/reference/helpers.md): What else the package defines besides the client’s methods.
- [Changelog](https://nextmail.sh/docs/csharp/changelog.md): Every release of the package, newest first.
- [client.Me](https://nextmail.sh/docs/csharp/reference/me.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Security](https://nextmail.sh/docs/csharp/reference/security.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Keys](https://nextmail.sh/docs/csharp/reference/keys.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Addresses](https://nextmail.sh/docs/csharp/reference/addresses.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Languages](https://nextmail.sh/docs/csharp/reference/languages.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Emails](https://nextmail.sh/docs/csharp/reference/emails.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Templates](https://nextmail.sh/docs/csharp/reference/templates.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Tracking](https://nextmail.sh/docs/csharp/reference/tracking.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Threads](https://nextmail.sh/docs/csharp/reference/threads.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.FollowUps](https://nextmail.sh/docs/csharp/reference/follow-ups.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Drafts](https://nextmail.sh/docs/csharp/reference/drafts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Labels](https://nextmail.sh/docs/csharp/reference/labels.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Contacts](https://nextmail.sh/docs/csharp/reference/contacts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Audiences](https://nextmail.sh/docs/csharp/reference/audiences.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Segments](https://nextmail.sh/docs/csharp/reference/segments.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Forms](https://nextmail.sh/docs/csharp/reference/forms.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Automations](https://nextmail.sh/docs/csharp/reference/automations.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Events](https://nextmail.sh/docs/csharp/reference/events.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Broadcasts](https://nextmail.sh/docs/csharp/reference/broadcasts.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Domains](https://nextmail.sh/docs/csharp/reference/domains.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.AppHost](https://nextmail.sh/docs/csharp/reference/app-host.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Branding](https://nextmail.sh/docs/csharp/reference/branding.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Rules](https://nextmail.sh/docs/csharp/reference/rules.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Webhooks](https://nextmail.sh/docs/csharp/reference/webhooks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Imports](https://nextmail.sh/docs/csharp/reference/imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.ProviderImports](https://nextmail.sh/docs/csharp/reference/provider-imports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Calendar](https://nextmail.sh/docs/csharp/reference/calendar.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Settings](https://nextmail.sh/docs/csharp/reference/settings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.OutOfOffice](https://nextmail.sh/docs/csharp/reference/out-of-office.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Roles](https://nextmail.sh/docs/csharp/reference/roles.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Members](https://nextmail.sh/docs/csharp/reference/members.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Suppressions](https://nextmail.sh/docs/csharp/reference/suppressions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Sending](https://nextmail.sh/docs/csharp/reference/sending.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Files](https://nextmail.sh/docs/csharp/reference/files.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Knowledge](https://nextmail.sh/docs/csharp/reference/knowledge.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.TempMail](https://nextmail.sh/docs/csharp/reference/temp-mail.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Tools](https://nextmail.sh/docs/csharp/reference/tools.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Support](https://nextmail.sh/docs/csharp/reference/support.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Encryption](https://nextmail.sh/docs/csharp/reference/encryption.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Senders](https://nextmail.sh/docs/csharp/reference/senders.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Chats](https://nextmail.sh/docs/csharp/reference/chats.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Analytics](https://nextmail.sh/docs/csharp/reference/analytics.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Subscriptions](https://nextmail.sh/docs/csharp/reference/subscriptions.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Exports](https://nextmail.sh/docs/csharp/reference/exports.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.DnsConnections](https://nextmail.sh/docs/csharp/reference/dns-connections.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Billing](https://nextmail.sh/docs/csharp/reference/billing.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Workspaces](https://nextmail.sh/docs/csharp/reference/workspaces.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Account](https://nextmail.sh/docs/csharp/reference/account.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Signatures](https://nextmail.sh/docs/csharp/reference/signatures.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Tasks](https://nextmail.sh/docs/csharp/reference/tasks.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Bookings](https://nextmail.sh/docs/csharp/reference/bookings.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.Connectors](https://nextmail.sh/docs/csharp/reference/connectors.md): Every method in this namespace: its signature, its parameters, what it returns and an example.
- [client.ConnectedMailboxes](https://nextmail.sh/docs/csharp/reference/connected-mailboxes.md): Every method in this namespace: its signature, its parameters, what it returns and an example.

## CLI

The `nextmail` command. Your mailbox and every API operation, from a terminal or a script.

- [CLI](https://nextmail.sh/docs/cli.md): The `nextmail` command: your mailbox and every API operation, from a terminal or a script.
- [Install](https://nextmail.sh/docs/cli/install.md): npm, pnpm, Bun or Yarn, or no install at all with npx.
- [Authentication](https://nextmail.sh/docs/cli/authentication.md): Sign in with your browser or an API key, keep several profiles, and verify a code before a sensitive change.
- [Commands](https://nextmail.sh/docs/cli/commands.md): How a command reads, the global flags, every hand-written command and every resource namespace.
- [Mail](https://nextmail.sh/docs/cli/mail.md): Send with any body and attachments, read and search the mailbox, reply, file threads, and use disposable inboxes.
- [AI and MCP](https://nextmail.sh/docs/cli/ai-and-mcp.md): Translate, write and summarise mail, connect AI clients to your mailbox, call MCP tools, and ask the docs.
- [Scripting](https://nextmail.sh/docs/cli/scripting.md): JSON output, streams, exit codes, environment variables, and running unattended or in CI.
- [For AI agents](https://nextmail.sh/docs/cli/agents.md): Drive `nextmail` from Claude Code, Codex or a CI job: unattended sign-in, help as data, dry runs, missing scopes and verification codes.
- [Sending and tracking email](https://nextmail.sh/docs/cli/emails.md): Send, batch, translate, schedule and cancel mail with the `emails` commands, then follow its delivery, opens and clicks with `tracking`.
- [Threads, drafts and labels](https://nextmail.sh/docs/cli/mailbox.md): Every command in the threads, drafts and labels namespaces, and how they sit under inbox, read, archive and the other mail commands.
- [Contacts, audiences and broadcasts](https://nextmail.sh/docs/cli/contacts.md): Every command for the address book, audiences, broadcasts and the suppression list, with worked examples.
- [Sign-up forms](https://nextmail.sh/docs/cli/forms.md): Every command for sign-up forms and the people who fill them in, with worked examples.
- [Automations and events](https://nextmail.sh/docs/cli/automations.md): Every command for automations, the people inside them and the events that move them, with worked examples.
- [Tasks](https://nextmail.sh/docs/cli/tasks.md): Every command for tasks, the runs they make and the approvals those runs ask for, with worked examples.
- [Booking pages](https://nextmail.sh/docs/cli/bookings.md): Every command for booking pages, the times they offer and the meetings guests booked, with worked examples.
- [Connectors](https://nextmail.sh/docs/cli/connectors.md): Every command for connectors, the apps that can be connected, the actions they offer and the record of what was done, with worked examples.
- [Domains and addresses](https://nextmail.sh/docs/cli/domains.md): Add and verify domains, read the DNS records they need, manage the addresses on them, and check what you can send as.
- [Templates, rules and webhooks](https://nextmail.sh/docs/cli/automation.md): Every `templates`, `rules` and `webhooks` command: stored bodies you send by slug, rules that file arriving mail, and signed events for your own server.
- [Files, imports and settings](https://nextmail.sh/docs/cli/files.md): Every command for the files the mailbox holds, importing an old mailbox or an account at another provider, the calendar found in mail, and the settings of the workspace and of each address.
- [Keys, members and roles](https://nextmail.sh/docs/cli/workspace.md): Manage API keys and read what they did, invite and manage members, write roles, check the credential you are using, and make disposable inboxes.
- [Every command](https://nextmail.sh/docs/cli/reference/commands.md): All 593, one row each, with the endpoint each resource command calls.
- [Changelog](https://nextmail.sh/docs/cli/changelog.md): Every release of the CLI, newest first.
- [Hand-written commands](https://nextmail.sh/docs/cli/reference/hand-written.md): The commands written for people, with every argument, flag and example.
- [nextmail me](https://nextmail.sh/docs/cli/reference/me.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail security](https://nextmail.sh/docs/cli/reference/security.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail keys](https://nextmail.sh/docs/cli/reference/keys.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail addresses](https://nextmail.sh/docs/cli/reference/addresses.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail languages](https://nextmail.sh/docs/cli/reference/languages.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail emails](https://nextmail.sh/docs/cli/reference/emails.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail templates](https://nextmail.sh/docs/cli/reference/templates.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail tracking](https://nextmail.sh/docs/cli/reference/tracking.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail threads](https://nextmail.sh/docs/cli/reference/threads.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail follow-ups](https://nextmail.sh/docs/cli/reference/follow-ups.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail drafts](https://nextmail.sh/docs/cli/reference/drafts.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail labels](https://nextmail.sh/docs/cli/reference/labels.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail contacts](https://nextmail.sh/docs/cli/reference/contacts.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail audiences](https://nextmail.sh/docs/cli/reference/audiences.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail segments](https://nextmail.sh/docs/cli/reference/segments.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail forms](https://nextmail.sh/docs/cli/reference/forms.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail automations](https://nextmail.sh/docs/cli/reference/automations.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail events](https://nextmail.sh/docs/cli/reference/events.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail broadcasts](https://nextmail.sh/docs/cli/reference/broadcasts.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail domains](https://nextmail.sh/docs/cli/reference/domains.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail app-host](https://nextmail.sh/docs/cli/reference/app-host.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail branding](https://nextmail.sh/docs/cli/reference/branding.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail rules](https://nextmail.sh/docs/cli/reference/rules.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail webhooks](https://nextmail.sh/docs/cli/reference/webhooks.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail imports](https://nextmail.sh/docs/cli/reference/imports.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail provider-imports](https://nextmail.sh/docs/cli/reference/provider-imports.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail calendar](https://nextmail.sh/docs/cli/reference/calendar.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail settings](https://nextmail.sh/docs/cli/reference/settings.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail out-of-office](https://nextmail.sh/docs/cli/reference/out-of-office.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail roles](https://nextmail.sh/docs/cli/reference/roles.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail members](https://nextmail.sh/docs/cli/reference/members.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail suppressions](https://nextmail.sh/docs/cli/reference/suppressions.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail sending](https://nextmail.sh/docs/cli/reference/sending.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail files](https://nextmail.sh/docs/cli/reference/files.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail knowledge](https://nextmail.sh/docs/cli/reference/knowledge.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail temp-mail](https://nextmail.sh/docs/cli/reference/temp-mail.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail tools](https://nextmail.sh/docs/cli/reference/tools.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail support](https://nextmail.sh/docs/cli/reference/support.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail encryption](https://nextmail.sh/docs/cli/reference/encryption.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail senders](https://nextmail.sh/docs/cli/reference/senders.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail chats](https://nextmail.sh/docs/cli/reference/chats.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail analytics](https://nextmail.sh/docs/cli/reference/analytics.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail subscriptions](https://nextmail.sh/docs/cli/reference/subscriptions.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail exports](https://nextmail.sh/docs/cli/reference/exports.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail dns-connections](https://nextmail.sh/docs/cli/reference/dns-connections.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail billing](https://nextmail.sh/docs/cli/reference/billing.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail workspaces](https://nextmail.sh/docs/cli/reference/workspaces.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail account](https://nextmail.sh/docs/cli/reference/account.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail signatures](https://nextmail.sh/docs/cli/reference/signatures.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail tasks](https://nextmail.sh/docs/cli/reference/tasks.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail bookings](https://nextmail.sh/docs/cli/reference/bookings.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail connectors](https://nextmail.sh/docs/cli/reference/connectors.md): Every command in this namespace, with its arguments, flags and examples.
- [nextmail connected-mailboxes](https://nextmail.sh/docs/cli/reference/connected-mailboxes.md): Every command in this namespace, with its arguments, flags and examples.