Mailtrap

Create a new inbound folder.

Create a forward rule on an inbound inbox. Received messages matching all `conditions` (none = every message) are forwarded to the `destinations`.

Create a new inbound inbox in a folder. Omit `domain_id` for a Mailtrap-hosted inbox; pass it for a custom-domain (catch-all) inbox.

Create a new sandbox test inbox within a project. Returns SMTP credentials for the new inbox.

Create a new sandbox project to group test inboxes

Create a new sending domain

Create a new sub-account under the organization. Requires `MAILTRAP_ORGANIZATION_ID` and sub-account management permissions.

Add an email address to the account's suppression list, so Mailtrap stops delivering to it.

Create a new email template

Exclude an email address from open and click tracking for a sending domain.

Create a webhook. `webhook_type` may be `email_sending`, `audit_log`, or `inbound_receiving`; for `inbound_receiving`, `inbound_inbox_id` is optional (scopes the webhook to one inbox — omit to apply to all inboxes). The response includes a `signing_secret` for verifying webhook payload signatures — this secret is returned only on creation, so store it now.

Permanently delete an API token by ID. The token can no longer authenticate after deletion.

Permanently delete a contact by ID or email. Returns the deleted contact record when available.

Permanently delete a contact field definition by ID.

Permanently delete a contact list by ID.

Delete an email campaign by ID; only a campaign in the `draft` state can be deleted.

Permanently delete an inbound folder along with all of its inboxes.

Permanently delete an inbound forward rule.

Permanently delete an inbound inbox.

Permanently delete an inbound message.

Permanently delete an inbound thread.

Delete a sandbox inbox and all its messages

Delete a single sandbox message

Delete a sandbox project and all its inboxes

Delete a sending domain

Delete a suppression by ID. Mailtrap will resume delivery to this email unless it gets suppressed again.

Delete an existing email template

Remove an email address from the tracking opt-out list, so open and click tracking applies to it again.

Permanently delete a webhook by ID. Returns the deleted webhook record.

Enable the receive-by-email address for a sandbox

Forward an inbound message to new recipients (at least one `to` is required). Sends a real email.

Forward a sandbox message to an email address (counts against your monthly forwarding quota)

Get an API token by ID. The secret token value is NOT returned here — only the metadata (name, last 4 digits, resources).

Get the current billing cycle usage for the account (sending and testing plans, limits, and current counts).

Get the company info of a sending domain, used for domain compliance verification.

Get a contact by ID or email address. Returns the full contact record including list memberships, status, and custom fields.

Get the status of a contact export job. Once `status` is `finished`, the `url` field holds the download link.

Get a contact field definition by ID.

Get the status of a contact import job, including created/updated/over-limit counts.

Get a contact list by ID.

Get an email campaign by ID.

Get aggregated performance statistics for an email campaign; optionally narrow the window with `start_date`/`end_date` (`YYYY-MM-DD`).

Get a single email log message by ID (UUID) to inspect delivery status and event history.

Get a single inbound folder by ID.

Get a single inbound forward rule by ID, with its conditions and destinations.

Get a single inbound inbox by ID.

Get a single inbound message with its full body and attachment download URLs.

Get a single inbound thread with its messages embedded (oldest first).

Get all resources (inboxes, projects, domains, billing, account) to which the API token has admin access, nested by hierarchy.

Get the metadata and download URL for a single sandbox attachment.

Get sandbox inbox details including SMTP credentials, email counts, and status

Get a sandbox message as an EML file payload.

Get the parsed mail headers for a sandbox message.

Get the rendered HTML body of a sandbox message.

Get HTML analysis for a sandbox message (client compatibility, problematic elements).

Get the unrendered HTML source of a sandbox message.

Get the raw message (MIME-formatted) for a sandbox message.

Get the SpamAssassin spam report for a sandbox message (score, rules, report).

Get the plain-text body of a sandbox message.

Get list of messages from the sandbox test inbox

Get a sandbox project by ID, including its inboxes and email counts

Get a sending domain by ID and its verification status. Optionally include DNS setup instructions via include_setup_instructions.

Get email sending statistics (delivery, bounce, open, click, spam rates) for a date range. Optionally break down by domain, category, email service provider, or date.

