MailSlurp API reference

Delete all inboxes

Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.

List Inboxes and email addresses

List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.

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. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.

Delete inbox

Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.

Get Inbox. Returns properties of an inbox.

Returns an inbox's properties, including its email address and ID.

Update Inbox. Change name and description. Email address is not editable.

Update editable fields on an inbox

Send Email

Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.

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.

Delete all emails in a given inboxes.

Deletes all emails in an inbox. Be careful as emails cannot be recovered

getDeliveryStatusesByInboxId

Get all email delivery statuses for an inbox

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. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached

Get email count in inbox

Import email into inbox from base64 MIME

Imports a raw RFC822/MIME email into the specified inbox regardless of the original `To` header. V1 accepts MIME-family formats such as `.eml`, `message/rfc822`, and raw MIME bytes only. Outlook `.msg`, `mbox`, and `maildir` are not supported in V1. By default MailSlurp rewrites the MIME `Message-ID` header to avoid imported message identity clashes. Set `runPipeline=true` to run the normal inbound receive pipeline after persistence.

Import email into inbox from multipart EML upload

Imports an uploaded RFC822/MIME file into the specified inbox regardless of the original `To` header. Intended for `.eml` uploads and other MIME-family raw email files. V1 does not support Outlook `.msg`, `mbox`, or `maildir`. By default MailSlurp rewrites the MIME `Message-ID` header to avoid imported message identity clashes.

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. Supports `message/rfc822` and `application/octet-stream`. V1 does not support Outlook `.msg`, `mbox`, or `maildir`. By default MailSlurp rewrites the MIME `Message-ID` header to avoid imported message identity clashes.

Get inbox emails paginated

Get a paginated list of emails in an inbox. Does not hold connections open.

Set inbox favourited state

Set and return new favorite state for an inbox

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 for an inbox

Returns a plus address object based on emails that used the inbox address with a +xyz alias.

Get emails for a given inbox plus address

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 emails for a given inbox plus address

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 or create a plus address by full address

Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.

List inbox rulesets

List all rulesets attached to an inbox

Create an inbox ruleset

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Get all scheduled email sending jobs for the inbox

Schedule sending of emails using scheduled jobs.

Send a test email to inbox

Send an inbox a test email to test email receiving is working

Get Inbox Sent Emails

Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.

Get sent email count in inbox

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 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.

List inbox tracking pixels

List all tracking pixels sent from an inbox

Send email with queue

Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.

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.

Does inbox have automations

Check if an inbox has automations.

Is email address available

Returns whether an email address is available

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

Search for an inbox with the provided email address

Get a inbox result by email address

Search for an inbox with the given name

Get a inbox result by name

Get total inbox count

Does inbox exist

Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses

