# MailSlurp integration

> Create real email inboxes and phone numbers, send and receive email and SMS, wait for messages, extract codes, and test deliverability through the MailSlurp API.

- Authentication: apiKey

## Tools (741)

- **Acquire phone pool lease**: Acquire an available phone number from the pool and mark it leased
- **Add all phone numbers to phone pool**: Add all active owned phone numbers to a pool
- **Add catch all wild card inbox to domain**: Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
- **Add contacts to a group**: Add contacts to a group
- **Add phone numbers to phone pool**: Add one or more owned phone numbers to a pool
- **Add phone number tags**: Add one or more tags to a phone number
- **Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation**: Create new phone number
- **Analyze email headers for auth results and delivery path**: Analyze email headers for auth results and delivery path
- **Attach a WebHook URL to an AI transformer**: Get notified whenever AI transformation pipeline converts and email or SMS into structured data via a WebHook URL.
- **Attach a WebHook URL to a phone number**: Get notified whenever a phone number receives an SMS via a WebHook URL.
- **Bulk create Inboxes (email addresses)**: Bulk create Inboxes (email addresses)
- **Bulk Delete Inboxes**: Bulk Delete Inboxes
- **Bulk Send Emails**: Bulk Send Emails
- **Can account send email**: Check if account block status prevents sending
- **Cancel a running device preview run**: Cancel a running device preview run
- **Cancel a scheduled email job**: Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
- **Cancel deliverability simulation job**: Cancel a running or paused simulation job.
- **Cancel purchased Delivery Sender seats**: Cancel purchased Delivery Sender seats
- **Cancel purchased email warmup sender seats**: Cancel purchased email warmup sender seats
- **Check client support for features used in a stored email body**: Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices.
- **Check DNS propagation for a host and record type across configured resolvers**: Check DNS propagation for a host and record type across configured resolvers
- **Check email body for broken links, images, and spelling issues**: Runs content quality checks against hydrated email body content. This endpoint performs outbound HTTP checks for linked resources, so avoid use with sensitive or stateful URLs.
- **Check email-client support for a provided HTML body**: Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms.
- **Check email client support for email HTML and CSS features**: Check email client support for email HTML and CSS features
- **Check email/domain reputation signals including configured DNS blacklists**: Run reputation-oriented checks for an email address, domain, IP address, or MX host. This is separate from address validation.
- **Check named natural-language assertions against an existing email or SMS**: Check named natural-language assertions against an existing email or SMS.
- **Check Sending Consent For Email Address**: Check Sending Consent For Email Address
- **Check whether a domain or IP appears on configured DNS blacklists**: Check whether a domain or IP appears on configured DNS blacklists
- **Check whether an email send would be accepted**: Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows.
- **Compare two campaign probe runs**: Compare two campaign probe runs
- **Compare two email audits**: Compare two email audits
- **Compare two monitor runs**: Compare two monitor runs
- **Confirm an inbox placement test email has been sent**: Reconcile any messages that arrived after seed reservation, commit allowance, and move a prepared dashboard test into its active lifecycle. This operation is idempotent.
- **Create**: Create
- **Create a BIMI record policy**: Create a BIMI record policy
- **Create Account Webhook**: Get notified of account level events such as bounce and bounce recipient.
- **Create a contact**: Create a contact
- **Create a device preview folder**: Create a device preview folder
- **Create a device preview profile**: Create a device preview profile
- **Create a device preview run from an HTML, EML, or ZIP file**: Uploads an HTML or RFC822 EML file, or a ZIP archive containing exactly one HTML or EML file. ZIP uploads are bounded by entry count, expanded size, and compression ratio.
- **Create a device preview run from HTML**: Create a device preview run from HTML
- **Create a device preview run from imported raw MIME**: Create a device preview run from imported raw MIME
- **Create a device preview run from multipart EML upload**: Create a device preview run from multipart EML upload
- **Create a device preview run from raw MIME bytes**: Create a device preview run from raw MIME bytes
- **Create a DMARC record policy**: Create a DMARC record policy
- **Create a group**: Create a group
- **Create alert sink for monitor**: Create alert sink for monitor
- **Create an automated inbox placement schedule**: Create an automated inbox placement schedule
- **Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active**: Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address.
- **Create an email draft**: Create a saved email draft using the same SendEmailOptions shape used for sending.
- **Create an email warmup program**: Create an email warmup program
- **Create an emergency address**: Add an emergency address to a phone number
- **Create an encrypted sender connection**: Create an encrypted sender connection
- **Create a new device preview run for an email**: Create a new device preview run for an email
- **Create a new direct-send inbox placement test**: Create a new direct-send inbox placement test
- **Create a new email address using the fake email domains**: Create a new email address using the fake email domains
- **Create a new mailbox if possible**: Create a new mailbox if possible
- **Create an inbox connector**: Sync emails between external mailboxes and MailSlurp inboxes
- **Create an inbox connector IMAP connection**: Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox
- **Create an inbox connector SMTP connection**: Allows sending via connector and email is routed to connected inbox and sent via SMTP
- **Create an inbox connector with options**: Sync emails between external mailboxes and MailSlurp inboxes
- **Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes**: Create a new inbox and with a randomized email address to send and receive from.
- **Create an inbox forwarder**: Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
- **Create an inbox replier**: Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving
- **Create an inbox ruleset**: Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
- **Create an inbox with default options. Uses MailSlurp domain pool address and is private**: Create an inbox with default options. Uses MailSlurp domain pool address and is private.
- **Create an inbox with options. Extended options for inbox creation**: Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
- **Create an SPF record**: Create an SPF record
- **Create a phone provisioning job**: Create an advanced phone provisioning job from shortlisted numbers
- **Create a portal guest user**: Add customer to portal
- **Create a portal page for your customers or clients to log into email accounts and view emails**: Create a guest login page for customers or clients to access assigned email addresses
- **Create a public email render test**: Creates an unauthenticated free email render test and returns a short-lived generated email address.
- **Create a public spam test**: Create an unauthenticated inbox placement run for public tools users. Returns seed addresses and a tracking token immediately.
- **Create a ruleset**: Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving
- **Create a sending connection**: Create a sending connection
- **Create a share link for a device preview run**: Create a share link for a device preview run
- **Create a Template**: Create an email template with variables for use with templated transactional emails.
- **Create a temporary email address for device preview import**: Create a temporary email address for device preview import
- **Create a TOTP device from an base32 secret key**: Create a virtual TOTP device for a given secret key. This is usually present as an alternative login option when pairing OTP devices.
- **Create a TOTP device from an OTP Auth URL**: Create a virtual TOTP device for a given OTP Auth URL such as otpauth://totp/MyApp:alice@example.com?secret=ABC123&issuer=MyApp&period=30&digits=6&algorithm=SHA1.
- **Create a TOTP device from custom options**: Create a virtual TOTP device for custom options specifying all parameters of the TOTP device.
- **Create a transformer for reuse in automations**: Save an AI transform instructions and schema for use with webhooks and automations
- **Create campaign probe**: Create campaign probe
- **Create Connector Sync Settings**: Configure automatic pull or emails from external inboxes using an interval or schedule
- **Create deliverability simulation job**: Create and start a simulation job for a running load test. Only one active simulation job is allowed per user.
- **Create device preview feedback**: Create device preview feedback
- **Create Domain**: Link a domain that you own with MailSlurp so you can create email addresses using it.
- **Create domain monitor**: Create domain monitor
- **Create email audit**: Create email audit
- **Create Inbox Retention Policy**: Create an inbox retention policy for your account
- **Create Inbox Retention Policy Run**: Start an asynchronous inbox retention policy run for your account
- **Create load test**: Create a load test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope.
- **Create New Email Address**: Returns an Inbox with an `id` and an `emailAddress`
- **Create or rotate domain monitor email verification address**: Create or rotate domain monitor email verification address
- **Create Or Update Inbox Retention Policy For Account**: Create inbox retention policy for your global account
- **Create phone pool**: Create a reusable pool of phone numbers for coordinated leasing
- **Create Postmaster OAuth connection URL**: Create Postmaster OAuth connection URL
- **Create Random Inbox**: Returns an Inbox with an `id` and an `emailAddress`
- **Create tracking pixel**: Create a tracking pixel.
- **Create transformer mapping**: Create AI transformer mappings to other entities
- **Create Webhook**: Get notified whenever an inbox receives an email via a WebHook URL.
- **Delete**: Delete
- **Delete a device preview profile**: Delete a device preview profile
- **Delete a domain**: Delete a domain. This will disable any existing inboxes that use this domain.
- **Delete a fake email address using the fake email domains**: Delete a fake email address using the fake email domains
- **Delete a folder, preserving renders and child folders**: Delete a folder, preserving renders and child folders
- **Delete all attachments**: Delete all attachments
- **Delete all emails in a given inboxes**: Deletes all emails in an inbox. Be careful as emails cannot be recovered
- **Delete all emails in all inboxes**: Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone.
- **Delete all emails in an inbox**: Deletes all emails
- **Delete all inbox connectors**: Delete all inbox connectors
- **Delete all inboxes**: Permanently delete all inboxes and associated email addresses.
- **Delete all phone numbers**: Remove all phone number from account
- **Delete all sent email receipts**: Delete all sent email receipts
- **Delete all sent SMS messages**: Delete all sent SMS messages or all messages for a given phone number
- **Delete all SMS messages**: Delete all SMS messages or all messages for a given phone number
- **Delete all transformer mapping**: Delete all AI transformer mappings
- **Delete all transformers**: Delete all AI transformers and schemas
- **Delete all validation requests**: Remove validation requests
- **Delete all webhooks**: Delete all webhooks
- **Delete an attachment**: Delete an attachment
- **Delete an automated inbox placement schedule**: Delete an automated inbox placement schedule
- **Delete and disable a Webhook for an Inbox**: Delete and disable a Webhook for an Inbox
- **Delete an email**: Deletes a single email from account scope. Operation is destructive and not reversible.
- **Delete an email alias**: Delete an email alias
- **Delete an email draft**: Delete a saved email draft without sending it.
- **Delete an email warmup program**: Delete an email warmup program
- **Delete an emergency address**: Delete an emergency address
- **Delete an inbox connector**: Delete an inbox connector
- **Delete an inbox connector IMAP connection**: Delete IMAP connection for external inbox
- **Delete an inbox connector SMTP connection**: Delete SMTP connection for external inbox
- **Delete an inbox forwarder**: Delete inbox forwarder
- **Delete an inbox replier**: Delete inbox replier
- **Delete a phone number**: Remove phone number from account
- **Delete a ruleset**: Delete ruleset
- **Delete a TOTP device**: Delete a Time-Based One-Time Password (TOTP) device by ID.
- **Delete a transformer**: Delete an AI transformer and schemas by ID
- **Delete a transformer result**: Delete a saved AI transformer result owned by your account.
- **Delete a validation record**: Delete a validation record
- **Delete a webhook**: Delete a webhook
- **Delete campaign probe**: Delete campaign probe
- **Delete Connector Sync Settings**: Configure automatic pull or emails from external inboxes using an interval or schedule
- **Delete contact**: Delete contact
- **Delete domain monitor**: Delete domain monitor
- **Delete domain monitor observed authentication sample**: Delete domain monitor observed authentication sample
- **Delete email audit**: Delete email audit
- **Delete email template**: Delete template
- **Delete group**: Delete group
- **Delete inbox**: Permanently delete an inbox and associated email address as well as all emails within the given inbox.
- **Delete inbox email address by inbox id**: Deletes inbox email address
- **Delete inboxes by description**: Permanently delete all inboxes by description
- **Delete inboxes by name**: Permanently delete all inboxes by name
- **Delete inboxes by tag**: Permanently delete all inboxes by tag
- **Delete inbox forwarders**: Delete inbox forwarders. Accepts optional inboxId filter.
- **Delete inbox repliers**: Delete inbox repliers. Accepts optional inboxId filter.
- **Delete Inbox Retention Policy**: Delete an inbox retention policy for your account
- **Delete Inbox Retention Policy For Account**: Delete inbox retention policy for your global account
- **Delete load test**: Delete test and all persisted entity-level results.
- **Delete local device preview run data**: Delete local device preview run data
- **Delete messages in a phone thread**: Delete all messages in an SMS thread
- **Delete monitor alert sink**: Delete monitor alert sink
- **Delete phone pool**: Delete a phone pool and release any active leases from that pool
- **Delete rulesets**: Delete rulesets. Accepts optional inboxId or phoneId filters.
- **Delete sent email receipt**: Delete sent email receipt
- **Delete sent SMS message**: Delete a sent SMS message
- **Delete SMS message**: Delete an SMS message
- **Delete transformer mapping**: Delete an AI transformer mapping
- **Delete transformer results**: Delete your account's saved AI results, optionally for one transformer.
- **Disable Delivery Sender capacity**: Releases this connection's shared sender allocation while retaining its verified credentials.
- **Disconnect a sender connection**: Disconnect a sender connection
- **Disconnect a sending connection**: Disconnect a sending connection
- **Disconnect Postmaster OAuth**: Disconnect Postmaster OAuth
- **Does inbox exist**: Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
- **Does inbox have automations**: Check if an inbox has automations.
- **Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints**: Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
- **Download inbox placement seed addresses as an email-platform CSV**: Export the current run's seed addresses with headers recognized by the selected email platform. Downloading a prepared seed list does not confirm the send or consume allowance.
- **Download Phone Number Media**: Download Phone Number Media
- **Download Phone Number Media Base64**: Download Phone Number Media Base64
- **Download Sms Media**: Download Sms Media
- **Download Sms Media Base64**: Download Sms Media Base64
- **Download the original RFC822 email for a device preview run**: Download the original RFC822 email for a device preview run
- **Download the original RFC822 email for a device preview submission**: Download the original RFC822 email for a device preview submission
- **Duplicate load test**: Create a fresh load test using an existing test configuration, including selector scope, exclusions, and expectations.
- **Enable a verified Delivery Sender**: Allocates shared sender capacity. Included capacity is used first and supported additional capacity is added to the existing subscription when possible.
- **Exchange Postmaster OAuth authorization code**: Exchange Postmaster OAuth authorization code
- **Export inboxes link callable via browser**: Export inboxes link callable via browser
- **Export inbox placement test results as CSV**: Export one row per placement target, including run-level delivery totals, 0-10 placement scores, and target placement outcome fields.
- **Export load-test entity results as CSV**: Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export.
- **Export load-test report as PDF**: Export a PDF report for a terminal load test (COMPLETE, FAILED, or STOPPED), including configuration, summary outcomes, and detailed entity-level results.
- **Export monitor run results as CSV**: Export one row per domain monitor check, including run-level score metadata and per-check pass, fail, or not-checked status.
- **Export phone numbers CSV**: Download all active phone numbers for account as CSV
- **Export transformer results**: Export AI transformer results in formats such as Excel, CSV, XML etc.
- **Extract links from an email HTML body**: Parses HTML content and extracts link URLs (`href`). For non-HTML emails this endpoint returns a validation error.
- **Extract normalized text lines from email body**: Converts email body content to line-based plain text with optional HTML entity decoding and custom line separator.
- **Extract schema-validated data from an existing email or SMS with verified source evidence**: Extract schema-validated data from an existing email or SMS with verified source evidence.
- **Extract signature from an inbound email**: Attempts to parse a sender signature block from an email body.
- **Extract text from an attachment**: Extract text content from an attachment using the requested method. `NATIVE` decoding supports text-like files, common Word and spreadsheet documents, and PDFs with embedded text.
- **Extract verification codes from an email**: Extracts one-time passcodes and similar tokens from email content using the selected extraction method and fallback options.
- **Extract verification codes from an SMS**: Extract one-time passcodes and verification tokens from SMS body content. Deterministic `PATTERN` extraction is available now. Use method flags to control fallback behavior for QA.
- **Fetch inbox's latest email or if empty wait for an email to arrive**: Will return either the last received email or wait for an email to arrive and return that.
- **Fetch message in an inbox**: Fetch message in an inbox
- **Filter a list of email recipients and remove those who have bounced**: Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
- **Find a message across explicit inboxes or phones, then assert and extract from that same message**: Find a message across explicit inboxes or phones, then assert and extract from that same message.
- **Forward email to recipients**: Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options.
- **Generate Mta Sts Record**: Create a TLS reporting record policy
- **Generate structured content for an attachment**: Use output schemas to extract data from an attachment using AI
- **Generate structured content for an email**: Use output schemas to extract data from an email using AI
- **Generate structured content for a TXT message**: Use output schemas to extract data from an SMS using AI
- **Generate Tls Reporting Record**: Create a TLS reporting record policy
- **Get a client email portal**: Fetch a customer guest portal
- **Get a device preview folder**: Get a device preview folder
- **Get a device preview profile**: Get a device preview profile
- **Get a device preview screenshot image**: Get a device preview screenshot image
- **Get a domain**: Returns domain verification status and tokens for a given domain
- **Get a fake email by its ID**: Get a fake email by its ID
- **Get a forwarder event**: Get forwarder event
- **Get all Contact Groups in paginated format**: Get all Contact Groups in paginated format
- **Get All Contacts**: Get all contacts
- **Get all email aliases you have created**: Get all email aliases in paginated form
- **Get all emails by search criteria. Return in paginated form**: Searches emails by email ID, inbox ID, sender address, subject, receiving inbox address, or receiving plus-address.
- **Get all groups**: Get all groups
- **Get All Guest Portal Users**: Get all customers for a portal
- **Get all inbox connector events**: Get all inbox connector events
- **Get all inbox forwarder events**: Get all inbox forwarder events
- **Get all MissedEmails in paginated format**: Get all MissedEmails in paginated format
- **Get all missed SMS messages in paginated format**: Get all missed SMS messages in paginated format
- **Get all phone number releases**: List released or deleted phone numbers
- **Get all scheduled email sending jobs for account**: Schedule sending of emails using scheduled jobs. These can be inbox or account level.
- **Get all scheduled email sending jobs for the inbox**: Schedule sending of emails using scheduled jobs.
- **Get all sent emails in paginated form**: Get all sent emails in paginated form
- **Get All Sent Tracking Pixels**: Get all sent email tracking pixels in paginated form
- **Get All Sms Messages**: Get All Sms Messages
- **Get all SMS messages in all phone numbers in paginated form. **: By default returns all SMS messages across all phone numbers sorted by ascending created at date.
- **Get all sub address plus address aliases for an inbox**: Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias.
- **Get All Templates**: Get all templates in paginated format
- **Get all threads**: Returns threads created for all aliases in paginated form
- **Get all unknown missed emails in paginated format**: Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
- **Get all usable domains**: List all domains available for use with email address creation
- **Get all usable domains with account region status**: List all domains available for use with email address creation, including account-region and create/send enablement flags.
- **Get a message by email ID**: Get a message by email ID
- **Get an attachment entity**: Get an attachment entity
- **Get an automated inbox placement schedule**: Get an automated inbox placement schedule
- **Get an email alias**: Get an email alias by ID
- **Get an email draft**: Get a saved email draft including the full SendEmailOptions payload.
- **Get an email warmup program**: Get an email warmup program
- **Get an emergency address**: Fetch an emergency address by ID
- **Get an expired inbox record**: Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity.
- **Get an inbox connector**: Get an inbox connector
- **Get an inbox connector event**: Get an inbox connector event
- **Get an inbox connector events**: Get an inbox connector events
- **Get an inbox connector IMAP connection**: Get IMAP connection for external inbox
- **Get an inbox connector SMTP connection**: Get SMTP connection for external inbox
- **Get an inbox connector sync settings**: Get sync settings for connection with external inbox
- **Get an inbox forwarder**: Get inbox forwarder
- **Get an inbox forwarder event**: Get inbox forwarder event
- **Get an inbox forwarder event list**: Get inbox forwarder events
- **Get an inbox replier**: Get inbox ruleset
- **Get an inbox replier event list**: Get inbox ruleset events
- **Get a phone number by ID**: Get a phone number by ID
- **Get a phone number by name**: Get a phone number by name
- **Get a phone number by phone number**: Get a phone number by phone number
- **Get a public email render test**: Returns status for a free email render test and the public share redirect when the render run is ready.
- **Get a public inbox placement share**: Get a public inbox placement share
- **Get a public shared device preview result**: Get a public shared device preview result
- **Get a public shared device preview screenshot image**: Get a public shared device preview screenshot image
- **Get a public spam test run**: Returns public spam test run status, token, seed addresses, and free-limit state.
- **Get a ruleset**: Get ruleset
- **Get a scheduled email job**: Get a scheduled email job details.
- **Get a sender connection**: Get a sender connection
- **Get a sending connection**: Get a sending connection
- **Get a single device preview feedback item**: Get a single device preview feedback item
- **Get a thread**: Return a thread associated with an alias
- **Get a TOTP device by ID**: Get Time-Based One-Time Password (TOTP) device by its ID.
- **Get a TOTP device by username, issuer, or name. Returns empty if not found**: Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.
- **Get a TOTP device code by device ID**: Get Time-Based One-Time Password for a device by its ID.
- **Get a transformer**: Get AI transformer and schemas by ID
- **Get Audit Log By Event Id**: Get Audit Log By Event Id
- **Get Audit Logs**: Get Audit Logs
- **Get automation inbox placement analytics over time**: Returns chart-ready metrics for billed placement runs created by this schedule only.
- **Get a webhook**: Get a webhook
- **Get a webhook result and try to resend the original webhook payload**: Allows you to resend a webhook payload that was already sent.
- **Get a webhook result for a webhook**: Get a webhook result for a webhook
- **Get a webhook results count for a webhook**: Get a webhook results count for a webhook
- **Get a webhook results for a webhook**: Get a webhook results for a webhook
- **Get blocked inbound spam email records in paginated format**: Get blocked inbound spam email records in paginated format
- **Get Bounced Email**: Bounced emails are email you have sent that were rejected by a recipient
- **Get Bounced Recipient**: Bounced emails are email you have sent that were rejected by a recipient
- **Get campaign probe**: Get campaign probe
- **Get campaign probe insights**: Get campaign probe insights
- **Get campaign probe run**: Get campaign probe run
- **Get campaign probe trend series**: Get campaign probe trend series
- **Get catch all wild card inbox for domain**: Get the catch all inbox for a domain for missed emails
- **Get complaint**: Get complaint
- **Get connector by email address**: Find an inbox connector by email address
- **Get connector by inbox ID**: Find an inbox connector by inbox ID
- **Get connector by name**: Find an inbox connector by name
- **Get consent status**: Get the status of phone usage consent
- **Get contact**: Get contact
- **Get Contacts**: Get all contacts
- **Get count of unseen webhook results with error status**: Get count of unseen webhook results with error status
- **Get current auth stack for monitor domain**: Get current auth stack for monitor domain
- **Get default expiration settings**: Return default times used for inbox expiration
- **Get deliverability analytics time series**: Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.
- **Get deliverability failure hotspots**: Find commonly failing entities and phone country/variant dimensions across deliverability runs in a time range.
- **Get deliverability simulation job**: Get simulation job status and progress counters.
- **Get deliverability simulation job events**: Get paged simulation events including send successes and failures.
- **Get device preview run results**: Get device preview run results
- **Get device preview run status**: Get device preview run status
- **Get DNS Mail Server records for a domain**: Get DNS Mail Server records for a domain
- **Get domain health events**: List recent health events for a custom domain using MailSlurp domain-health terminology.
- **Get domain issues**: List domain issues for domains you have created
- **Get domain monitor**: Get domain monitor
- **Get domain monitor email verification setup**: Get domain monitor email verification setup
- **Get domain monitor summary**: Get domain monitor summary
- **Get domains**: List all custom domains you have created
- **Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents**: Returns the specified attachment for a given email as a base 64 encoded string.
- **Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`**: Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.
- **Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string**: Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.
- **Get email attachment metadata information**: Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.
- **Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods**: Returns metadata for a specific attachment ID (name, content type, and size fields).
- **Get email attachments**: Get all attachments in paginated response.
- **Get email audit**: Get email audit
- **Get email body as string. Returned as `plain/text` with content type header**: Returns hydrated email body text as a string with content type aligned to the underlying body format.
- **Get email body in bytes. Returned as `octet-stream` with content type header**: Streams hydrated email body bytes with content type derived from the message body format.
- **Get email content part by content type**: Extracts one MIME body part by `contentType` and optional `index`, returned in a structured DTO with metadata.
- **Get email count**: Returns total email count for the authenticated user, or count scoped to a specific inbox when `inboxId` is provided.
- **Get email count in inbox**: Get email count in inbox
- **Get emails for an alias**: Get paginated emails for an alias by ID
- **Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead**: List emails that an inbox has received.
- **Get Emails Offset Paginated**: Offset-style pagination endpoint for listing emails across inboxes.
- **Get Emails Paginated**: Primary paginated email listing endpoint. Returns emails across inboxes with support for inbox filters, unread-only, search, date boundaries, favourites, connector sync, and plus-address filtering.
- **Get email summary (headers/metadata only)**: Returns lightweight metadata and headers for an email. Use `getEmail` for hydrated body content or `getRawEmail` for original SMTP content.
- **Get email thread metadata by thread ID**: Returns thread metadata built from RFC 5322 `Message-ID`, `In-Reply-To`, and `References` headers. Use `getEmailThreadItems` to fetch the thread messages.
- **Get email URLs for viewing in browser or downloading**: Returns precomputed URLs for preview and raw message access for the specified email.
- **Get email warmup program progress and daily activity**: Get email warmup program progress and daily activity
- **Get email warmup sender capacity, included credits, and billable usage**: Get email warmup sender capacity, included credits, and billable usage
- **Get emergency addresses**: List emergency addresses
- **Get Entity Automations**: Get Entity Automations
- **Get Entity Events**: Get Entity Events
- **Get Entity Favorites**: Get Entity Favorites
- **Get expired inbox record for a previously existing inbox**: Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
- **Get export link**: Get export link
- **Get export transformer results job**: Get the job status for an export
- **Get Fake Email By Email Address**: Get Fake Email By Email Address
- **Get fake emails for an address**: Get fake emails for an address
- **Get Gravatar URL for an email address**: Builds a Gravatar image URL from the provided email address and optional size. This endpoint does not fetch image bytes; it only returns the computed URL.
- **Get group**: Get group
- **Get group and contacts belonging to it**: Get group and contacts belonging to it
- **Get Group With Contacts Paginated**: Get group and paginated contacts belonging to it
- **Get guest portals**: Get portals
- **Get Guest Portal Users**: Get customers for a portal
- **Get guest user**: Get customer by ID
- **Get guest user for portal**: Get customer for portal
- **Get hydrated email (headers and body)**: Returns parsed email content including headers and body fields. Accessing hydrated content may mark the email as read depending on read-state rules.
- **Get hydrated email HTML for browser rendering**: Returns hydrated HTML body directly with `text/html` content type. Supports temporary access/browser usage and optional CID replacement for inline asset rendering.
- **Get hydrated email HTML wrapped in JSON**: Returns hydrated HTML body and subject in a JSON DTO. Useful for API clients that need structured response payloads instead of raw HTML responses.
- **Get Imap Access**: Get IMAP access usernames and passwords
- **Get Imap Smtp Access**: Get IMAP and SMTP access usernames and passwords
- **Get Imap Smtp Access Env**: Get IMAP and SMTP access details in .env format
- **Get Imap Smtp Access Servers**: Get IMAP and SMTP server hosts
- **Get inbox connectors**: List inbox connectors that sync external emails to MailSlurp inboxes
- **Get inbox emails paginated**: Get a paginated list of emails in an inbox. Does not hold connections open.
- **Get inboxes for a tag**: Get all inboxes for a given inbox tag
- **Get inbox placement analytics breakdowns**: Return aggregated folder, provider, sender-domain, and from-email breakdowns for inbox placement runs in a time range.
- **Get inbox placement analytics time series**: Return chart-ready inbox placement metrics over time, with optional sender/domain filters and grouped comparisons for sender domains or from-email addresses.
- **Get inbox placement run analysis**: Get inbox placement run analysis
- **Get inbox placement test results**: Get inbox placement test results
- **Get inbox placement test run**: Get inbox placement test run
- **Get Inbox Plus Address Emails**: Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
- **Get Inbox Plus Address Emails For Plus Address Id**: Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
- **Get inbox replier event list**: Get all inbox ruleset events
- **Get Inbox Retention Policy**: Get an inbox retention policy for your account
- **Get Inbox Retention Policy For Account**: Get inbox retention policy for your global account
- **Get Inbox Retention Policy Run**: Get a previously submitted inbox retention policy run for your account
- **Get Inbox Retention Policy Runs**: List recent inbox retention policy runs for your account
- **Get Inbox. Returns properties of an inbox**: Returns an inbox's properties, including its email address and ID.
- **Get inbox tags**: Get all inbox tags
- **Get inbox tags paginated**: Get all inbox tags paginated
- **Get intelligence score and breakdown for email/domain targets. Per unit billing for non-cached evaluations**: Run email intelligence scoring for one or more email addresses or domains. Submitting a single target in the list supports one-off checks.
- **Get IP address for a domain**: Get IP address for a domain
- **Get Json Property As String**: Utility function to extract properties from JSON objects in language where this is cumbersome.
- **Get Json Schema For Webhook Event**: Get JSON Schema definition for webhook payload by event
- **Get Json Schema For Webhook Payload**: Get JSON Schema definition for webhook payload
- **Get latest deliverability simulation job**: Get the most recent simulation job for a load test.
- **Get latest email in all inboxes. Most recently received**: Returns the most recently received email across all inboxes or an optional subset of inbox IDs.
- **Get Latest Email In Inbox (GET /emails/latestIn)**: Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.
- **Get Latest Email In Inbox (GET /inboxes/getLatestEmail)**: Get the newest email in an inbox or wait for one to arrive
- **Get light and dark public email preview content**: Get light and dark public email preview content
- **Get line type intelligence for a phone number**: Lookup line type intelligence for a phone number
- **Get load test**: Get load-test configuration and latest progress counters.
- **Get load-test entity results**: Get paged per-entity expectation results with optional matched/unmatched filtering.
- **Get local Postmaster traffic stats**: Get local Postmaster traffic stats
- **Get MailSlurp domains**: List all MailSlurp domains used with non-custom email addresses
- **Get messages in a phone thread**: List message thread messages for a phone message thread
- **Get messages in a specific email thread**: Returns all messages in a thread ordered by `createdAt` using the requested sort direction.
- **Get MissedEmail**: List emails that were missed due to plan limits.
- **Get missed SMS content**: Returns a missed SMS with full content.
- **Get missed SMS count**: Get missed SMS count
- **Get monitor insights**: Get monitor insights
- **Get monitor run**: Get monitor run
- **Get monitor trend series**: Get monitor trend series
- **Get multipart content part as raw response**: Extracts one MIME body part by `contentType` and optional `index`, and returns raw content with matching response content type when valid.
- **Get native device preview target availability**: Returns live native device preview target availability for authenticated API clients, including worker health, queue, timeout, and status fields.
- **Get operational email warmup activity and program progress**: Get operational email warmup activity and program progress
- **Get Opt In Identities**: Get Opt In Identities
- **Get or create a plus address by full address**: Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`.
- **Get or create a plus address by full address without inbox ID**: Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`.
- **Get or create phone pool**: Get a phone pool by name or create it if it does not exist
- **Get paginated list of bounced emails**: Bounced emails are email you have sent that were rejected by a recipient
- **Get paginated list of bounced recipients**: Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.
- **Get paginated list of complaints**: SMTP complaints made against your account
- **Get paginated list of reputation items**: List of complaints and bounces
- **Get paginated list of unsubscribed recipients**: Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
- **Get paginated webhooks for an Inbox**: Get paginated webhooks for an Inbox
- **Get paginated webhooks for a phone number**: Get paginated webhooks for a phone number
- **Get Phone Number Media By Id**: Get Phone Number Media By Id
- **Get Phone Number Media (GET /phone/media)**: Get Phone Number Media
- **Get Phone Number Media (GET /phone/{phoneNumberId}/media)**: Get Phone Number Media
- **Get phone number release**: Get a released or deleted phone numbers
- **Get phone numbers**: List phone numbers for account
- **Get phone number tags**: Get tags for a specific phone number
- **Get phone plans**: Get phone number plans
- **Get phone plans availability**: Get phone plans availability
- **Get phone pool**: Get phone pool details by ID
- **Get phone pool by name**: Get phone pool details by name
- **Get phone pools**: List phone pools for the authenticated user
- **Get phone provisioning capabilities**: Get supported provider-country variant capabilities for advanced provisioning
- **Get phone provisioning job**: Get advanced phone provisioning job status
- **Get phone summary**: Get overview of assigned phones
- **Get phone tags**: List all unique tags used by your phone numbers
- **Get pixel**: Get pixel
- **Get Postmaster connection status**: Get Postmaster connection status
- **Get provider-level progress for a device preview run**: Get provider-level progress for a device preview run
- **Get public inbox placement share analysis**: Get public inbox placement share analysis
- **Get public spam test results**: Returns public spam test run status and any available inbox placement results.
- **Get raw email in JSON. Unparsed SMTP message in JSON wrapper format**: Returns the original unparsed SMTP/MIME message wrapped in a JSON DTO for API clients that avoid plain-text stream responses.
- **Get raw email string. Returns unparsed raw SMTP message with headers and body**: Returns the original unparsed SMTP/MIME message as `text/plain`. Use JSON variant if your client expects JSON transport.
- **Get raw fake email content**: Retrieve the raw content of a fake email by its ID
- **Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format**: Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response
- **Get raw sent email string. Returns unparsed raw SMTP message with headers and body**: Returns a raw, unparsed, and unprocessed sent email.
- **Get reply for an SMS message**: Get reply for an SMS message.
- **Get results for all webhooks**: Get results for all webhooks
- **Get results of email sent with queues in paginated form**: Get results of email sent with queues in paginated form
- **Get Sent Delivery Status**: Get a sent email delivery status
- **Get Sent Delivery Statuses**: Get all sent email delivery statuses
- **Get Sent Delivery Statuses By Sent Id**: Get all sent email delivery statuses
- **Get sent email count in inbox**: Get sent email count in inbox
- **Get sent email HTML content**: Get sent email HTML content
- **Get sent email receipt**: Get sent email receipt
- **Get Sent Email Tracking Pixels**: Get all tracking pixels for a sent email in paginated form
- **Get sent email URL for viewing in browser or downloading**: Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
- **Get Sent Organization Emails**: Get all sent organization emails in paginated form
- **Get sent SMS content including body. Expects sent SMS to exist by ID**: Returns an SMS summary object with content.
- **Get sent SMS count**: Get number of sent SMS
- **Get SES tenant reputation findings**: Get SES tenant reputation recommendations/findings for this user.
- **Get SES tenant status summary**: Get SES tenant sending and reputation status rows for this user. Includes complaint and bounce rates from CloudWatch.
- **Get shared Delivery Sender capacity**: Get shared Delivery Sender capacity
- **Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController**: Returns a SMS summary object with content.
- **Get SMS count**: Get number of SMS
- **Get Sms Media**: Get Sms Media
- **Get Sms Media By Id**: Get Sms Media By Id
- **Get SMS prepaid credit**: Get a specific SMS prepaid credit balance for the authenticated account
- **Get SMS prepaid credits**: List SMS prepaid credits for the authenticated account
- **Get Smtp Access**: Get SMTP access usernames and passwords
- **Get SMTP and IMAP connection settings for common mail providers**: Get common mail provider SMTP and IMAP connection settings
- **Get status for mailbox**: Get status for mailbox
- **Get sub address plus address aliases for an inbox**: Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
- **Get sub address plus address by ID**: Returns a plus address object based on emails that used the inbox address with a +xyz alias.
- **Get sub address plus address for an inbox**: Returns a plus address object based on emails that used the inbox address with a +xyz alias.
- **Get template**: Get email template
- **Get template preview HTML**: Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.
- **Get template preview Json**: Get email template preview with passed template variables in JSON format. Pass template variables as query params.
- **Get Templates**: Get all templates
- **Get temporary device preview import address status**: Get temporary device preview import address status
- **Get Test Webhook Payload**: Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.
- **Get Test Webhook Payload Bounce**: Get webhook test payload for bounce
- **Get Test Webhook Payload Bounce Recipient**: Get webhook test payload for bounce recipient
- **Get Test Webhook Payload Email Opened**: Get webhook test payload for email opened event
- **Get Test Webhook Payload Email Read**: Get webhook test payload for email opened event
- **Get Test Webhook Payload For Webhook**: Get example payload for webhook
- **Get the latest message preview for a thread**: List message threads for a phone
- **Get the latest messages for all phones**: List all message threads for all phones
- **Get the original email content for a device preview run**: Get the original email content for a device preview run
- **Get the original email content for a device preview submission**: Get the original email content for a device preview submission
- **Get threads created for an alias**: Returns threads created for an email alias in paginated form
- **Get total inbox count**: Get total inbox count
- **Get tracking pixels**: List tracking pixels in paginated form
- **Get transformer mapping**: Get an AI transformer mapping
- **Get transformer mappings**: Get AI transformer mappings to other entities
- **Get transformer result**: Get AI transformer result
- **Get transformer results**: Get AI transformer results
- **Get transformer results table**: Get AI transformer results in table format
- **Get unread email count**: Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow.
- **Get unread SMS count**: Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response
- **Get User Info**: Get account information for your user
- **Get User Storage Insights**: Get retained storage usage insights for your account
- **Get Validation Requests**: List email verification requests
- **Get warmup readiness, adaptive pacing, and sender-health signals**: Get warmup readiness, adaptive pacing, and sender-health signals
- **Get webhook test payload for delivery status event**: Get webhook test payload for delivery status event
- **Get webhook test payload for new ai transform result event**: Get webhook test payload for new ai transform result event
- **Get webhook test payload for new attachment event**: Get webhook test payload for new attachment event
- **Get webhook test payload for new contact event**: Get webhook test payload for new contact event
- **Get webhook test payload for new email event**: Get webhook test payload for new email event
- **Get webhook test payload for new sms event**: Get webhook test payload for new sms event
- **Imap Server Update Flags**: Update message flags
- **Import email into inbox from base64 MIME**: Imports a raw RFC822/MIME email into the specified inbox regardless of the original `To` header.
- **Import email into inbox from multipart EML upload**: Imports an uploaded RFC822/MIME file into the specified inbox regardless of the original `To` header.
- **Import email into inbox from raw MIME bytes**: Imports a raw RFC822/MIME email stream into the specified inbox regardless of the original `To` header.
- **Invoke a transformer**: Execute an AI transformer to generate structured content
- **Is email address available**: Returns whether an email address is available
- **List account webhooks Paginated**: List account webhooks in paginated form. Allows for page index, page size, and sort direction.
- **List alert sinks for monitor**: List alert sinks for monitor
- **List All Inboxes Offset Paginated**: List inboxes in paginated form.
- **List All Inboxes Paginated**: List inboxes in paginated form.
- **List all inboxes with sent emails**: List inboxes that have sent emails
- **List attachment metadata for an email**: Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs).
- **List automated inbox placement schedules**: List automated inbox placement schedules
- **List automated inbox placement sender providers**: List automated inbox placement sender providers
- **List available public email render targets**: Returns the currently healthy target choices exposed by the free email render tool.
- **List campaign probe runs**: List campaign probe runs
- **List campaign probes**: List campaign probes
- **List device preview feedback**: List device preview feedback
- **List device preview folders**: List device preview folders
- **List device preview profiles**: List device preview profiles
- **List device preview runs created from account email domains**: List device preview runs created from account email domains
- **List device preview targets**: Returns visible native device preview target metadata without worker availability, queue, or health fields.
- **List domain monitor observed authentication samples**: List domain monitor observed authentication samples
- **List domain monitors**: List domain monitors
- **List email audits**: List email audits
- **List email drafts**: List saved email drafts for the authenticated user, optionally filtered by inbox.
- **List email threads in paginated form**: Lists conversation threads inferred from `Message-ID`, `In-Reply-To`, and `References`. Supports filtering by inbox, search text, and time range.
- **List email warmup programs**: List email warmup programs
- **List Gmail and Outlook placement checks for an email warmup program**: List Gmail and Outlook placement checks for an email warmup program
- **List inbox forwarders**: List all forwarders attached to an inbox
- **List inbox placement test runs**: List inbox placement test runs
- **List inbox repliers**: List all repliers attached to an inbox
- **List Inbox Retention Policies**: List inbox retention policies for your account
- **List inbox rulesets**: List all rulesets attached to an inbox
- **List inbox tracking pixels**: List all tracking pixels sent from an inbox
- **List load tests**: List load tests for the authenticated account.
- **List local Postmaster domain snapshots**: List local Postmaster domain snapshots
- **List messages in an inbox**: List messages in an inbox
- **List monitor runs**: List monitor runs
- **List non-secret execution events**: List non-secret execution events
- **List organization-visible emails**: Returns paginated emails visible through organization/team access. Supports inbox filtering, unread-only filtering, search, favourites, plus-address filtering, and optional connector sync.
- **List previous device preview runs for account**: List previous device preview runs for account
- **List previous device preview runs for account in paginated form**: List previous device preview runs for account in paginated form
- **List previous device preview runs for an email**: List previous device preview runs for an email
- **List previous device preview runs for an email in paginated form**: List previous device preview runs for an email in paginated form
- **List received device preview email submissions**: List received device preview email submissions
- **List records of expired inboxes**: Inboxes created with an expiration date will expire after the given date.
- **List rulesets block and allow lists**: List all rulesets attached to an inbox or phone or account
- **List scheduled email warmup slots**: List scheduled email warmup slots
- **List schedule executions**: List schedule executions
- **List sender connections**: List sender connections
- **List sending connection providers**: List sending connection providers
- **List sending connections**: List sending connections
- **List sent TXT messages for a phone number**: Get sent SMS messages for a phone number
- **List share links for a device preview run**: List share links for a device preview run
- **List SMS messages for a phone number**: Get SMS messages for a phone number
- **List supported message-testing AI models**: Discover enum model selectors, resolved provider models, evaluator versions and token multipliers. Pinned models never silently fall back.
- **List TOTP devices**: List Time-Based One-Time Password (TOTP) devices for the calling account.
- **List transformers**: List all AI transforms
- **List Webhooks endpoints Paginated**: List webhooks URL in paginated form. Allows for page index, page size, and sort direction.
- **List Webhooks Paginated**: List webhooks in paginated form. Allows for page index, page size, and sort direction.
- **Lookup a BIMI record policy**: Lookup a BIMI record policy
- **Lookup a DMARC record policy**: Lookup a DMARC record policy
- **Lookup a MTA-STS domain policy**: Lookup a MTA-STS domain policy
- **Lookup a MX records for a domain**: Lookup a MX records for a domain
- **Lookup and validate a DKIM record**: Lookup and validate a DKIM record
- **Lookup and validate an SPF record**: Lookup and validate an SPF record
- **Lookup a TLS reporting domain policy**: Lookup a TLS reporting domain policy
- **Lookup DNS records for a domain**: Lookup DNS records for a domain
- **Lookup DNS records for multiple domains**: Lookup DNS records for multiple domains
- **Lookup PTR records for an IP address**: Lookup PTR records for an IP address
- **Mark all emails as read or unread**: Sets read state for all emails, optionally scoped to one inbox. Use `read=false` to reset unread state in bulk.
- **Mark all SMS messages as read or unread**: Sets read state for all SMS messages, optionally scoped to a single phone number. Use `read=false` to reset unread state in bulk.
- **Mark an email as read or unread**: Sets read state for one email. Useful when implementing custom mailbox workflows that treat viewed messages as unread.
- **Mark an SMS as read or unread**: Sets read state for one SMS message. Useful when building custom inbox flows that need to restore unread state after inspection.
- **Mark a public email render test as submitted**: Records that the caller sent an email to the generated address so submission and delivery failures can be distinguished from setup abandonment.
- **Mark a public spam test as submitted**: Marks a previously created public spam test as submitted after the caller has sent the test email to the seed addresses.
- **Move device preview runs to a folder or Unfiled**: Move device preview runs to a folder or Unfiled
- **Parse and summarize a DMARC aggregate XML report**: Parse and summarize a DMARC aggregate XML report
- **Pause an email warmup program**: Pause an email warmup program
- **Pause deliverability simulation job**: Pause a running simulation job.
- **Pause load test**: Pause a RUNNING or SCHEDULED load test.
- **Persist aggregate email audit for a stored email**: Runs the aggregate audit bundle for the target email and stores the resulting audit record for later review and history tracking.
- **Poll load-test status**: Poll test progress. Evaluation is throttled with a 5-second cache window to protect backing data stores.
- **Prepare a direct-send inbox placement test without consuming allowance**: Reserve seed addresses for the dashboard create flow. The run remains staged and allowance is not committed until send confirmation. Reuses a recent active preparation when possible.
- **Query hydrated HTML body and return matching text lines**: Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines.
- **Read**: Read
- **Reassign phone number release**: Reassign phone number that was released or deleted
- **Redrive all webhook results that have failed status**: Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.
- **Release phone pool lease**: Release an active phone pool lease
- **Remove contacts from a group**: Remove contacts from a group
- **Remove expired inboxes**: Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
- **Remove phone number from phone pool**: Remove a phone number from a pool. If the number is leased from this pool the lease is released.
- **Remove phone number tags**: Remove one or more tags from a phone number
- **Rename or move a device preview folder**: Rename or move a device preview folder
- **Reply To Alias Email**: Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.
- **Reply To Email**: Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics.
- **Rerun selected device preview targets in the same run**: Set failedOnly=false to rerun a successful target. Successful targets consume their configured credit cost again.
- **Restore missed emails**: If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.
- **Resume an email warmup program**: Resume an email warmup program
- **Resume deliverability simulation job**: Resume a paused simulation job.
- **Retry a system-paused email warmup program**: Retry a system-paused email warmup program
- **Return account device preview email domain setup or create one**: Return account device preview email domain setup or create one
- **Return active run for email or create one when none exists**: Return active run for email or create one when none exists
- **Revoke a device preview share link**: Revoke a device preview share link
- **Revoke Opt In Consent For Email Address**: Revoke Opt In Consent For Email Address
- **Rotate sender connection credentials**: Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged.
- **Rotate sending connection credentials**: Verifies supported replacement credentials before atomically replacing the encrypted credential envelope.
- **Run a conservative SMTP connectivity, TLS, and AUTH diagnostic**: Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
- **Run aggregate email audit for a stored email**: Runs the same message-level audit bundle used by the email audit dashboard in one request.
- **Run an automated inbox placement schedule now**: Run an automated inbox placement schedule now
- **Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check**: Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
- **Run a one-shot free campaign probe preflight check**: Run a one-shot free campaign probe preflight check
- **Run a one-shot free domain monitor posture check**: Run a one-shot free domain monitor posture check
- **Run a one-shot free email audit across links, images, HTML, and client support**: Run a one-shot free email audit across links, images, HTML, and client support
- **Run campaign probe now**: Run campaign probe now
- **Run due campaign probes for user**: Run due campaign probes for user
- **Run due monitors for user**: Run due monitors for user
- **Run monitor now**: Run monitor now
- **Run regex against hydrated email body and return matches**: Executes a Java regex pattern over hydrated email body text and returns the full match plus capture groups. Pattern syntax follows Java `Pattern` rules.
- **Search all inboxes and return matching inboxes**: Search inboxes and return in paginated form.
- **Search Audit Logs**: Search Audit Logs
- **Search available phone numbers**: Search available numbers for advanced provisioning
- **Search for an inbox with the given name**: Get a inbox result by name
- **Search for an inbox with the provided email address**: Get a inbox result by email address
- **Search messages in an inbox**: Search messages in an inbox
- **Send an email**: If no senderId or inboxId provided a random email address will be used to send from.
- **Send an email draft**: Send a saved draft using the existing inbox send pipeline. The draft is deleted only after the send succeeds.
- **Send an email from an alias inbox**: Send an email from an alias. Replies to the email will be forwarded to the alias masked email address
- **Send an email using query parameters**: If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.
- **Send an unbilled delivery test to a temporary MailSlurp inbox**: Uses only the selected customer-owned connection. A successful receipt proves provider acceptance and delivery to MailSlurp, not Gmail or Outlook placement.
- **Send a reply to a received SMS message. Replies are sent from the receiving number**: Reply to an SMS message.
- **Send a test email to inbox**: Send an inbox a test email to test email receiving is working
- **Send a verification code to a user once they have explicitly submitted their email address**: Send double-opt in consent for an email address
- **Send email**: Sends an email from an existing inbox, or creates a temporary inbox when `inboxId` is not provided. Supports `useDomainPool` and `virtualSend` inbox creation behavior for convenience sends.
- **Send Email**: Send an email from an inbox's email address.
- **Send email and return sent confirmation**: Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
- **Send email using an SMTP mail envelope and message body and return sent confirmation**: Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
- **Send email with queue**: Send an email using a queue.
- **Send email with with delay or schedule**: Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.
- **Send from an inbox connector**: Send from an inbox connector
- **Send Sms**: Send Sms
- **Send SMTP envelope from an S3 body reference**: Internal SMTP-server endpoint for sending an SMTP envelope whose RFC822 body has already been written to S3.
- **Send SMTP envelope from a streamed body**: Internal SMTP-server endpoint for sending an SMTP envelope while streaming the RFC822 body in the request.
- **Send TXT message from a phone number**: Send SMS from a phone number
- **Send webhook test data**: Send webhook test data
- **Set consent status**: Give or revoke consent for phone usage
- **Set email favourited state**: Sets favourite state for an email for dashboard/search workflows.
- **Set IMAP flags associated with a message. Only supports '\Seen' flag**: Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the `\\Seen` flag only.
- **Set inbox favourited state**: Set and return new favorite state for an inbox
- **Set phone favourited state**: Set and return new favorite state for a phone
- **Set phone number tags**: Replace all tags on a phone number
- **Set Sms Favourited**: Set Sms Favourited
- **Start an email warmup program**: Start an email warmup program
- **Start or resume load test**: Start a CREATED test or resume a PAUSED/SCHEDULED test.
- **Stop an email warmup program**: Stop an email warmup program
- **Stop load test**: Stop a load test and mark it terminal.
- **Submit a form to be parsed and sent as an email to an address determined by the form fields**: This endpoint allows you to submit HTML forms and receive the field values and files via email.
- **Submit an EML file to a public email render test**: Submit an EML file to a public email render test
- **Submit HTML to a public email render test**: Submit HTML to a public email render test
- **Sync an inbox connector**: Sync an inbox connector
- **Sync Postmaster domains**: Sync Postmaster domains
- **Sync Postmaster traffic stats**: Sync Postmaster traffic stats
- **Take a screenshot of an email in a browser**: Renders the email in a browser engine and returns PNG bytes. Intended for visual QA and rendering regression checks.
- **Take a screenshot of an email in a browser and return base64 encoded string**: Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses.
- **Test an inbox connector IMAP connection**: Test the IMAP connection for a connector
- **Test an inbox connector IMAP connection options**: Test the IMAP connection options for a connector
- **Test an inbox connector SMTP connection**: Test the SMTP connection for a connector
- **Test an inbox connector SMTP connection options**: Test the SMTP connection options for a connector
- **Test an inbox forwarder**: Test an inbox forwarder
- **Test a ruleset**: Test an inbox or phone ruleset
- **Test inbox forwarders for inbox**: Test inbox forwarders for inbox
- **Test inbox rulesets for inbox**: Test inbox rulesets for inbox
- **Test new inbox forwarder**: Test new inbox forwarder
- **Test new ruleset**: Test new ruleset
- **Test receiving with rulesets**: Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS
- **Test sending an SMS to a number**: Test a phone number by sending an SMS to it. NOTE this is only for internal use to check that a phone number is working. For end-to-end phone testing see https://docs.mailslurp.com/txt-sms/
- **Test sending with rulesets**: Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS
- **Test transformer mapping match result**: Evaluate transform mapping match conditions for given email, sms, or attachment
- **Update account device preview email subdomain**: Update account device preview email subdomain
- **Update a device preview profile**: Update a device preview profile
- **Update a domain**: Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.
- **Update a draft email warmup program**: Update a draft email warmup program
- **Update an automated inbox placement schedule**: Update an automated inbox placement schedule
- **Update an email alias**: Update an email alias
- **Update an email draft**: Replace the SendEmailOptions stored for a draft. The draft remains attached to its original inbox; create a new draft to use a different inbox.
- **Update an inbox connector**: Update an inbox connector
- **Update an inbox connector IMAP connection**: Update IMAP connection for external inbox
- **Update an inbox connector SMTP connection**: Update SMTP connection for external inbox
- **Update an inbox forwarder**: Update inbox forwarder
- **Update an inbox replier**: Update inbox ruleset
- **Update an inbox replier's active state**: Enable or disable an inbox replier without changing its other settings
- **Update a phone number**: Set field for phone number
- **Update a ruleset**: Update a ruleset's active state
- **Update a sender connection**: Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings.
- **Update a sending connection**: Updates non-secret connection metadata. Use the credentials endpoint to replace supported SMTP or API-key credentials.
- **Update a TOTP device**: Update stored metadata and TOTP settings for a device by ID.
- **Update a webhook**: Update a webhook
- **Update a webhook request headers**: Update a webhook request headers
- **Update campaign probe**: Update campaign probe
- **Update device preview feedback**: Update device preview feedback
- **Update domain monitor**: Update domain monitor
- **Update Imap Access**: Update IMAP access usernames and passwords
- **Update Inbox. Change name and description. Email address is not editable**: Update editable fields on an inbox
- **Update Inbox Retention Policy**: Update an inbox retention policy for your account
- **Update load test**: Update metadata, timeout, and expectations for a non-running non-terminal test.
- **Update phone pool**: Update phone pool metadata such as name or description
- **Update purchased Delivery Sender seats**: Update purchased Delivery Sender seats
- **Update purchased email warmup sender seats**: Update purchased email warmup sender seats
- **Update Smtp Access**: Update SMTP access usernames and passwords
- **Update template**: Update email template
- **Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment**: Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
- **Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment**: Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
- **Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment**: Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
- **Validate Email Address List**: Verify a list of email addresses is valid and can be contacted.
- **Validate email HTML contents**: Runs HTML validation on the email body when HTML is present. Non-HTML emails are treated as valid for this check.
- **Validate structured content schema**: Check if a schema is valid and can be used to extract data using AI
- **Verify a sender connection**: Verify a sender connection
- **Verify a sending connection**: Verifies the customer credential without enabling billable sender capacity. A consuming product enables the shared Delivery Sender seat when sending starts.
- **Verify a webhook payload signature**: Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.
- **Verify validity of a phone number**: Validate a phone number
- **Wait for all named email and SMS expectations under one shared deadline and AI token budget**: Wait for all named email and SMS expectations under one shared deadline and AI token budget. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request.
- **Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs**: If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
- **Wait for an email to match the provided filter conditions such as subject contains keyword**: Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
- **Wait for an SMS message to match the provided filter conditions such as body contains keyword**: Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met
- **Wait For Delivery Statuses**: Wait for delivery statuses
- **Wait for device preview runs created from account email domains**: Wait for device preview runs created from account email domains
- **Wait for device preview run to complete**: Wait for device preview run to complete
- **Wait For Message AI**: Wait-controller alias of the AI message wait. Shares the same contract, billing, deadline, source authorization and Idempotency-Key namespace.
- **Wait For Messages AI**: Wait-controller alias of the AI message wait. Shares the same contract, billing, deadline, source authorization and Idempotency-Key namespace.
- **Wait for Nth missed email**: Wait for 0 based index missed email
- **Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur**: If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
- **Wait for or return the first email that matches provided MatchOptions array**: Perform a search of emails in an inbox with the given patterns.
- **Wait for received device preview email submissions**: Wait for received device preview email submissions
- **Wait for the latest SMS message to match the provided filter conditions such as body contains keyword**: Wait until a phone number meets given conditions or return immediately if already met
- **Wait for webhook results for a webhook**: Wait for webhook results for a webhook
- **Wait or return list of emails that match simple matching patterns**: Perform a search of emails in an inbox with the given patterns.

Connect MailSlurp in General Input: https://www.generalinput.com/apps/mailslurp