Get a single email template by ID, including subject, category, and HTML/text body.

Get a single webhook by ID.

List account accesses (users, invites, API tokens) for the account. Optionally scope by domain UUIDs, inbox IDs, or project IDs. Requires account admin/owner permissions.

List Mailtrap accounts accessible to the API token, with each account's access levels.

List all API tokens for the account.

List all contact field definitions for the account.

List all contact lists for the account. Optionally filter by name with `search` (case-insensitive match).

List the account's email campaigns, newest first, with page-token pagination (`token`, `per_page`). Optionally filter by name with `search`.

List sent email logs (delivery history) with optional pagination and filters; use to debug delivery issues.

List all inbound folders in the account.

List the forward rules of an inbound inbox. Forward rules automatically forward copies of received messages to other addresses.

List all inboxes in an inbound folder.

List received messages in an inbound inbox (paginated). Pass `last_id` from a previous response to fetch the next page.

List conversation threads in an inbound inbox (paginated), optionally filtered by `search` (subject or from/to/cc/bcc address). Pass `last_id` from a previous response to fetch the next page.

List all attachments on a sandbox message.

List all sandbox projects and their inboxes in your Mailtrap account

List all sandboxes accessible to the API token across projects

List sending domains and their DNS verification status

List sub-accounts in the organization. Requires `MAILTRAP_ORGANIZATION_ID` env var and sub-account management permissions.

List or search suppressions. Optionally filter by email. Returns up to 1000 suppressions per call.

List the account's email templates with page-token pagination (`token`, `per_page`). Pages are offsets over the newest-first list, so after deleting templates list again from token 1 instead of continuing with the next token.

List email addresses excluded from open and click tracking. Returns up to 1000 records per call.

List all webhooks for the account.

Mark all messages in a sandbox as read

Remove an account access by ID. For User specifiers this revokes permissions; for Invite or ApiToken specifiers it removes the specifier itself. Requires admin/owner.

Reply to an inbound message and copy the original's other recipients. Sends a real email.

Reply to an inbound message (sends to the original sender). Sends a real email.

Reset (rotate) an API token by ID. The response includes the **new** secret `token` value — returned only on this call, so store it immediately. The previous token is invalidated.

Reset a `scheduled` email campaign back to `draft`; only `scheduled` campaigns can be reset.

Reset the SMTP credentials for a sandbox

Generate a new receive-by-email address for a sandbox

Schedule a `draft` email campaign to start sending at `datetime` (ISO 8601, must be in the future and no more than 1 month ahead); only `draft` campaigns can be scheduled.

Send an email to your recipient email address using Mailtrap Email API. You can send emails to multiple recipients at once.

Send an email in sandbox mode to a test inbox without delivering to your recipients

Email DNS setup instructions for a sending domain to a given address.

Show sandbox email message details and content from the sandbox test inbox. Optionally include spam report (SpamAssassin score) and HTML analysis (client compatibility) for email testing workflows.

Start sending a `draft` email campaign immediately; only `draft` campaigns can be started.

Terminate an email campaign that is currently sending (`started`, `queued`, or `paused`), aborting the in-flight send.

Update the company info of a sending domain.

Update a contact (identified by ID or email). `list_ids` replaces the membership set; `list_ids_included`/`list_ids_excluded` add/remove without disturbing the rest.

Update a contact field definition. Any combination of `name`, `merge_tag`, or `data_type` can be changed.

Rename an existing contact list.

Update a `draft` email campaign; only the provided fields change, and campaigns in any other state cannot be updated.

Rename an inbound folder.

Update an inbound forward rule. Only the provided fields change; a provided `conditions` or `destinations` array replaces the whole set (`[]` clears it).

Rename an inbound inbox.

Update a sandbox inbox name or email username

Mark a sandbox message as read or unread

Rename an existing sandbox project

Update a sending domain's tracking and inbound settings.

Update an existing email template

Update a webhook's mutable fields (`url`, `active`, `payload_format`, `event_types`, `inbound_inbox_id`). `webhook_type`, `sending_stream`, and `domain_id` cannot be changed after creation.