Remove expired inboxes

Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)

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`. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.

Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.

Get the newest email in an inbox or wait for one to arrive

Get all inbox IDs

Get list of inbox IDs

getImapAccess

Get IMAP access usernames and passwords

updateImapAccess

Update IMAP access usernames and passwords

getImapSmtpAccess

Get IMAP and SMTP access usernames and passwords

getImapSmtpAccessEnv

Get IMAP and SMTP access details in .env format

getImapSmtpAccessServers

Get IMAP and SMTP server hosts

List All Inboxes Offset Paginated

List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.

List Organization Inboxes Paginated

List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).

List all inboxes with sent emails

List inboxes that have sent emails

List All Inboxes Paginated

List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.

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 sub address plus address by ID

Returns a plus address object based on emails that used the inbox address with a +xyz alias.

Get all scheduled email sending jobs for account

Schedule sending of emails using scheduled jobs. These can be inbox or account level.

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.

Get a scheduled email job

Get a scheduled email job details.

Search all inboxes and return matching inboxes

Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.

getSmtpAccess

Get SMTP access usernames and passwords

updateSmtpAccess

Update SMTP access usernames and passwords

Get inbox tags

Get all inbox tags

Get inboxes for a tag

Get all inboxes for a given inbox tag

Get inbox tags paginated

Get all inbox tags paginated

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.

Delete all emails in all inboxes.

Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone.

Get all emails in all inboxes in paginated form. Email API list all.

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.

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.

Delete an email

Deletes a single email from account scope. Operation is destructive and not reversible.

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.

Reply to an email

Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics.

List attachment metadata for an email

Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs).

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 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 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).

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.

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.

Run aggregate email audit for a stored email

Runs the same message-level audit bundle used by the email audit dashboard in one request. Combines content checks, HTML validation, compatibility analysis, and reputation verdict rollup when available.

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 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.

Extract verification codes from an email

Extracts one-time passcodes and similar tokens from email content using the selected extraction method and fallback options.

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.

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 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.

Set email favourited state

Sets favourite state for an email for dashboard/search workflows.

Forward email to recipients

Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options.

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.

Query hydrated HTML body and return matching text lines

Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines.

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.

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.

Get deprecated server-normalized email preview HTML

Returns a server-normalized preview document with active content removed and restrictive browser metadata. This representation can normalize malformed email layout and is deprecated for fidelity-sensitive rendering. Fetch the original HTML source and apply link hardening inside an opaque-origin browser sandbox instead.

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 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.

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.

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.

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.

Extract signature from an inbound email

Attempts to parse a sender signature block from an email body. Uses raw MIME content parts when possible and falls back to hydrated body parsing. This is heuristic and may not be accurate for all email clients or formats.

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.

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.

Get email URLs for viewing in browser or downloading

Returns precomputed URLs for preview and raw message access for the specified email.

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.

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.

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.

List email drafts

List saved email drafts for the authenticated user, optionally filtered by inbox.

Create an email draft

Create a saved email draft using the same SendEmailOptions shape used for sending. Provide an inboxId query parameter or sendOptions.inboxId to choose the inbox the draft will send from. Draft creation does not send email and does not create a new inbox.

Delete an email draft

Delete a saved email draft without sending it.

Get an email draft

Get a saved email draft including the full SendEmailOptions payload.

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.

Send an email draft

Send a saved draft using the existing inbox send pipeline. The draft is deleted only after the send succeeds.

Get email count

Returns total email count for the authenticated user, or count scoped to a specific inbox when `inboxId` is provided.

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 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 an inbox. Use `WaitForController` to get emails that may not have arrived yet.

Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.

Get all emails in all inboxes in paginated form. Email API list all.

Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs.

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.

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.

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.

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.

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 messages in a specific email thread

Returns all messages in a thread ordered by `createdAt` using the requested sort direction.

Get unread email count

Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow.

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 AI-matched email or SMS

Wait-controller alias of the AI message wait. Shares the same contract, billing, deadline, source authorization and Idempotency-Key namespace.

Wait for AI-matched email or SMS

Wait-controller alias of the AI message wait. Shares the same contract, billing, deadline, source authorization and Idempotency-Key namespace.

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.

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. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.

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 or return list of emails that match simple matching patterns

Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Wait for or return the first email that matches provided MatchOptions array

Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

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 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

Delete all SMS messages

Delete all SMS messages or all messages for a given phone number

getAllSmsMessages

Delete SMS message.

Delete an SMS message

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.

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.

setSmsFavourited

getSmsMedia

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.

Get reply for an SMS message

Get reply for an SMS message.

Send a reply to a received SMS message. Replies are sent from the receiving number.

Reply to an SMS message.

Get SMS count

Get number of SMS

getSmsMediaById

downloadSmsMediaBase64

downloadSmsMedia

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.

sendSms

Delete all sent SMS messages

Delete all sent SMS messages or all messages for a given phone number

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. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Delete sent SMS message.

Delete a sent SMS message

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 unread SMS count

Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

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

getPhoneNumberMedia

Get consent status

Get the status of phone usage consent

Set consent status

Give or revoke consent for phone usage

Get emergency addresses

List emergency addresses

Create an emergency address

Add an emergency address to a phone number

Delete an emergency address

Delete an emergency address

Get an emergency address

Fetch an emergency address by ID

getPhoneNumberMedia_1

getPhoneNumberMediaById

downloadPhoneNumberMediaBase64

downloadPhoneNumberMedia

Delete all phone numbers

Remove all phone number from account

Get phone numbers

List phone numbers for account

Delete a phone number

Remove phone number from account

Get a phone number by ID

Get a phone number by ID

Update a phone number

Set field for phone number

Set phone favourited state

Set and return new favorite state for a phone

Get the latest message preview for a thread

List message threads for a phone

Delete messages in a phone thread

Delete all messages in an SMS thread

Get messages in a phone thread

List message thread messages for a phone message thread

List SMS messages for a phone number

Get SMS messages for a phone number

Send TXT message from a phone number

Send SMS from a phone number

List sent TXT messages for a phone number

Get sent SMS messages for a phone number

Remove phone number tags

Remove one or more tags from a phone number

Get phone number tags

Get tags for a specific phone number

Add phone number tags

Add one or more tags to a phone number

Set phone number tags

Replace all tags on a phone number

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 /docs/txt-sms/

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

Export phone numbers CSV

Download all active phone numbers for account as CSV

Get the latest messages for all phones

List all message threads for all phones

Get phone plans

Get phone number plans

Get phone plans availability

Get phone pools

List phone pools for the authenticated user

Create phone pool

Create a reusable pool of phone numbers for coordinated leasing

Delete phone pool

Delete a phone pool and release any active leases from that pool

Get phone pool

Get phone pool details by ID

Update phone pool

Update phone pool metadata such as name or description

Acquire phone pool lease

Acquire an available phone number from the pool and mark it leased

Release phone pool lease

Release an active phone pool lease

Add phone numbers to phone pool

Add one or more owned phone numbers to a pool

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.

Add all phone numbers to phone pool

Add all active owned phone numbers to a pool

Get phone pool by name

Get phone pool details by name

Get or create phone pool

Get a phone pool by name or create it if it does not exist

Get phone provisioning capabilities

Get supported provider-country variant capabilities for advanced provisioning

Create a phone provisioning job

Create an advanced phone provisioning job from shortlisted numbers

Get phone provisioning job

Get advanced phone provisioning job status

Search available phone numbers

Search available numbers for advanced provisioning

Get all phone number releases

List released or deleted phone numbers

Get phone number release

Get a released or deleted phone numbers

Reassign phone number release

Reassign phone number that was released or deleted

Get SMS prepaid credits

List SMS prepaid credits for the authenticated account

Get SMS prepaid credit

Get a specific SMS prepaid credit balance for the authenticated account

Get phone summary

Get overview of assigned phones

Get phone tags

List all unique tags used by your phone numbers

Verify validity of a phone number

Validate a phone number

Get line type intelligence for a phone number

Lookup line type intelligence for a phone number

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.

Get all webhooks for an Inbox

Attach a WebHook URL to an inbox

Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

Delete and disable a Webhook for an Inbox

Get paginated webhooks for an Inbox

Get paginated webhooks for a phone number

Attach a WebHook URL to a phone number

Get notified whenever a phone number receives an SMS via a WebHook URL.

Delete all webhooks

Attach a WebHook URL to an inbox

Get notified of account level events such as bounce and bounce recipient.

Delete a webhook

Get a webhook

Update a webhook

getTestWebhookPayloadForWebhook

Get example payload for webhook

Update a webhook request headers

Get a webhook results for a webhook

Get a webhook results count for a webhook

getJsonSchemaForWebhookPayload

Get JSON Schema definition for webhook payload

Send webhook test data

Wait for webhook results for a webhook

List account webhooks Paginated

List account webhooks in paginated form. Allows for page index, page size, and sort direction.

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.

Get results for all webhooks

Get a webhook result for 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. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

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.

Get count of unseen webhook results with error status

getJsonSchemaForWebhookEvent

Get JSON Schema definition for webhook payload by event

getTestWebhookPayload

Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.

Get webhook test payload for delivery status event

getTestWebhookPayloadBounce

Get webhook test payload for bounce

getTestWebhookPayloadBounceRecipient

Get webhook test payload for bounce recipient

getTestWebhookPayloadEmailOpened

Get webhook test payload for email opened event

getTestWebhookPayloadEmailRead

Get webhook test payload for email opened 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 contact event

Get webhook test payload for new email event

Get webhook test payload for new sms event

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.

Get domains

List all custom domains you have created

Create Domain

Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

Delete a domain

Delete a domain. This will disable any existing inboxes that use this domain.

Get a domain

Returns domain verification status and tokens for a given domain

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.

Get domain health events

List recent health events for a custom domain using MailSlurp domain-health terminology.

Get catch all wild card inbox for domain

Get the catch all inbox for a domain for missed emails

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

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 all usable domains

List all domains available for use with email address creation

Get domain issues

List domain issues for domains you have created

Get MailSlurp domains

List all MailSlurp domains used with non-custom email addresses

Get all email aliases you have created

Get all email aliases in paginated form