Integration · Email
Connect Claude & ChatGPT to MailSlurp
Ask your AI to create a test inbox, wait for a signup email and pull out the verification code. It can create and update inboxes, read, search and forward emails, get links and attachments, send and reply from your inboxes, and keep contacts. That helps when you test email flows or handle mail in separate inboxes.
Connect MailSlurp free
Free plan, no credit card. Takes about a minute.
Try asking
“Create a new inbox for testing our signup flow.”
The AI creates an inbox with a real email address and gives you the address.
“Wait for the confirmation email in that inbox and give me the code.”
It waits for the latest email to arrive, then extracts the verification code from it.
“What is the password reset link in the last email?”
It lists the links found in the email, such as the reset link.
What your AI can do
Inboxes
Create inboxes with real email addresses, find one by address, list, read and update them, and count unread emails.
Reading and waiting
Wait for new emails, search and read them, and pull out verification codes, links and attachments.
Sending and contacts
Send, reply to and forward emails from your inboxes, read sent emails, and keep contacts and templates at hand.
“Send a test email from my QA inbox to [email protected].”
It sends the email from your inbox with subject and body. The email goes out immediately.
“Search all my inboxes for emails that mention invoice.”
It searches received emails across your inboxes and lists the matches.
“Download the PDF attachment on the latest email.”
It lists the attachments on the email and downloads the one you want.
814 tools for MailSlurp
These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.
add_an_internal_conversation_noteChanges dataCreate a new message for a message. Required: body. Search messages first to avoid duplicates. API summary: Add an internal conversation note.add_an_internal_sms_conversation_noteVisible to othersCreate a new message for a message. Required: body. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Add an internal SMS conversation note.approve_addressVisible to othersConfirm a address (inbox id). Has effects visible outside this system. API summary: Send email and return sent confirmation.approve_inbox_placement_test_sentVisible to othersConfirm a inbox placement test (inbox placement test id). Has effects visible outside this system. API summary: Confirm an inbox placement test email has been sent.cancel_a_scheduled_email_jobDeletesCancel a project (job id). Destructive action; may require approval. API summary: Cancel a scheduled email job.cancel_addressDeletesCancel a address (run id). Destructive action; may require approval. API summary: Cancel a running device preview run.cancel_projectDeletesCancel a project (job id). Destructive action; may require approval. API summary: Cancel deliverability simulation job.cancel_purchased_email_warmup_sender_seatsMoves moneyPermanently delete a message. Financial or irreversible action; may require approval. API summary: Cancel purchased email warmup sender seats.create_accountChanges dataCreate a new account. Required: retention days.create_account_auth_v2_account_switchChanges dataCreate a new account. API summary: Switch the account bound to an Auth v2 session.create_addressChanges dataCreate a new address. Required: customer name, address1, city, region, postal code or iso country code. Search addresses first to avoid duplicates. API summary: Create an emergency address.create_address_bulk_create_inboxesVisible to othersCreate a new address. Required: count. Search addresses first to avoid duplicates. Has effects visible outside this system. API summary: Bulk create Inboxes (email addresses).create_address_createChanges dataCreate a new address. Search addresses first to avoid duplicates. API summary: Create new random inbox.create_address_draftVisible to othersCreate a new draft for a address. Has effects visible outside this system. API summary: Create a scoped email draft for an agent.create_address_rulesetChanges dataCreate a new ruleset for a address. Required: scope, action or target. Search rulesets first to avoid duplicates. API summary: Create an inbox ruleset.create_address_share_linkChanges dataCreate a new share link for a address. API summary: Create a share link for a device preview run.create_address_webhookDeletesCreate a new webhook for a address. Required: url. Destructive action; may require approval. API summary: Attach a WebHook URL to an inbox.create_ai_transformer_webhookDeletesCreate a new webhook for a ai transformer. Required: url. Destructive action; may require approval. API summary: Attach a WebHook URL to an AI transformer.create_aliasChanges dataCreate a new alias. Required: email address or use threads. Search aliases first to avoid duplicates. API summary: Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address.create_an_agent_managed_totp_device_from_custom_optionsChanges dataCreate a new custom. Required: secret. API summary: Create an agent-managed TOTP device from custom options.create_an_email_draftVisible to othersCreate a new message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Create an email draft.create_an_email_warmup_programVisible to othersCreate a new message. Required: name, connection id, customer intent, current daily volume, goal daily volume or schedule preset. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Create an email warmup program.create_an_inbox_connector_with_optionsChanges dataCreate a new with option. Required: create connector options. API summary: Create an inbox connector with options.create_an_inbox_with_an_account_wide_inbox_manager_connectionChanges dataCreate a new address. Search addresses first to avoid duplicates. API summary: Create an inbox with an account-wide inbox-manager connection.create_analyze_dmarc_reportChanges dataCreate a new analyze dmarc report. Required: report xml. API summary: Parse and summarize a DMARC aggregate XML report.create_analyze_email_headerVisible to othersCreate a new analyze email header. Required: raw headers. Has effects visible outside this system. API summary: Analyze email headers for auth results and delivery path.create_availableVisible to othersCreate a new available. Required: email address. Has effects visible outside this system. API summary: Is email address available.create_base32_secret_keyChanges dataCreate a new base32 secret key. Required: base32 secret key. API summary: Create a TOTP device from an base32 secret key.create_base32_secret_key_agent_create_totp_device_for_base32_secChanges dataCreate a new base32 secret key. Required: base32 secret key. API summary: Create an agent-managed TOTP device from a base32 secret key.create_bootstrapChanges dataCreate a new bootstrap. API summary: Bootstrap an existing Auth v2 session.create_can_sendVisible to othersCreate a new can send. Required: inbox id. Has effects visible outside this system. API summary: Check whether an email send would be accepted.create_checkVisible to othersCreate a new check. Required: recipients. Has effects visible outside this system. API summary: Check whether sending rules allow recipients.create_check_campaign_probeChanges dataCreate a new check campaign probe. API summary: Run a one-shot free campaign probe preflight check.create_check_dns_propagationChanges dataCreate a new check dns propagation. Required: host or record type. API summary: Check DNS propagation for a host and record type across configured resolvers.create_check_domain_monitorChanges dataCreate a new check domain monitor. Required: domain. API summary: Run a one-shot free domain monitor posture check.create_check_email_auditVisible to othersCreate a new check email audit. Has effects visible outside this system. API summary: Run a one-shot free email audit across links, images, HTML, and client support.create_check_email_auth_stackVisible to othersCreate a new check email auth stack. Required: domain. Has effects visible outside this system. API summary: Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check.create_check_email_blacklistVisible to othersCreate a new check email blacklist. Has effects visible outside this system. API summary: Check whether a domain or IP appears on configured DNS blacklists.create_check_email_features_client_supportVisible to othersCreate a new check email features client support. Required: email body. Has effects visible outside this system. API summary: Check email client support for email HTML and CSS features.create_connectChanges dataCreate a new connect. API summary: Create Postmaster OAuth connection URL.create_connectionChanges dataCreate a new connection. Required: name, provider or from email. API summary: Create an encrypted sender connection.create_connection_credentialChanges dataCreate a new credential for a connection. Required: smtp. API summary: Rotate sender connection credentials.create_connectorChanges dataCreate a new connector. API summary: Create an inbox connector.create_connector_imapChanges dataCreate a new imap for a connector. Required: imap host. API summary: Create an inbox connector IMAP connection.create_connector_smtpChanges dataCreate a new smtp for a connector. Required: smtp host. API summary: Create an inbox connector SMTP connection.create_consentChanges dataCreate a new consent. Required: agree. API summary: Set consent status.create_contactChanges dataSave a new contact with `first_name`, `last_name`, `company`, `email_addresses`, optional `tags` and `group_id`.create_contact_ai_transform_result_payloadChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: Get webhook test payload for new ai transform result event.create_contact_attachment_payloadChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: Get webhook test payload for new attachment event.create_contact_contact_payloadChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: Get webhook test payload for new contact event.create_contact_email_payloadChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: Get webhook test payload for new email event.create_contact_sms_payloadChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: Get webhook test payload for new sms event.create_contact_test_connector_imap_connectionChanges dataCreate a new contact. Required: imap host. Search contacts first to avoid duplicates. API summary: Test an inbox connector IMAP connection.create_contact_test_connector_imap_connection_optionsChanges dataCreate a new contact. Required: imap host. Search contacts first to avoid duplicates. API summary: Test an inbox connector IMAP connection options.create_contact_test_connector_smtp_connectionChanges dataCreate a new contact. Required: smtp host. Search contacts first to avoid duplicates. API summary: Test an inbox connector SMTP connection.create_contact_test_connector_smtp_connection_optionsChanges dataCreate a new contact. Required: smtp host. Search contacts first to avoid duplicates. API summary: Test an inbox connector SMTP connection options.create_customChanges dataCreate a new custom. Required: secret. API summary: Create a TOTP device from custom options.create_deliverabilityChanges dataCreate a new deliverability. Required: scope, selector or expectations. API summary: Create load test.create_deliverability_pauseChanges dataCreate a new pause for a deliverability. API summary: Pause load test.create_deliverability_projectChanges dataCreate a new project for a deliverability. API summary: Create deliverability simulation job.create_deliverability_startChanges dataCreate a new start for a deliverability. API summary: Start or resume load test.create_deliverability_stopChanges dataCreate a new stop for a deliverability. API summary: Stop load test.create_device_render_testChanges dataCreate a new device render test. Required: preview mode. API summary: Create a public email render test.create_dns_lookupChanges dataCreate a new dns lookup. Required: lookups. API summary: Lookup DNS records for multiple domains.create_dns_lookup_get_dns_lookupChanges dataCreate a new dns lookup. Required: hostname, record types or omit final dns dot. API summary: Lookup DNS records for a domain.create_documentChanges dataCreate a new document for a document. API summary: Extract text from an attachment.create_document_agent_extract_email_attachment_textVisible to othersCreate a new document for a document. Has effects visible outside this system. API summary: Extract text from a scoped email attachment for an agent.create_document_generate_structured_content_from_attachmentChanges dataCreate a new document. Required: attachment id. API summary: Generate structured content for an attachment.create_domainChanges dataCreate a new domain. Required: domain. API summary: Get DNS Mail Server records for a domain.create_domain_create_domainChanges dataCreate a new domain. Required: domain. API summary: Create Domain.create_domain_wildcardChanges dataCreate a new wildcard for a domain. API summary: Add catch all wild card inbox to domain.create_email_auditVisible to othersEmail a message. Has effects visible outside this system. API summary: Create email audit.create_environment_switchChanges dataCreate a new switch for a environment. API summary: Switch the environment bound to an Auth v2 session.create_exportChanges dataCreate a new export. Required: export type or output format. API summary: Get export link.create_feedbackChanges dataCreate a new feedback. Required: source or category. Search feedback first to avoid duplicates. API summary: Create device preview feedback.create_fetchChanges dataCreate a new fetch. Required: seq num. API summary: Fetch message in an inbox.create_filter_recipientChanges dataCreate a new filter recipient. Required: email recipients. API summary: Filter a list of email recipients and remove those who have bounced.create_forwarderChanges dataCreate a new forwarder. Required: forward to recipients. Search forwarders first to avoid duplicates. API summary: Create an inbox forwarder.create_forwarder_testChanges dataCreate a new test for a forwarder. API summary: Test an inbox forwarder.create_free_inboxChanges dataCreate a new free inbox. Required: captcha token.create_generate_bimi_recordChanges dataCreate a new generate bimi record. Required: domain, version or logo url. API summary: Create a BIMI record policy.create_generate_dmarc_recordChanges dataCreate a new generate dmarc record. Required: domain, version or policy. API summary: Create a DMARC record policy.create_generate_mta_sts_recordChanges dataCreate a new generate mta sts record. Required: host, version, mode, ttl, max age seconds or mx records. API summary: Create a TLS reporting record policy.create_generate_spf_recordChanges dataCreate a new generate spf record. Required: domain, mx, a or all policy. API summary: Create an SPF record.create_generate_tls_reporting_recordChanges dataCreate a new generate tls reporting record. Required: reporting addresses, host, version or ttl. API summary: Create a TLS reporting record policy.create_getChanges dataCreate a new get. Required: email id. API summary: Get a message by email ID.create_groupChanges dataCreate a new group. Required: name. Search groups first to avoid duplicates. API summary: Create a group.create_guest_portalChanges dataCreate a new guest portal. API summary: Create a portal page for your customers or clients to log into email accounts and view emails.create_guest_portal_userChanges dataCreate a new user for a guest portal. Search users first to avoid duplicates. API summary: Create a portal guest user.create_heartbeatChanges dataCreate a new heartbeat. Required: worker id or instance id. API summary: Report a worker heartbeat.create_htmlChanges dataCreate a new html. Required: html. API summary: Create a device preview run from HTML.create_inboxChanges dataCreate a new inbox with a real email address. Optional: `name`, `description`, `tags`, a custom `email_address` or `prefix`, `inbox_type` and an expiry (`expires_at` or `expires_in`).create_inbox_placement_testChanges dataCreate a new inbox placement test. Required: requested segment, public share requested or address format. API summary: Create a new direct-send inbox placement test.create_inbox_retention_policyChanges dataCreate a new inbox retention policy. Required: scope, retention days, enabled, excluded inbox ids, excluded domain ids or excluded inbox email address patterns.create_invokeChanges dataCreate a new invoke. API summary: Invoke a transformer.create_line_type_intelligenceChanges dataCreate a new line type intelligence. Required: phone number. API summary: Get line type intelligence for a phone number.create_listChanges dataCreate a new list. API summary: List messages in an inbox.create_mailboxChanges dataCreate a new mailbox. Required: name. API summary: Create a new mailbox if possible.create_mappingChanges dataCreate a new mapping. Required: ai transform id or entity type. API summary: Create transformer mapping.create_mapping_matchChanges dataCreate a new match for a mapping. API summary: Test transformer mapping match result.create_mcpChanges dataCreate a new mcp. Required: body.create_messageVisible to othersCreate a new message. Required: inbox id. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Wait for or return the first email that matches provided MatchOptions array.create_message_assert_ai_messageVisible to othersCreate a new message. Required: message, assertions, timeout or ai options. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Check named natural-language assertions against an existing email or SMS.create_message_check_email_bodyVisible to othersCreate a new message for a message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Check email body for broken links, images, and spelling issues.create_message_check_email_body_feature_supportVisible to othersCreate a new message for a message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Check client support for features used in a stored email body.create_message_check_email_client_supportVisible to othersCreate a new message. Required: email body. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Check email-client support for a provided HTML body.create_message_check_email_domain_reputationVisible to othersCreate a new message. Required: target. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Check email/domain reputation signals including configured DNS blacklists.create_message_claimVisible to othersCreate a new claim for a message. Required: worker id or lease seconds. Has effects visible outside this system. API summary: Acquire an SMS conversation claim.create_message_claim_agent_acquire_conversation_claimChanges dataCreate a new claim for a message. Required: worker id or lease seconds. API summary: Acquire a renewable conversation claim.create_message_create_device_preview_run_from_raw_importChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: Create a device preview run from raw MIME bytes.create_message_create_email_audit_for_emailVisible to othersCreate a new message for a message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Persist aggregate email audit for a stored email.create_message_create_new_fake_email_addressVisible to othersCreate a new message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Create a new email address using the fake email domains.create_message_device_previewVisible to othersCreate a new device preview for a message. Has effects visible outside this system. API summary: Create a new device preview run for an email.create_message_extract_ai_messageVisible to othersCreate a new message. Required: message, timeout or ai options. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Extract schema-validated data from an existing email or SMS with verified source evidence.create_message_get_email_content_matchVisible to othersCreate a new message for a message. Required: pattern. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Run regex against hydrated email body and return matches.create_message_get_email_intelligenceVisible to othersCreate a new message. Required: targets. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Get intelligence score and breakdown for email/domain targets. Per unit billing for non-cached evaluations.create_message_get_email_screenshot_as_base64Visible to othersCreate a new message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Take a screenshot of an email in a browser and return base64 encoded string.create_message_get_email_screenshot_as_binaryVisible to othersCreate a new message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Take a screenshot of an email in a browser.create_message_handoffVisible to othersCreate a new handoff for a message. Required: reason code or priority. Has effects visible outside this system. API summary: Request human review for an SMS conversation.create_message_handoff_agent_request_conversation_handoffChanges dataCreate a new handoff for a message. Required: reason code or priority. API summary: Request human review for a conversation.create_message_imap_flag_operationVisible to othersCreate a new imap flag operation for a message. Required: flag operation or flags. Has effects visible outside this system. API summary: Set IMAP flags associated with a message. Only supports '\Seen' flag.create_message_pause_email_warmup_programVisible to othersCreate a new message for a message. Required: expected version. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Pause an email warmup program.create_message_replyVisible to othersCreate a new reply for a message. Required: body or is html. Has effects visible outside this system. API summary: Reply to a scoped email as an agent.create_message_reply_draftVisible to othersCreate a new reply draft for a message. Required: body or is html. Has effects visible outside this system. API summary: Create a correctly threaded reply draft.create_message_resume_email_warmup_programVisible to othersCreate a new message for a message. Required: expected version. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Resume an email warmup program.create_message_retry_email_warmup_programVisible to othersCreate a new message for a message. Required: expected version. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Retry a system-paused email warmup program.create_message_wait_for_ai_messageVisible to othersCreate a new message. Required: scope, since, timeout, unread only, sort direction or assertions. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Find a message across explicit inboxes or phones, then assert and extract from that same message.create_message_wait_for_ai_messagesChanges dataCreate a new message. Required: expectations, since, timeout, allow shared messages or ai options. Search messages first to avoid duplicates. API summary: Wait for all named email and SMS expectations under one shared deadline and AI token budget.create_message_wait_for_matching_emailsChanges dataCreate a new message. Required: inbox id or count. Search messages first to avoid duplicates. API summary: Wait or return list of emails that match simple matching patterns.create_message_wait_for_message_aiVisible to othersCreate a new message. Required: scope, since, timeout, unread only, sort direction or assertions. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Wait for AI-matched email or SMS.create_message_wait_for_messages_aiChanges dataCreate a new message. Required: expectations, since, timeout, allow shared messages or ai options. Search messages first to avoid duplicates. API summary: Wait for AI-matched email or SMS.create_monitorChanges dataCreate a new monitor. Required: domain. API summary: Create domain monitor.create_monitor_alert_sinkChanges dataCreate a new alert sink for a monitor. Required: type or target. API summary: Create alert sink for monitor.create_monitor_run_nowChanges dataCreate a new run now for a monitor. API summary: Run monitor now.create_new_random_inboxVisible to othersCreate a new address. Search addresses first to avoid duplicates. Has effects visible outside this system. API summary: Create new random inbox.create_nextChanges dataCreate a new next. Required: worker id or lease seconds. API summary: Claim the next conversation work item.create_number_allChanges dataCreate a new number. Search numbers first to avoid duplicates. API summary: Add all phone numbers to phone pool.create_number_tagChanges dataCreate a new tag for a number. Required: tags. Search tags first to avoid duplicates. API summary: Add phone number tags.create_number_testVisible to othersCreate a new test for a number. Required: message. Has effects visible outside this system. API summary: Test sending an SMS to a number.create_number_webhookDeletesCreate a new webhook for a number. Required: url. Destructive action; may require approval. API summary: Attach a WebHook URL to a phone number.create_oauth_exchangeChanges dataCreate a new oauth exchange. Required: authorization code, redirect uri or state. API summary: Exchange Postmaster OAuth authorization code.create_otp_auth_urlChanges dataCreate a new otp auth url. Required: otp auth url. API summary: Create a TOTP device from an OTP Auth URL.create_otp_auth_url_agent_create_totp_device_for_otp_auth_urlChanges dataCreate a new otp auth url. Required: otp auth url. API summary: Create an agent-managed TOTP device from an OTP Auth URL.create_phoneChanges dataCreate a new phone. Required: phone country. API summary: 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 t….create_phone_number_smsVisible to othersCreate a new sms for a phone number. Required: to or body. Search sms first to avoid duplicates. Has effects visible outside this system. API summary: Send SMS from an assigned phone number.create_pixelChanges dataCreate a new pixel. Search pixels first to avoid duplicates. API summary: Create tracking pixel.create_pluckChanges dataCreate a new pluck. Required: property.create_poolChanges dataCreate a new pool. Required: name. API summary: Create phone pool.create_pool_leaseChanges dataCreate a new lease for a pool. API summary: Acquire phone pool lease.create_pool_numberChanges dataCreate a new number for a pool. Required: phone number ids. Search numbers first to avoid duplicates. API summary: Add phone numbers to phone pool.create_prepareChanges dataCreate a new prepare. Required: requested segment, public share requested or address format. API summary: Prepare a direct-send inbox placement test without consuming allowance.create_probeChanges dataCreate a new probe. API summary: Create campaign probe.create_probe_run_nowChanges dataCreate a new run now for a probe. API summary: Run campaign probe now.create_profileChanges dataCreate a new profile. Required: local part. API summary: Create a device preview profile.create_projectChanges dataCreate a new project. Required: phone country or items. API summary: Create a phone provisioning job.create_redriveDeletesCreate a new redrive. Destructive action; may require approval. API summary: Redrive all webhook results that have failed status.create_registerChanges dataCreate a new register. Required: client name, redirect uris, token endpoint auth method, grant types or response types.create_replierChanges dataCreate a new replier. API summary: Create an inbox replier.create_rerunChanges dataCreate a new rerun. Required: target ids or failed only. API summary: Rerun selected device preview targets in the same run.create_result_redriveDeletesCreate a new redrive for a result. Destructive action; may require approval. API summary: Get a webhook result and try to resend the original webhook payload.create_rulesetChanges dataCreate a new ruleset. Required: scope, action or target. Search rulesets first to avoid duplicates. API summary: Create a ruleset.create_ruleset_testChanges dataCreate a new test for a ruleset. Required: test target. API summary: Test a ruleset.create_runChanges dataCreate a new run.create_run_dueChanges dataCreate a new run due. API summary: Run due monitors for user.create_scheduleChanges dataCreate a new schedule. Required: connection id, name, interval minutes, enabled, requested segment or subject template. API summary: Create an automated inbox placement schedule.create_schedule_runChanges dataCreate a new run for a schedule. API summary: Run an automated inbox placement schedule now.create_schemaDeletesCreate a new schema. Required: event. Destructive action; may require approval.create_sending_connectionChanges dataCreate a new sending connection. Required: name, provider preset, provider or from email. API summary: Create a sending connection.create_sending_connection_credentialChanges dataCreate a new credential for a sending connection. API summary: Rotate sending connection credentials.create_sending_connection_delivery_probeChanges dataCreate a new delivery probe for a sending connection. API summary: Send an unbilled delivery test to a temporary MailSlurp inbox.create_simulation_job_pauseChanges dataCreate a new pause for a simulation job. API summary: Pause deliverability simulation job.create_simulation_job_resumeChanges dataCreate a new resume for a simulation job. API summary: Resume deliverability simulation job.create_smsVisible to othersCreate a new sms. Required: sms id. Search sms first to avoid duplicates. Has effects visible outside this system. API summary: Generate structured content for a TXT message.create_sms_codeVisible to othersCreate a new code for a sms. Has effects visible outside this system. API summary: Extract verification codes from an SMS.create_sms_replyVisible to othersCreate a new reply for a sms. Required: body. Has effects visible outside this system. API summary: Send a reply to a received SMS message. Replies are sent from the receiving number.create_sms_reply_agent_reply_to_smsVisible to othersCreate a new reply for a sms. Required: body. Has effects visible outside this system. API summary: Reply to received SMS.create_spam_testChanges dataCreate a new spam test. Required: requested segment or address format. API summary: Create a public spam test.create_task_deferChanges dataCreate a new defer for a task. Required: reason code or priority. API summary: Defer a work item to human review.create_task_prepare_replyChanges dataCreate a new prepare reply for a task. Required: source email id or reply. API summary: Prepare a guarded reply draft.create_templateChanges dataCreate a new template. Required: name or content. API summary: Create a Template.create_test_receivingChanges dataCreate a new test receiving. Required: from sender. API summary: Test receiving with rulesets.create_test_sendingChanges dataCreate a new test sending. Required: recipient. API summary: Test sending with rulesets.create_test_smtp_serverChanges dataCreate a new test smtp server. Required: host, port or use start tls. API summary: Run a conservative SMTP connectivity, TLS, and AUTH diagnostic.create_transformerChanges dataCreate a new transformer. API summary: Create a transformer for reuse in automations.create_v2_groupChanges dataCreate a new group for a v2. Required: schemas. Search groups first to avoid duplicates.create_v2_userChanges dataCreate a new user for a v2. Required: schemas. Search users first to avoid duplicates.create_wait_for_latest_smsVisible to othersCreate a new wait for latest sms. Required: phone number id or timeout. Has effects visible outside this system. API summary: Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.create_wait_for_smsVisible to othersCreate a new wait for sms. Required: phone number id, count or timeout. Has effects visible outside this system. API summary: Wait for an SMS message to match the provided filter conditions such as body contains keyword.create_webhookDeletesCreate a new webhook. Required: url. Destructive action; may require approval. API summary: Attach a WebHook URL to an inbox.create_webhook_exampleDeletesCreate a new example for a webhook. Destructive action; may require approval.create_webhook_schemaDeletesCreate a new schema for a webhook. Destructive action; may require approval.create_with_defaultChanges dataCreate a new with default. API summary: Create an inbox with default options. Uses MailSlurp domain pool address and is private.create_with_optionChanges dataCreate a new with option. API summary: Create an inbox with options. Extended options for inbox creation.delete_a_validation_recordDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a validation record.delete_accountsMoves moneyPermanently delete a account. Financial or irreversible action; may require approval.delete_address_all_inbox_emailsDeletesPermanently delete a address by inbox id. Destructive action; may require approval. API summary: Delete all emails in a given inboxes.delete_address_draftDeletesPermanently delete a draft by draft id. Destructive action; may require approval. API summary: Delete a scoped email draft for an agent.delete_address_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval. API summary: Delete and disable a Webhook for an Inbox.delete_addressesMoves moneyPermanently delete a address. Financial or irreversible action; may require approval. API summary: Delete all inboxes.delete_addresses_bulk_delete_inboxesMoves moneyPermanently delete a address. Financial or irreversible action; may require approval. API summary: Bulk Delete Inboxes.delete_aliasDeletesPermanently delete a alias by alias id. Destructive action; may require approval. API summary: Delete an email alias.delete_all_emails_in_all_inboxesMoves moneyPermanently delete a message. Financial or irreversible action; may require approval. API summary: Delete all emails in all inboxes.delete_all_sent_email_receiptsMoves moneyPermanently delete a message. Financial or irreversible action; may require approval. API summary: Delete all sent email receipts.delete_all_sent_sms_messagesMoves moneyPermanently delete a message. Financial or irreversible action; may require approval. API summary: Delete all sent SMS messages.delete_an_agent_managed_totp_deviceDeletesPermanently delete a device by device id. Destructive action; may require approval. API summary: Delete an agent-managed TOTP device.delete_an_email_draftDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete an email draft.delete_an_email_warmup_programDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete an email warmup program.delete_an_emergency_addressDeletesPermanently delete a address by address id. Destructive action; may require approval. API summary: Delete an emergency address.delete_by_descriptionsMoves moneyPermanently delete a by description. Financial or irreversible action; may require approval. API summary: Delete inboxes by description.delete_by_namesMoves moneyPermanently delete a by name. Financial or irreversible action; may require approval. API summary: Delete inboxes by name.delete_by_tagsMoves moneyPermanently delete a by tag. Financial or irreversible action; may require approval. API summary: Delete inboxes by tag.delete_connectionDeletesPermanently delete a connection by connection id. Destructive action; may require approval. API summary: Disconnect a sender connection.delete_connectionsMoves moneyPermanently delete a connection. Financial or irreversible action; may require approval. API summary: Disconnect Postmaster OAuth.delete_connectorDeletesPermanently delete a connector by connector id. Destructive action; may require approval. API summary: Delete an inbox connector.delete_connector_imapsMoves moneyPermanently delete a imap by connector id. Financial or irreversible action; may require approval. API summary: Delete an inbox connector IMAP connection.delete_connector_settingsDeletesPermanently delete a connector by connector id. Destructive action; may require approval. API summary: Create an inbox connector sync settings.delete_connector_smtpsMoves moneyPermanently delete a smtp by connector id. Financial or irreversible action; may require approval. API summary: Delete an inbox connector SMTP connection.delete_connectorsMoves moneyPermanently delete a connector. Financial or irreversible action; may require approval. API summary: Delete all inbox connectors.delete_contactDeletesPermanently delete a contact by contact id. Destructive action; may require approval. API summary: Delete contact.delete_deliverabilityDeletesPermanently delete a deliverability by test id. Destructive action; may require approval. API summary: Delete load test.delete_deviceDeletesPermanently delete a device by device id. Destructive action; may require approval. API summary: Delete a TOTP device.delete_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete an attachment.delete_documentsMoves moneyPermanently delete a document. Financial or irreversible action; may require approval. API summary: Delete all attachments.delete_domainDeletesPermanently delete a domain by domain id. Destructive action; may require approval.delete_emailDeletesPermanently delete a received email by `message_id`. This cannot be undone.delete_email_auditDeletesPermanently delete a message by audit id. Destructive action; may require approval. API summary: Delete email audit.delete_empty_inboxesMoves moneyPermanently delete a empty inbox. Financial or irreversible action; may require approval. API summary: Delete all emails in an inbox.delete_expiredsMoves moneyPermanently delete a expired. Financial or irreversible action; may require approval. API summary: Remove expired inboxes.delete_forwarderDeletesPermanently delete a forwarder by forwarder id. Destructive action; may require approval. API summary: Delete an inbox forwarder.delete_forwardersMoves moneyPermanently delete a forwarder. Financial or irreversible action; may require approval. API summary: Delete inbox forwarders.delete_free_inboxDeletesPermanently delete a free inbox by free inbox id. Destructive action; may require approval.delete_groupDeletesPermanently delete a group by group id. Destructive action; may require approval. API summary: Delete group.delete_group_contactsMoves moneyPermanently delete a contact by group id. Financial or irreversible action; may require approval. API summary: Remove contacts from a group.delete_inboxDeletesPermanently delete an inbox by `address_id`, including its email address and stored emails. This cannot be undone.delete_inbox_email_address_by_inbox_idMoves moneyPermanently delete a address. Financial or irreversible action; may require approval. API summary: Delete inbox email address by inbox id.delete_inbox_retention_policyDeletesPermanently delete a inbox retention policy by policy id. Destructive action; may require approval.delete_local_device_preview_run_dataDeletesPermanently delete a address by run id. Destructive action; may require approval. API summary: Delete local device preview run data.delete_mappingDeletesPermanently delete a mapping by mapping id. Destructive action; may require approval. API summary: Delete transformer mapping.delete_mappingsMoves moneyPermanently delete a mapping. Financial or irreversible action; may require approval. API summary: Delete all transformer mapping.delete_message_claimDeletesPermanently delete a claim by claim id. Destructive action; may require approval. API summary: Release an SMS conversation claim.delete_message_claim_agent_release_conversation_claimDeletesPermanently delete a claim by claim id. Destructive action; may require approval. API summary: Release a conversation claim.delete_messagesMoves moneyPermanently delete a message. Financial or irreversible action; may require approval. API summary: Cancel purchased Delivery Sender seats.delete_messages_delete_new_fake_email_addressMoves moneyPermanently delete a message. Financial or irreversible action; may require approval. API summary: Delete a fake email address using the fake email domains.delete_monitorDeletesPermanently delete a monitor by monitor id. Destructive action; may require approval. API summary: Delete domain monitor.delete_monitor_alert_sinkDeletesPermanently delete a alert sink by sink id. Destructive action; may require approval. API summary: Delete monitor alert sink.delete_monitor_observed_auth_sampleDeletesPermanently delete a observed auth sample by sample id. Destructive action; may require approval. API summary: Delete domain monitor observed authentication sample.delete_numberDeletesPermanently delete a number by phone number id. Destructive action; may require approval. API summary: Delete a phone number.delete_number_messageDeletesPermanently delete a message by other number. Destructive action; may require approval. API summary: Delete messages in a phone thread.delete_number_tagsMoves moneyPermanently delete a tag by phone number id. Financial or irreversible action; may require approval. API summary: Remove phone number tags.delete_numbersMoves moneyPermanently delete a number. Financial or irreversible action; may require approval. API summary: Delete all phone numbers.delete_opt_insMoves moneyPermanently delete a opt in. Financial or irreversible action; may require approval.delete_poolDeletesPermanently delete a pool by pool id. Destructive action; may require approval. API summary: Delete phone pool.delete_pool_leaseDeletesPermanently delete a lease by lease id. Destructive action; may require approval. API summary: Release phone pool lease.delete_pool_numberDeletesPermanently delete a number by phone number id. Destructive action; may require approval. API summary: Remove phone number from phone pool.delete_probeDeletesPermanently delete a probe by probe id. Destructive action; may require approval. API summary: Delete campaign probe.delete_profileDeletesPermanently delete a profile by profile id. Destructive action; may require approval. API summary: Delete a device preview profile.delete_replierDeletesPermanently delete a replier by replier id. Destructive action; may require approval. API summary: Delete an inbox replier.delete_repliersMoves moneyPermanently delete a replier. Financial or irreversible action; may require approval. API summary: Delete inbox repliers.delete_rulesetDeletesPermanently delete a ruleset by ruleset id. Destructive action; may require approval.delete_rulesetsMoves moneyPermanently delete a ruleset. Financial or irreversible action; may require approval. API summary: Delete rulesets.delete_scheduleDeletesPermanently delete a schedule by schedule id. Destructive action; may require approval. API summary: Delete an automated inbox placement schedule.delete_sending_connectionDeletesPermanently delete a sending connection by connection id. Destructive action; may require approval. API summary: Disconnect a sending connection.delete_sent_email_receiptDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete sent email receipt.delete_sent_sms_messageDeletesPermanently delete a message by message sms id. Destructive action; may require approval. API summary: Delete sent SMS message.delete_share_linkDeletesPermanently delete a share link by share link id. Destructive action; may require approval. API summary: Revoke a device preview share link.delete_smsMoves moneyPermanently delete a sms. Financial or irreversible action; may require approval. API summary: Delete all SMS messages.delete_sms_messageDeletesPermanently delete a sms by sms id. Destructive action; may require approval. API summary: Delete SMS message.delete_templateDeletesPermanently delete a template by template id. Destructive action; may require approval. API summary: Delete email template.delete_transformerDeletesPermanently delete a transformer by transformer id. Destructive action; may require approval.delete_transformersMoves moneyPermanently delete a transformer. Financial or irreversible action; may require approval. API summary: Delete all transformers.delete_v2_groupDeletesPermanently delete a group by group id. Destructive action; may require approval.delete_v2_userDeletesPermanently delete a user by user id. Destructive action; may require approval.delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval.delete_webhooksMoves moneyPermanently delete a webhook. Financial or irreversible action; may require approval. API summary: Delete all webhooks.download_base64Download the document for a base64.download_base64_download_phone_number_media_base64Download the document for a base64.download_bodyDownload the document for a body. API summary: Get email body as string. Returned as plain/text with content type header.download_body_byteDownload the document for a body byte. API summary: Get email body in bytes. Returned as octet-stream with content type header.download_byteDownload the document for a byte.download_byte_download_attachment_as_bytesDownload the document for a byte. API summary: Download attachments. Get email attachment bytes. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoint….download_byte_download_phone_number_mediaDownload the document for a byte.download_documentDownload the document for a document. API summary: Get email attachment bytes. Returned as octet-stream with content type header.download_document_download_attachment_as_base64_encodedDownload the document for a document. API summary: Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.download_messageDownload the document for a message. API summary: Download the original RFC822 email for a device preview run.download_message_download_device_preview_email_submission_sourceDownload the document for a message. API summary: Download the original RFC822 email for a device preview submission.export_csvsExport csvs. API summary: Export phone numbers CSV.export_exportsExport exports. API summary: Export inboxes link callable via browser.export_inbox_placement_test_results_as_csvExport results. API summary: Export inbox placement test results as CSV.export_load_test_entity_results_as_csvExport results. API summary: Export load-test entity results as CSV.export_monitor_run_results_as_csvExport results. API summary: Export monitor run results as CSV.export_reportsExport reports. API summary: Export load-test report as PDF.export_resultsChanges dataExport results. API summary: Export transformer results.export_seed_list_csvsExport seed list csvs. API summary: Download inbox placement seed addresses as an email-platform CSV.extract_verification_codeVisible to othersPull a verification or one-time code out of a received email by `email_id`, optionally limited by code length.find_inbox_by_emailFind one of your inboxes by its `email_address`. Returns the inbox ID the other tools need.forward_emailVisible to othersForward a received email by `email_id` to the `to` addresses, with optional cc, bcc and subject. The email is sent immediately.get_a_bounced_emailGet one message by message id. API summary: Get a bounced email.get_a_phone_number_by_nameSearch by names by name. Use this to find existing by names before creating a new by name. API summary: Get a phone number by name.get_a_public_shared_device_preview_resultGet one share by share token. API summary: Get a public shared device preview result.get_a_public_shared_device_preview_screenshot_imageList images for a screenshot. API summary: Get a public shared device preview screenshot image.get_a_scheduled_email_jobGet one project by job id. API summary: Get a scheduled email job.get_a_threadGet one message by message id. API summary: Get a thread.get_a_webhook_result_for_a_webhookGet one result by webhook result id. API summary: Get a webhook result for a webhook.get_account_infoGet the connected MailSlurp account's details. Use to confirm which account you are working in.get_address_draftGet one draft for a address by draft id. API summary: Get a scoped email draft for an agent.get_address_get_expired_inbox_by_inbox_idGet one address by address id. API summary: Get expired inbox record for a previously existing inbox.get_address_latest_emailGet one address. API summary: Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.get_address_or_createChanges dataGet one address by inbox id. API summary: Get or create a plus address by full address.get_address_or_create_plus_addressChanges dataGet one address. API summary: Get or create a plus address by full address without inbox ID.get_address_providerGet one provider for a address by provider. API summary: Get provider-level progress for a device preview run.get_address_status_pixelsGet the current status of a address by inbox id. Results are paginated. API summary: List inbox tracking pixels.get_aliasGet one alias by alias id. API summary: Get an email alias.get_all_contact_groups_in_paginated_formatList contacts. Optional filters: sort, since or before. Results are paginated. API summary: Get all Contact Groups in paginated format.get_all_inbox_connector_eventsList events. Optional filters: id, sort, since, before or event type. Results are paginated. API summary: Get all inbox connector events.get_all_inbox_forwarder_eventsList events. Optional filters: inbox id, email id, sent id or sort. Results are paginated. API summary: Get all inbox forwarder events.get_all_missedemails_in_paginated_formatSearch messages by sort, search filter, since, before or inbox id. Use this to find existing messages before creating a new message. Results are paginated. API summary: Get all MissedEmails in paginated format.get_all_threadsList messages. Optional filters: sort, since or before. Results are paginated. API summary: Get all threads.get_all_unknown_missed_emails_in_paginated_formatSearch messages by sort, search filter, since, before or inbox id. Use this to find existing messages before creating a new message. Results are paginated. API summary: Get all unknown missed emails in paginated format.get_an_agent_accessible_totp_deviceGet one device by device id. API summary: Get an agent-accessible TOTP device.get_an_email_draftGet one message by message id. API summary: Get an email draft.get_an_email_warmup_programGet one message by message id. API summary: Get an email warmup program.get_an_emergency_addressGet one address by address id. API summary: Get an emergency address.get_an_inbox_connector_eventGet one event by event id. API summary: Get an inbox connector event.get_audit_logGet one audit log by event id.get_automation_inbox_placement_analytics_over_timeList series. Optional filters: since, before, bucket or run limit. API summary: Get automation inbox placement analytics over time.get_callbackGet one callback by provider kind. API summary: Redeem a staging provider handoff and continue to the app.get_complaintGet one complaint by complaint id. API summary: Get complaint.get_connectionGet one connection by connection id. API summary: Get a sender connection.get_connectorGet one connector by connector id. API summary: Get an inbox connector.get_connector_by_email_addressList addresses. Optional filters: email address. API summary: Get connector by email address.get_connector_by_nameSearch by names by name. Use this to find existing by names before creating a new by name. API summary: Get connector by name.get_connector_settingsGet one connector by connector id. API summary: Get an inbox connector sync settings.get_contactGet one contact by contact id. API summary: Get contact.get_deliverabilityGet one deliverability by test id. API summary: Get load test.get_deliverability_projectGet one project for a deliverability by job id. API summary: Get deliverability simulation job.get_deliverability_statusGet the current status of a deliverability by test id. API summary: Poll load-test status.get_delivery_statusGet one delivery status by delivery id.get_deviceGet one device by device id. API summary: Get a TOTP device by ID.get_device_preview_run_statusGet one address by run id. API summary: Get device preview run status.get_device_render_testGet one device render test by device render test id. API summary: Get a public email render test.get_documentGet one document by document id. API summary: Get an attachment entity.get_domainGet one domain by domain id. API summary: Get a domain.get_emailGet one received email by its ID (`message_id`), including sender, recipients, subject, body and attachment IDs.get_email_attachmentDownload one attachment from an email as base64 content, by `email_id` and `attachment_id`.get_email_attachment_metadata_informationList documents for a document. API summary: Get email attachment metadata information.get_email_auditGet one message by audit id. API summary: Get email audit.get_email_content_part_by_content_typeList messages for a message. Optional filters: content type, strict or index. API summary: Get email content part by content type.get_email_countGet one message. API summary: Get email count.get_email_count_in_inboxGet one message by inbox id. API summary: Get email count in inbox.get_email_linksList the links found in a received email by `email_id`, for example a confirmation or password-reset link.get_email_summaryGet an email's headers and metadata (sender, recipients, subject, date) by `email_id`, without the body.get_email_thread_metadata_by_thread_idGet one message by message id. API summary: Get email thread metadata by thread ID.get_email_warmup_program_progress_and_daily_activityList messages for a message. Optional filters: days. API summary: Get email warmup program progress and daily activity.get_emails_for_a_given_inbox_plus_addressList messages. Optional filters: plus address, sort, since or before. Results are paginated. API summary: Get emails for a given inbox plus address.get_eventGet one event by event id. API summary: Get a forwarder event.get_expiredGet one expired by expired id. API summary: Get an expired inbox record.get_fake_emails_for_an_addressList messages. Optional filters: email address. Results are paginated. API summary: Get fake emails for an address.get_feedbackGet one feedback by feedback id. API summary: Get a single device preview feedback item.get_forwarderGet one forwarder by forwarder id. API summary: Get an inbox forwarder.get_forwarder_eventGet one event for a forwarder by event id. API summary: Get an inbox forwarder event.get_free_inboxGet one free inbox by free inbox id.get_groupGet one group by group id. API summary: Get group.get_guest_portalGet one guest portal by portal id. API summary: Get a client email portal.get_guest_portal_userGet one user for a guest portal by guest id. API summary: Get guest user for portal.get_hydrated_email_html_for_browser_renderingList htmls for a message. Optional filters: replace cid images. API summary: Get hydrated email HTML for browser rendering.get_hydrated_email_html_wrapped_in_jsonList messages. Optional filters: replace cid images. API summary: Get hydrated email HTML wrapped in JSON.get_inboxGet one inbox by its ID (`address_id`), including its email address, name, tags and expiry.get_inbox_placement_analytics_time_seriesList series. Optional filters: since, before, bucket, group by, sender domain or from email. API summary: Get inbox placement analytics time series.get_inbox_placement_testGet one inbox placement test by inbox placement test id. API summary: Get inbox placement test run.get_inbox_retention_policyGet one inbox retention policy by policy id.get_inbox_tagsSearch tags by sort or search filter. Use this to find existing tags before creating a new tag. Results are paginated. API summary: Get inbox tags.get_inbox_tags_paginatedSearch contacts by sort or search filter. Use this to find existing contacts before creating a new contact. Results are paginated. API summary: Get inbox tags paginated.get_inboxes_for_a_tagSearch addresses by sort, search filter or tag. Use this to find existing addresses before creating a new address. Results are paginated. API summary: Get inboxes for a tag.get_ip_address_for_a_domainChanges dataCreate a new address. Required: name. Search addresses first to avoid duplicates. API summary: Get IP address for a domain.get_latest_deliverability_simulation_jobList messages. API summary: Get latest deliverability simulation job.get_latest_scoped_inbox_email_for_an_agentList messages. Optional filters: timeout millis, unread only, since or before. API summary: Get latest scoped inbox email for an agent.get_mappingGet one mapping by mapping id. API summary: Get transformer mapping.get_mediumGet one medium by media id.get_medium_get_phone_number_media_by_idGet one medium by media id.get_message_compare_email_auditsGet one message for a message by other audit id. API summary: Compare two email audits.get_message_get_sent_sms_messageGet one message by message sms id. API summary: Get sent SMS content including body. Expects sent SMS to exist by ID.get_message_status_pixelsGet the current status of a message by sent id. Results are paginated.get_message_status_pixels_trackingGet the current status of a message. Results are paginated.get_missed_smsGet one missed sms by missed sms id. API summary: Get missed SMS content.get_missed_sms_countGet one missed sms. API summary: Get missed SMS count.get_missedemailGet one message by message id. API summary: Get MissedEmail.get_monitorGet one monitor by monitor id. API summary: Get domain monitor.get_monitor_runGet one run for a monitor by run id. API summary: Get monitor run.get_multipart_content_part_as_raw_responseList messages. Optional filters: content type, strict or index. API summary: Get multipart content part as raw response.get_native_device_preview_target_availabilityList availabilities. API summary: Get native device preview target availability.get_numberGet one number by phone number id. API summary: Get a phone number by ID.get_number_messageGet one message for a number by other number. Results are paginated. API summary: Get messages in a phone thread.get_one_scoped_conversationGet one message by message id. API summary: Get one scoped conversation.get_one_sms_conversationGet one message by conversation id. API summary: Get one SMS conversation.get_operational_email_warmup_activity_and_program_progressList messages. Optional filters: days. API summary: Get operational email warmup activity and program progress.get_paginated_list_of_bounced_emailsList messages. Optional filters: sort, since or before. Results are paginated. API summary: Get paginated list of bounced emails.get_paginated_webhooks_for_a_phone_numberSearch contacts by sort, since, before, event type, search filter or health. Use this to find existing contacts before creating a new contact. Results are paginated. API summary: Get paginated webhooks for a phone number.get_paginated_webhooks_for_an_inboxSearch contacts by sort, search filter, since, before, health or event type. Use this to find existing contacts before creating a new contact. Results are paginated. API summary: Get paginated webhooks for an Inbox.get_phone_numberGet one phone number by phone number id. API summary: Get an assigned phone number.get_phone_number_messageGet one message for a phone number by other phone number. Results are paginated. API summary: List SMS thread messages.get_phone_number_smsGet one sms for a phone number by sms id. API summary: Get received SMS.get_pixelGet one pixel by pixel id. API summary: Get pixel.get_poolGet one pool by pool id. API summary: Get phone pool.get_pool_or_createChanges dataGet one pool. API summary: Get or create phone pool.get_postmaster_connection_statusList connections. API summary: Get Postmaster connection status.get_probeGet one probe by probe id. API summary: Get campaign probe.get_probe_runGet one run for a probe by run id. API summary: Get campaign probe run.get_profileGet one profile by profile id. API summary: Get a device preview profile.get_projectGet one project by project id. API summary: Get phone provisioning job.get_recipientGet one recipient by recipient id. API summary: Get a bounced email.get_releaseGet one release by release id. API summary: Get phone number release.get_replierGet one replier by replier id. API summary: Get an inbox replier.get_resultGet one result by webhook id. API summary: Get a webhook results count for a webhook.get_rulesetGet one ruleset by ruleset id. API summary: Get a ruleset.get_runGet one run by run id.get_run_compareGet one compare for a run by other run id. API summary: Compare two monitor runs.get_run_compare_compare_campaign_probe_runsGet one compare for a run by other run id. API summary: Compare two campaign probe runs.get_scheduleGet one schedule by schedule id. API summary: Get an automated inbox placement schedule.get_scoped_email_summary_for_an_agentList messages for a message. API summary: Get scoped email summary for an agent.get_scoped_hydrated_email_for_an_agentGet one message by message id. API summary: Get scoped hydrated email for an agent.get_sending_connectionGet one sending connection by connection id. API summary: Get a sending connection.get_sent_emailGet one sent email by its ID (`message_id`), including recipients, subject and body.get_sent_email_count_in_inboxGet one message by inbox id. API summary: Get sent email count in inbox.get_sent_smsGet one message by message sms id. API summary: Get sent SMS.get_sent_sms_countGet one message. API summary: Get sent SMS count.get_server_statusChanges dataGet the current status of a server. API summary: Get status for mailbox.get_shareGet one share by share token. API summary: Get a public inbox placement share.get_smsGet one sms by sms id. API summary: Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.get_sms_countGet one sms. API summary: Get SMS count.get_sms_prepaid_creditGet one sms prepaid credit by credit id. API summary: Get SMS prepaid credit.get_spam_testGet one spam test by spam test id. API summary: Get a public spam test run.get_sub_address_plus_address_by_idGet one address by address id. API summary: Get sub address plus address by ID.get_sub_address_plus_address_for_an_inboxGet one address for a address by address id. API summary: Get sub address plus address for an inbox.get_templateGet one template by template id. API summary: Get template.get_template_preview_htmlList htmls. API summary: Get template preview HTML.get_template_preview_jsonList messages. API summary: Get template preview Json.get_temporary_device_preview_import_address_statusGet one address by session id. API summary: Get temporary device preview import address status.get_the_latest_messages_for_all_phonesList messages. Results are paginated. API summary: Get the latest messages for all phones.get_total_inbox_countGet one address. API summary: Get total inbox count.get_transformerGet one transformer by transformer id. API summary: Get a transformer.get_transformer_resultGet one result by result id. API summary: Get transformer result.get_unread_email_countCount unread emails, across the account or for one `inbox_id`.get_userGet one user by guest id. API summary: Get guest user.get_v2_groupGet one group for a v2 by group id.get_v2_resource_typeGet one resource type for a v2 by resource type.get_v2_schemaGet one schema for a v2 by schema id.get_v2_userGet one user for a v2 by user id.get_warmup_readiness_adaptive_pacing_and_sender_health_signalsList messages for a message. API summary: Get warmup readiness, adaptive pacing, and sender-health signals.get_webhookGet one webhook by webhook id. API summary: Get a webhook.import_email_into_inbox_from_raw_mime_bytesVisible to othersUpload a message (inbox id). Has effects visible outside this system. API summary: Import email into inbox from raw MIME bytes.list_account_webhooks_paginatedSearch contacts by sort, since, before, event type, health or search filter. Use this to find existing contacts before creating a new contact. Results are paginated. API summary: List account webhooks Paginated.list_accountsList accounts.list_accounts_get_account_bounce_block_statusList accounts. API summary: Can account send email.list_active_conversations_with_an_opaque_keyset_cursorSearch messages by workflow state, outcome, review status, inbox id, unread or has attachments. Use this to find existing messages before creating a new message. Results are paginated. API summary: List active conversations with an opaque keyset cursor.list_active_sms_conversationsSearch messages by workflow state, outcome, review status, phone number id, unread or has media. Use this to find existing messages before creating a new message. Results are paginated. API summary: List active SMS conversations.list_address_draftsList drafts for a address. Optional filters: sort. Results are paginated. API summary: List scoped email drafts for an agent.list_address_messagesList messages for a address. Optional filters: sort, since or before. Results are paginated. API summary: Get emails for a given inbox plus address.list_address_messages_get_device_preview_run_source_emailList messages for a address. API summary: Get the original email content for a device preview run.list_address_messages_get_emailsList messages for a address. Optional filters: sort, retry timeout, delay timeout, min count, unread only or before. Results are paginated. API summary: 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 returni….list_address_projectsList projects for a address. Optional filters: sort, since or before. Results are paginated. API summary: Get all scheduled email sending jobs for the inbox.list_address_resultsList results for a address. API summary: Get device preview run results.list_address_share_linksList share links for a address. API summary: List share links for a device preview run.list_address_waitsList waits for a address. Optional filters: timeout millis or poll interval millis. API summary: Wait for device preview run to complete.list_addressesList addresses. API summary: Get emergency addresses.list_addresses_get_all_plus_addressesList addresses. Optional filters: sort or inbox id. Results are paginated. API summary: Get all sub address plus address aliases for an inbox.list_addresses_get_fake_email_by_email_addressList addresses. Optional filters: email address.list_addresses_get_inbox_plus_addressesList addresses for a address. Optional filters: sort. Results are paginated. API summary: Get sub address plus address aliases for an inbox.list_agent_accessible_totp_devicesList devices. Optional filters: sort, issuer or username. Results are paginated. API summary: List agent-accessible TOTP devices.list_alias_messagesList messages for a alias. Optional filters: sort, since or before. Results are paginated. API summary: Get emails for an alias.list_alias_threadsList threads for a alias. Optional filters: sort, since or before. Results are paginated. API summary: Get threads created for an alias.list_all_inboxes_offset_paginatedSearch messages by sort, favourite, search, tag, since or before. Use this to find existing messages before creating a new message. Results are paginated. API summary: List All Inboxes Offset Paginated.list_audit_logsList audit logs. Optional filters: since, before, action, user id, actor user id or target user id. Results are paginated.list_automated_inbox_placement_sender_providersList providers. API summary: List automated inbox placement sender providers.list_automationsList automations. API summary: Does inbox have automations.list_availabilitiesList availabilities. API summary: Get phone plans availability.list_available_domain_regionsList available domain regions. Optional filters: inbox type. API summary: Get all usable domains with account region status.list_available_domainsList available domains. Optional filters: inbox type. API summary: Get all usable domains.list_bounces_unsubscribe_recipientsList bounces. Optional filters: sort or domain id. Results are paginated. API summary: Get paginated list of unsubscribed recipients.list_breakdownsList breakdowns. Optional filters: since, before, sender domain or from email. Results are paginated. API summary: Get inbox placement analytics breakdowns.list_by_inbox_idsList by inbox ids. Optional filters: inbox id. API summary: Get connector by inbox ID.list_by_phone_numbersList by phone numbers. Optional filters: phone number. API summary: Get a phone number by phone number.list_capabilitiesList capabilities. Optional filters: phone country or provider label. API summary: Get phone provisioning capabilities.list_capabilities_agent_get_capabilitiesList capabilities. API summary: Discover this agent connection's capabilities.list_capacitiesList capacities. API summary: Get shared Delivery Sender capacity.list_complaintsList complaints. Optional filters: sort, since or before. Results are paginated. API summary: Get paginated list of complaints.list_connectionsList connections. API summary: List sender connections.list_connector_eventsList events for a connector. Optional filters: sort, since, before or event type. Results are paginated. API summary: Get an inbox connector events.list_connector_imapsList imaps for a connector. API summary: Get an inbox connector IMAP connection.list_connector_smtpsList smtps for a connector. API summary: Get an inbox connector SMTP connection.list_connectorsList connectors. Optional filters: sort, since or before. Results are paginated. API summary: Get inbox connectors.list_consentsList consents. API summary: Get consent status.list_contactsList your saved contacts, page by page, optionally filtered by `search` text or date.list_contacts_2List contacts. API summary: Get all contacts.list_contacts_get_all_templatesList contacts. Optional filters: sort, since or before. Results are paginated. API summary: List templates.list_contacts_get_test_webhook_payloadList contacts. Optional filters: event name.list_defaultsList defaults. API summary: Get default expiration settings.list_deliverabilitiesList deliverabilities. Optional filters: sort. Results are paginated. API summary: List load tests.list_deliverability_resultsList results for a deliverability. Optional filters: matched or sort. Results are paginated. API summary: Get load-test entity results.list_delivery_status_payloadsList delivery status payloads. API summary: Get webhook test payload for delivery status event.list_delivery_statusesList delivery statuses. Optional filters: sort, since or before. Results are paginated.list_device_codesList codes for a device. Optional filters: at or min seconds until expire. API summary: Get a TOTP device code by device ID.list_device_codes_agent_generate_totp_device_codeList codes for a device. Optional filters: at or min seconds until expire. API summary: Generate a code for an agent-managed TOTP device.list_device_preview_targetsList device preview targets.list_device_render_test_contentsList contents for a device render test. API summary: Get light and dark public email preview content.list_devicesList devices. Optional filters: sort, issuer or username. Results are paginated. API summary: List TOTP devices.list_documentsList documents. Optional filters: sort, file name filter, since, before, inbox id or email id. Results are paginated. API summary: Get email attachments.list_documents_get_attachment_meta_dataList documents for a document. API summary: Get email attachment metadata. This is the contentType and contentLength of an attachment.list_domain_health_eventsList health events for a domain. API summary: Get domain health events.list_domain_traffic_statsList traffic stats for a domain. Optional filters: start date or end date. API summary: Get local Postmaster traffic stats.list_domain_wildcardsList wildcards for a domain. API summary: Get catch all wild card inbox for domain.list_domainsList domains. API summary: Get domains.list_email_attachmentsList the attachments on a received email by `email_id`, with their attachment IDs.list_email_auditsVisible to othersEmail a message. Has effects visible outside this system. Results are paginated. API summary: List email audits.list_email_draftsList messages. Optional filters: inbox id or sort. Results are paginated. API summary: List email drafts.list_email_submission_messagesList messages for a email submission. API summary: Get the original email content for a device preview submission.list_email_threads_in_paginated_formSearch messages by html selector, inbox id, sort, search filter, since or before. Use this to find existing messages before creating a new message. Results are paginated. API summary: List email threads in paginated form.list_email_warmup_programsList messages. Results are paginated. API summary: List email warmup programs.list_envsList envs. Optional filters: inbox id.list_eventsList events. Optional filters: inbox replier id, inbox id, email id, sent id or sort. Results are paginated. API summary: Get inbox replier event list.list_events_agent_list_automation_eventsList events. Optional filters: event type or wait seconds. Results are paginated. API summary: Read durable scoped automation events.list_execution_eventsList events for a execution. API summary: List non-secret execution events.list_existsList exists. Optional filters: email address, allow catch all, ip address or sender. API summary: Does inbox exist.list_expiredsList expireds. Optional filters: sort, since, before or inbox id. Results are paginated. API summary: List records of expired inboxes.list_forwarder_eventsList events for a forwarder. Optional filters: sort. Results are paginated. API summary: Get an inbox forwarder event list.list_gravatar_forsList gravatar fors. Optional filters: email address. Results are paginated. API summary: Get Gravatar URL for an email address.list_group_contactsList contacts for a group. API summary: Get group and contacts belonging to it.list_group_contacts_get_group_with_contacts_paginatedList contacts for a group. Optional filters: sort, since or before. Results are paginated.list_groupsList groups. API summary: Get all groups.list_guest_portalsList guest portals. API summary: Get guest portals.list_hotspotsList hotspots. Optional filters: since, before or scope. Results are paginated. API summary: Get deliverability failure hotspots.list_htmlsList htmls. Optional filters: id. API summary: Get raw fake email content.list_imap_accessesList imap accesses. Optional filters: inbox id.list_imap_smtp_accessesList imap smtp accesses. Optional filters: inbox id.list_inbox_emailsList the emails received in one inbox (`inbox_id`), page by page, optionally between `since` and `before`.list_inbox_placement_test_analysisList analysis for a inbox placement test. API summary: Get inbox placement run analysis.list_inbox_placement_test_resultsList results for a inbox placement test. API summary: Get inbox placement test results.list_inbox_placement_testsList inbox placement tests. Results are paginated. API summary: List inbox placement test runs.list_inbox_retention_policiesList inbox retention policies.list_inboxesList your inboxes, page by page, optionally filtered by `search` text, `tag`, `favourite`, `inbox_type` or creation date (`since`, `before`).list_inboxes_accessible_to_an_agentList addresses. Optional filters: sort. Results are paginated. API summary: List inboxes accessible to an agent.list_local_postmaster_domain_snapshotsList domains. API summary: List local Postmaster domain snapshots.list_mailslurp_domainsList mailslurp domains. Optional filters: inbox type. API summary: Get MailSlurp domains.list_mappingsList mappings. Optional filters: ai transform id, entity id, entity type or sort. Results are paginated. API summary: Get transformer mappings.list_mcpsList mcps.list_mcps_authorization_server_metadataList mcps.list_message_delivery_statusesList delivery statuses for a message. Optional filters: sort, since or before. Results are paginated.list_message_device_previewsList device previews for a message. Optional filters: hydrate thumbnail. Results are paginated. API summary: List previous device preview runs for an email.list_message_documents_agent_list_email_attachmentsList documents for a message. API summary: List attachments on a scoped email for an agent.list_message_htmlsList htmls for a message. API summary: Get sent email HTML content.list_message_productsList products for a message. Optional filters: sort. API summary: Get messages in a specific email thread.list_message_rawsList raws for a message. API summary: Get raw sent email string. Returns unparsed raw SMTP message with headers and body.list_message_raws_get_raw_email_contentsList raws for a message. API summary: Get raw email string. Returns unparsed raw SMTP message with headers and body.list_message_threadsList threads for a message. Optional filters: sort. API summary: Get a scoped email thread for an agent.list_messagesList messages. Optional filters: id. API summary: Get a fake email by its ID.list_messages_get_all_spam_emailsList messages. Optional filters: sort, since, before or inbox id. Results are paginated. API summary: Get blocked inbound spam email records in paginated format.list_messages_get_device_preview_runs_for_account_offset_paginatList messages. Optional filters: sort or hydrate thumbnail. Results are paginated. API summary: List previous device preview runs for account in paginated form.list_messages_get_device_preview_runs_offset_paginatedList messages. Optional filters: sort or hydrate thumbnail. Results are paginated. API summary: List previous device preview runs for an email in paginated form.list_messages_get_email_preview_ur_lsList messages for a message. API summary: Get email URLs for viewing in browser or downloading.list_messages_get_email_signatureList messages for a message. API summary: Extract signature from an inbound email.list_messages_get_email_text_linesList messages for a message. Optional filters: decode html entities or line separator. API summary: Extract normalized text lines from email body.list_messages_get_email_warmup_placement_checksList messages for a message. API summary: List Gmail and Outlook placement checks for an email warmup program.list_messages_get_email_warmup_usageList messages. API summary: Get email warmup sender capacity, included credits, and billable usage.list_messages_get_latest_emailList messages. Optional filters: inbox ids. API summary: Get latest email in all inboxes. Most recently received.list_messages_get_latest_email_in_inbox_1List messages. Optional filters: inbox id. API summary: Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.list_messages_get_raw_email_jsonList messages. API summary: Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.list_messages_get_raw_sent_email_jsonList messages. API summary: Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.list_messages_get_sent_email_preview_ur_lsList messages for a message. API summary: Get sent email URL for viewing in browser or downloading.list_messages_get_sent_emails_with_queue_resultsList messages. Optional filters: sort, since or before. Results are paginated. API summary: Get results of email sent with queues in paginated form.list_messages_wait_for_device_preview_email_runsList messages. Optional filters: since, email domain id, profile id, local part, timeout millis or poll interval millis. Results are paginated. API summary: Wait for device preview runs created from account email domains.list_messages_wait_for_device_preview_email_submissionsList messages. Optional filters: since, email domain id, profile id, local part, timeout millis or poll interval millis. Results are paginated. API summary: Wait for received device preview email submissions.list_messages_wait_for_nth_emailList messages. Optional filters: inbox id, index, timeout, unread only, since or before. API summary: 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.list_messages_wait_for_nth_missed_emailList messages. Optional filters: inbox id, timeout, index, since or before. API summary: Wait for Nth missed email.list_monitor_alert_sinksList alert sinks for a monitor. API summary: List alert sinks for monitor.list_monitor_auth_stacksList auth stacks for a monitor. Optional filters: dkim selector. API summary: Get current auth stack for monitor domain.list_monitor_insightsList insights for a monitor. Optional filters: since or before. API summary: Get monitor insights.list_monitor_observed_auth_samplesList observed auth samples for a monitor. API summary: List domain monitor observed authentication samples.list_monitor_runsList runs for a monitor. Optional filters: since, before or status. Results are paginated. API summary: List monitor runs.list_monitor_seriesList series for a monitor. Optional filters: since, before or bucket. API summary: Get monitor trend series.list_monitor_summariesList summaries for a monitor. Optional filters: dkim selector. API summary: Get domain monitor summary.list_monitorsList monitors. API summary: List domain monitors.list_number_messagesList messages for a number. Results are paginated. API summary: Get the latest message preview for a thread.list_number_tagsList tags for a number. API summary: Get phone number tags.list_oauth_authorization_serversList oauth authorization servers.list_oauth_protected_resourcesList oauth protected resources.list_opt_insList opt ins. Optional filters: sort. Results are paginated.list_organization_visible_emailsSearch companies by inbox id, sort, unread only, search filter, since or before. Use this to find existing companies before creating a new company. Results are paginated. API summary: List organization-visible emails.list_outboxesList outboxes. Optional filters: sort. Results are paginated. API summary: List all inboxes with sent emails.list_phone_number_messagesList messages for a phone number. Results are paginated. API summary: List SMS threads.list_plansList plans. API summary: Get phone plans.list_poolsList pools. API summary: Get phone pools.list_previous_device_preview_runs_for_accountList addresses. Optional filters: hydrate thumbnail. Results are paginated. API summary: List previous device preview runs for account.list_probe_insightsList insights for a probe. Optional filters: since or before. API summary: Get campaign probe insights.list_probe_runsList runs for a probe. Optional filters: since, before or status. Results are paginated. API summary: List campaign probe runs.list_probe_seriesList series for a probe. Optional filters: since, before or bucket. API summary: Get campaign probe trend series.list_probesList probes. API summary: List campaign probes.list_productsList products. Optional filters: sort, since or before. Results are paginated. API summary: Get paginated list of reputation items.list_profilesList profiles. API summary: List device preview profiles.list_projectsList projects. Optional filters: sort, since, before or inbox id. Results are paginated. API summary: Get all scheduled email sending jobs for account.list_provider_settingsList provider settings. API summary: Get SMTP and IMAP connection settings for common mail providers.list_providersList providers. API summary: List sending connection providers.list_recipientsList recipients. Optional filters: sort, since or before. Results are paginated. API summary: Get paginated list of bounced recipients.list_release_reassignsList reassigns for a release. API summary: Reassign phone number release.list_releasesList releases. Optional filters: sort. Results are paginated. API summary: Get all phone number releases.list_replier_eventsList events for a replier. Optional filters: sort. Results are paginated. API summary: Get an inbox replier event list.list_repliersList repliers. Optional filters: inbox id, sort, since or before. Results are paginated. API summary: List inbox repliers.list_resultsList results. Optional filters: email id, sms id, attachment id, ai transform id, ai transform mapping id or entity id. Results are paginated. API summary: Get transformer results.list_runsList runs. Optional filters: sort. Results are paginated.list_schedule_executionsList executions for a schedule. Results are paginated. API summary: List schedule executions.list_scheduled_email_warmup_slotsList messages for a message. Results are paginated. API summary: List scheduled email warmup slots.list_schedulesList schedules. API summary: List automated inbox placement schedules.list_scoped_inbox_emails_for_an_agentList messages for a address. Optional filters: sort, since, before or sync connectors. Results are paginated. API summary: List scoped inbox emails for an agent.list_screenshot_imagesList images for a screenshot. API summary: Get a device preview screenshot image.list_sending_connectionsList sending connections.list_sending_consentsList sending consents. Optional filters: email address.list_sent_emailsList emails you have sent, page by page, optionally for one `inbox_id`, by `search_filter` text or date range.list_sent_sms_for_an_assigned_phone_numberSearch messages by sort, since, before or search. Use this to find existing messages before creating a new message. Results are paginated. API summary: List sent SMS for an assigned phone number.list_seriesList series. Optional filters: since, before, scope, bucket or run limit. API summary: Get deliverability analytics time series.list_serversList servers.list_share_analysisList analysis for a share. API summary: Get public inbox placement share analysis.list_simulation_job_eventsList events for a simulation job. Optional filters: sort. Results are paginated. API summary: Get deliverability simulation job events.list_sms_mediaList media for a sms.list_sms_prepaid_creditsList sms prepaid credits. API summary: Get SMS prepaid credits.list_sms_repliesList replies for a sms. API summary: Get reply for an SMS message.list_smtp_accessesList smtp accesses. Optional filters: inbox id.list_spam_test_resultsList results for a spam test. API summary: Get public spam test results.list_summariesList summaries. API summary: Get phone summary.list_supported_message_testing_ai_modelsList messages. API summary: List supported message-testing AI models.list_tablesList tables. Optional filters: email id, sms id, attachment id, ai transform id, ai transform mapping id or entity id. Results are paginated. API summary: Get transformer results table.list_targetsList targets. API summary: List available public email render targets.list_templatesList your saved email templates, with their template IDs for use when sending.list_tenantsList tenants. Optional filters: account region. API summary: Get SES tenant status summary.list_ticketsList tickets. API summary: Get domain issues.list_transformersList transformers. Optional filters: sort. Results are paginated.list_unread_countsList unread counts. API summary: Get unread SMS count.list_unseen_countsList unseen counts. API summary: Get count of unseen webhook results with error status.list_usersList users. Results are paginated.list_v2_resource_typesList resource types for a v2.list_v2_schemasList schemas for a v2.list_v2_service_provider_configsList service provider configs for a v2.list_wait_for_email_countsList wait for email counts. Optional filters: inbox id, timeout, unread only, before, since or sort. Results are paginated. API summary: Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs.list_wait_forsList wait fors. Optional filters: sent id, inbox id, timeout, index, since or before.list_webhook_waitsList waits for a webhook. Optional filters: expected count or timeout. API summary: Wait for webhook results for a webhook.mark_email_readDeletesMark an email (`email_id`) as read, or as unread with `read` set to false.reply_to_emailVisible to othersReply to a received email by `message_id` with a `body` (set `is_html` for HTML). The reply is sent immediately to the original sender.restore_messageChanges dataRestore a message. API summary: Restore missed emails.restore_sending_connectionChanges dataEnable a sending connection (connection id). API summary: Enable a verified Delivery Sender.restore_sending_connection_enableDeletesEnable a sending connection (connection id). Destructive action; may require approval. API summary: Disable Delivery Sender capacity.run_aggregate_email_audit_for_a_stored_emailVisible to othersCreate a new message for a message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Run aggregate email audit for a stored email.run_due_campaign_probes_for_userChanges dataCreate a new run due. API summary: Run due campaign probes for user.search_address_rulesetsSearch rulesets for a address by sort, search filter, since or before. Use this to find existing rulesets before creating a new ruleset. Results are paginated. API summary: List inbox rulesets.search_address_threadsSearch threads for a address by sort, search, since or before. Use this to find existing threads before creating a new thread. Results are paginated. API summary: List scoped inbox threads for an agent.search_addressesChanges dataSearch addresses. Use this to find existing addresses before creating a new address. API summary: Search all inboxes and return matching inboxes.search_aliasesSearch aliases by search, sort, since or before. Use this to find existing aliases before creating a new alias. Results are paginated. API summary: Get all email aliases you have created.search_audit_logsChanges dataSearch audit logs. Use this to find existing audit logs before creating a new audit log.search_automationsSearch automations by sort, since, before, inbox id, phone id or filter. Use this to find existing automations before creating a new automation. Results are paginated.search_biesSearch bies by name, issuer or username. Use this to find existing bies before creating a new by. API summary: Get a TOTP device by username, issuer, or name. Returns empty if not found.search_bies_agent_get_totp_device_bySearch bies by name, issuer or username. Use this to find existing bies before creating a new by. API summary: Find an agent-accessible TOTP device by name, issuer, or username.search_by_namesSearch by names by name. Use this to find existing by names before creating a new by name. API summary: Get phone pool by name.search_companiesSearch companies by inbox id, sort, search filter, since or before. Use this to find existing companies before creating a new company. Results are paginated.search_contactsSearch contacts by sort, search filter, since, inbox id, ai transformer id or phone id. Use this to find existing contacts before creating a new contact. Results are paginated. API summary: List Webhooks Paginated.search_emailsChanges dataSearch received emails across your inboxes with `search_filter` text, optionally limited to `inbox_ids`, `unread_only`, favourites or a date range.search_endpointsSearch endpoints by sort, search filter, since, inbox id, phone id or before. Use this to find existing endpoints before creating a new endpoint. Results are paginated. API summary: List Webhooks endpoints Paginated.search_eventsSearch events by sort, since, before, inbox id, email id or phone id. Use this to find existing events before creating a new event. Results are paginated.search_favoritesSearch favorites by sort, since, before or filter. Use this to find existing favorites before creating a new favorite. Results are paginated.search_feedbackSearch feedback by source, run id, status, provider, category or search. Use this to find existing feedback before creating a new feedback. Results are paginated. API summary: List device preview feedback.search_for_an_inbox_with_the_given_nameSearch by names by name. Use this to find existing by names before creating a new by name. API summary: Search for an inbox with the given name.search_forwardersSearch forwarders by inbox id, sort, search filter, since or before. Use this to find existing forwarders before creating a new forwarder. Results are paginated. API summary: List inbox forwarders.search_guest_portal_usersSearch users for a guest portal by search, sort, since or before. Use this to find existing users before creating a new user. Results are paginated. API summary: Get all guest users for portal.search_mediaSearch media by sort, since, before or search. Use this to find existing media before creating a new medium. Results are paginated.search_messagesSearch messages by inbox id, sort, unread only, search filter, since or before. Use this to find existing messages before creating a new message. Results are paginated. API summary: Get all emails in all inboxes in paginated form. Email API list all.search_messages_get_email_html_querySearch messages for a message by html selector. Use this to find existing messages before creating a new message. API summary: Query hydrated HTML body and return matching text lines.search_messages_get_emails_offset_paginatedSearch messages by inbox id, sort, unread only, search filter, since or before. Use this to find existing messages before creating a new message. Results are paginated. API summary: Get all emails in all inboxes in paginated form. Email API list all.search_messages_get_sent_sms_messages_paginatedSearch messages by phone number, sort, since, before or search. Use this to find existing messages before creating a new message. Results are paginated. API summary: Get all SMS messages in all phone numbers in paginated form. .search_missed_smsSearch missed sms by phone number, sort, since, before or search. Use this to find existing missed sms before creating a new missed sms. Results are paginated. API summary: Get all missed SMS messages in paginated format.search_number_smsSearch sms for a number by sort, unread only, since, before, search or favourite. Use this to find existing sms before creating a new sms. Results are paginated. API summary: List SMS messages for a phone number.search_number_sms_sentsSearch sms sents for a number by sort, since, before or search. Use this to find existing sms sents before creating a new sms sent. Results are paginated. API summary: List sent TXT messages for a phone number.search_numbersSearch numbers by phone country, line type, carrier name, mobile country code, mobile network code or provider label. Use this to find existing numbers before creating a new number. Results are paginated. API summary: Get phone numbers.search_phone_mediaSearch media for a phone by sort, since, before or search. Use this to find existing media before creating a new medium. Results are paginated.search_phone_number_smsSearch sms for a phone number by sort, since, before, search or favourite. Use this to find existing sms before creating a new sms. Results are paginated. API summary: List received SMS for an assigned phone number.search_phone_numbersSearch phone numbers by sort or search. Use this to find existing phone numbers before creating a new phone number. Results are paginated. API summary: List assigned phone numbers.search_pixelsSearch pixels by sort, search filter, since or before. Use this to find existing pixels before creating a new pixel. Results are paginated. API summary: Get tracking pixels.search_provisioningsChanges dataSearch provisionings. Use this to find existing provisionings before creating a new provisioning. API summary: Search available phone numbers.search_resultsSearch results by sort, search filter, since, before, unseen only or result type. Use this to find existing results before creating a new result. Results are paginated. API summary: Get results for all webhooks.search_rulesetsSearch rulesets by inbox id, phone id, sort, search filter, since or before. Use this to find existing rulesets before creating a new ruleset. Results are paginated. API summary: List rulesets block and allow lists.search_scoped_inbox_emails_for_an_agentChanges dataSearch messages by sort, since, before or unread only. Use this to find existing messages before creating a new message. API summary: Search scoped inbox emails for an agent.search_serversChanges dataSearch servers by inbox id. Use this to find existing servers before creating a new server. API summary: Search messages in an inbox.search_smsSearch sms by phone number, sort, since, before, search or favourite. Use this to find existing sms before creating a new sms. Results are paginated.search_tagsSearch tags by search. Use this to find existing tags before creating a new tag. API summary: Get phone tags.search_tenantsSearch tenants by account region. Use this to find existing tenants before creating a new tenant. API summary: Get SES tenant reputation findings.search_tools_bimi_domainChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup a BIMI record policy.search_tools_dkim_domainChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup and validate a DKIM record.search_tools_dmarc_domainChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup a DMARC record policy.search_tools_mta_sts_domainChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup a MTA-STS domain policy.search_tools_mx_recordsChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup a MX records for a domain.search_tools_ptrChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup PTR records for an IP address.search_tools_spf_domainChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup and validate an SPF record.search_tools_tls_reporting_domainChanges dataSearch tools. Use this to find existing tools before creating a new tool. API summary: Lookup a TLS reporting domain policy.search_usersSearch users by portal id, search, sort, since or before. Use this to find existing users before creating a new user. Results are paginated. API summary: Get all guest users for portal.search_v2_groupsSearch groups for a v2 by filter or start index. Use this to find existing groups before creating a new group. Results are paginated.search_v2_usersSearch users for a v2 by filter or start index. Use this to find existing users before creating a new user. Results are paginated.search_validation_requestsSearch validation requests by sort, search filter, since, before or is valid. Use this to find existing validation requests before creating a new validation request. Results are paginated. API summary: Validate a list of email addresses. Per unit billing. See your plan for pricing.search_webhook_resultsSearch results for a webhook by sort, search filter, since, before, unseen only or result type. Use this to find existing results before creating a new result. Results are paginated. API summary: Get a webhook results for a webhook.send_address_domainDeletesEmail a address. Destructive action; may require approval. API summary: Return account device preview email domain setup or create one.send_address_runsVisible to othersEmail a address. Has effects visible outside this system. Results are paginated. API summary: List device preview runs created from account email domains.send_address_submissionsVisible to othersEmail a address. Has effects visible outside this system. Results are paginated. API summary: List received device preview email submissions.send_address_test_emailVisible to othersSend a address (inbox id). Has effects visible outside this system. API summary: Send a test email to inbox.send_an_email_draftVisible to othersSend a message (draft id). Has effects visible outside this system. API summary: Send an email draft.send_an_email_from_an_alias_inboxVisible to othersSend a message (alias id). Has effects visible outside this system. API summary: Send an email from an alias inbox.send_bulkDeletesSend a bulk. Destructive action; may require approval. API summary: Bulk Send Emails.send_callbackVisible to othersEmail a callback. Has effects visible outside this system.send_connectorVisible to othersSend a connector (connector id). Has effects visible outside this system. API summary: Send from an inbox connector.send_contact_bounce_payloadVisible to othersEmail a contact. Has effects visible outside this system.send_contact_bounce_recipient_payloadVisible to othersEmail a contact. Has effects visible outside this system.send_contact_opened_payloadVisible to othersEmail a contact. Has effects visible outside this system.send_contact_read_payloadVisible to othersEmail a contact. Has effects visible outside this system.send_continueVisible to othersSend a continue. Has effects visible outside this system.send_continue_jVisible to othersSend a continue j. Has effects visible outside this system.send_draftVisible to othersSend a draft (draft id). Has effects visible outside this system. API summary: Send a scoped email draft for an agent.send_emailVisible to othersSend an email from one of your inboxes (`address_id`) to the `to` addresses, with `subject` and `body` (set `is_html` for HTML), optional cc, bcc and attachments. The email is sent immediately.send_email_2Visible to othersSend a message. Has effects visible outside this system. API summary: Send email.send_email_queryVisible to othersSend a email query. Has effects visible outside this system. API summary: Send an email using query parameters.send_messageVisible to othersSend a message. Has effects visible outside this system. API summary: Send an email.send_message_address_listVisible to othersEmail a message. Has effects visible outside this system. API summary: Validate a list of email addresses. Per unit billing. See your plan for pricing.send_monitor_verificationVisible to othersEmail a monitor (monitor id). Has effects visible outside this system. API summary: Get domain monitor email verification setup.send_monitor_verification_addressVisible to othersEmail a monitor (monitor id). Has effects visible outside this system. API summary: Create or rotate domain monitor email verification address.send_opt_inVisible to othersSend a opt in. Has effects visible outside this system. API summary: Send a verification code to a user once they have explicitly submitted their email address.send_s3Visible to othersSend a s3 (inbox id). Has effects visible outside this system. API summary: Send SMTP envelope from an S3 body reference.send_smsVisible to othersSend a sms. Has effects visible outside this system.send_smtp_envelopeVisible to othersSend a smtp envelope (inbox id). Has effects visible outside this system. API summary: Send email using an SMTP mail envelope and message body and return sent confirmation.send_streamVisible to othersSend a stream (inbox id). Has effects visible outside this system. API summary: Send SMTP envelope from a streamed body.send_structured_contentVisible to othersEmail a structured content. Has effects visible outside this system. API summary: Generate structured content for an email.send_testDeletesSend a test (webhook id). Destructive action; may require approval. API summary: Send webhook test data.send_txt_message_from_a_phone_numberVisible to othersSend a sms (phone number id). Has effects visible outside this system. API summary: Send TXT message from a phone number.send_verificationMoves moneyEmail a verification. Financial or irreversible action; may require approval. API summary: Delete all validation requests.send_with_queueVisible to othersSend a with queue (inbox id). Has effects visible outside this system. API summary: Send email with queue.send_with_scheduleVisible to othersSend a with schedule (inbox id). Has effects visible outside this system. API summary: Send email with with delay or schedule.start_an_email_warmup_programVisible to othersCreate a new message for a message. Required: expected version. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Start an email warmup program.stop_an_email_warmup_programVisible to othersCreate a new message for a message. Required: expected version. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: Stop an email warmup program.submit_connectionVisible to othersVerify a connection (connection id). Has effects visible outside this system. API summary: Verify a sender connection.submit_connectorVisible to othersSync a connector (connector id). Has effects visible outside this system. API summary: Sync an inbox connector.submit_connector_settingsVisible to othersSync a connector (connector id). Has effects visible outside this system. API summary: Create an inbox connector sync settings.submit_deliverabilityVisible to othersDuplicate a deliverability (test id). Has effects visible outside this system. API summary: Duplicate load test.submit_device_render_testVisible to othersSubmit a device render test (device render test id). Has effects visible outside this system. API summary: Mark a public email render test as submitted.submit_domainVisible to othersSync a domain. Has effects visible outside this system. API summary: Sync Postmaster domains.submit_emlVisible to othersSubmit a eml (device render test id). Has effects visible outside this system. API summary: Submit an EML file to a public email render test.submit_formVisible to othersSubmit a form. Has effects visible outside this system. API summary: Submit a form to be parsed and sent as an email to an address determined by the form fields.submit_htmlVisible to othersSubmit a html (device render test id). Has effects visible outside this system. API summary: Submit HTML to a public email render test.submit_messageVisible to othersValidate a message (email id). Has effects visible outside this system. API summary: Validate email HTML contents.submit_message_completeVisible to othersComplete a message. Has effects visible outside this system.submit_phoneVisible to othersValidate a phone. Has effects visible outside this system. API summary: Verify validity of a phone number.submit_sending_connectionVisible to othersVerify a sending connection (connection id). Has effects visible outside this system.submit_spam_testVisible to othersSubmit a spam test (spam test id). Has effects visible outside this system. API summary: Mark a public spam test as submitted.submit_structured_contentVisible to othersValidate a structured content. Has effects visible outside this system. API summary: Validate structured content schema.submit_taskVisible to othersComplete a task (conversation id). Has effects visible outside this system. API summary: Complete a work item with an idempotent reply.submit_traffic_statVisible to othersSync a traffic stat (domain). Has effects visible outside this system. API summary: Sync Postmaster traffic stats.submit_webhookDeletesVerify a webhook. Destructive action; may require approval. API summary: Verify a webhook payload signature.update_a_draft_email_warmup_programVisible to othersUpdate an existing message identified by message id. Has effects visible outside this system. API summary: Update a draft email warmup program.update_address_draftVisible to othersUpdate an existing draft identified by draft id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update a scoped email draft for an agent.update_address_favouritesVisible to othersUpdate an existing favourite identified by inbox id. Has effects visible outside this system. API summary: Set inbox favourited state.update_aliasChanges dataUpdate an existing alias identified by alias id. API summary: Update an email alias.update_alias_messageVisible to othersUpdate an existing message identified by message id. Has effects visible outside this system. API summary: Reply to an email.update_an_email_draftVisible to othersUpdate an existing message identified by message id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update an email draft.update_connectionChanges dataUpdate an existing connection identified by connection id. Only the fields you pass are changed. API summary: Update a sender connection.update_connectorChanges dataUpdate an existing connector identified by connector id. API summary: Update an inbox connector.update_connector_imapsVisible to othersUpdate an existing imap identified by connector id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update an inbox connector IMAP connection.update_connector_smtpsVisible to othersUpdate an existing smtp identified by connector id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update an inbox connector SMTP connection.update_deliverabilityChanges dataUpdate an existing deliverability identified by test id. Only the fields you pass are changed. API summary: Update load test.update_deviceChanges dataUpdate an existing device identified by device id. API summary: Update a TOTP device.update_domainChanges dataUpdate an existing domain identified by domain id. API summary: Update a domain.update_exportChanges dataUpdate an existing export identified by export id. API summary: Get export transformer results job.update_feedbackChanges dataUpdate an existing feedback identified by feedback id. API summary: Update device preview feedback.update_forwarderChanges dataUpdate an existing forwarder identified by forwarder id. API summary: Update an inbox forwarder.update_forwardersVisible to othersUpdate an existing forwarder. Only the fields you pass are changed. Has effects visible outside this system. API summary: Test new inbox forwarder.update_group_contactsVisible to othersUpdate an existing contact identified by group id. Has effects visible outside this system. API summary: Add contacts to a group.update_imap_accessesVisible to othersUpdate an existing imap access. Only the fields you pass are changed. Has effects visible outside this system.update_inboxChanges dataUpdate an inbox by `address_id`: change its `name`, `description`, `tags`, `favourite` flag or `expires_at`.update_inbox_retention_policyChanges dataUpdate an existing inbox retention policy identified by policy id.update_message_claimVisible to othersUpdate an existing claim identified by claim id. Has effects visible outside this system. API summary: Renew an SMS conversation claim.update_message_claim_agent_renew_conversation_claimChanges dataUpdate an existing claim identified by claim id. API summary: Renew a conversation claim.update_message_favouritesDeletesUpdate an existing favourite identified by email id. Destructive action; may require approval. API summary: Set email favourited state.update_messagesVisible to othersUpdate an existing message. Has effects visible outside this system. API summary: Update purchased Delivery Sender seats.update_messages_ensure_device_preview_runDeletesUpdate an existing message identified by email id. Destructive action; may require approval. API summary: Return active run for email or create one when none exists.update_monitorChanges dataUpdate an existing monitor identified by monitor id. API summary: Update domain monitor.update_numberChanges dataUpdate an existing number identified by phone number id. API summary: Update a phone number.update_number_favouritesVisible to othersUpdate an existing favourite identified by phone number id. Has effects visible outside this system. API summary: Set phone favourited state.update_number_tagsVisible to othersUpdate an existing tag identified by phone number id. Has effects visible outside this system. API summary: Set phone number tags.update_poolChanges dataUpdate an existing pool identified by pool id. API summary: Update phone pool.update_probeChanges dataUpdate an existing probe identified by probe id. API summary: Update campaign probe.update_profileChanges dataUpdate an existing profile identified by profile id. API summary: Update a device preview profile.update_readsDeletesUpdate an existing read. Only the fields you pass are changed. Destructive action; may require approval. API summary: Mark all SMS messages as read or unread.update_replierChanges dataUpdate an existing replier identified by replier id. API summary: Update an inbox replier.update_replier_activesVisible to othersUpdate an existing active identified by replier id. Has effects visible outside this system. API summary: Update an inbox replier's active state.update_rulesetChanges dataUpdate an existing ruleset identified by ruleset id. API summary: Update a ruleset.update_rulesetsVisible to othersUpdate an existing ruleset. Only the fields you pass are changed. Has effects visible outside this system. API summary: Test new ruleset.update_scheduleChanges dataUpdate an existing schedule identified by schedule id. Only the fields you pass are changed. API summary: Update an automated inbox placement schedule.update_sending_connectionChanges dataUpdate an existing sending connection identified by connection id. Only the fields you pass are changed. API summary: Update a sending connection.update_servers_flagsChanges dataUpdate an existing server.update_sms_favouritesDeletesUpdate an existing favourite identified by sms id. Destructive action; may require approval.update_sms_readsDeletesUpdate an existing read identified by sms id. Only the fields you pass are changed. Destructive action; may require approval. API summary: Mark an SMS as read or unread.update_smtp_accessesVisible to othersUpdate an existing smtp access. Only the fields you pass are changed. Has effects visible outside this system.update_subdomainsDeletesUpdate an existing subdomain. Destructive action; may require approval. API summary: Update account device preview email subdomain.update_templateChanges dataUpdate an existing template identified by template id. API summary: Update template.update_v2_groupChanges dataUpdate an existing group identified by group id. Only the fields you pass are changed.update_v2_userChanges dataUpdate an existing user identified by user id. Only the fields you pass are changed.update_webhookDeletesUpdate an existing webhook identified by webhook id. Only the fields you pass are changed. Destructive action; may require approval. API summary: Update a webhook.update_webhook_headersMoves moneyUpdate an existing header identified by webhook id. Financial or irreversible action; may require approval. API summary: Update a webhook request headers.upload_addressChanges dataImport a address. API summary: Create a device preview run from imported raw MIME.upload_address_addressesChanges dataImport a address. API summary: Create a temporary email address for device preview import.upload_byteChanges dataUpload a byte. API summary: Upload an attachment for sending using file byte stream input octet stream.upload_documentChanges dataUpload a document. API summary: Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.upload_messageVisible to othersImport a message (inbox id). Has effects visible outside this system. API summary: Import email into inbox from base64 MIME.upload_multipartChanges dataUpload a multipart. API summary: Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.wait_for_emailsChanges dataWait until emails matching conditions arrive in an inbox. Requires `inbox_id` and `timeout` (milliseconds); optional `count`, `matches` (field conditions such as subject or sender) and `unread_only`.wait_for_latest_emailWait until an email arrives in an inbox (`inbox_id`) and return the latest one. Set `timeout` in milliseconds, and `unread_only` or `since` to ignore older emails.
Set up in three steps
- 1
Pick the app
Create a free HeyMyApps account and choose MailSlurp from the app list.
- 2
Paste your key
Paste your MailSlurp API key. Sign up or log in at app.mailslurp.com and copy the key from the API section of the dashboard.
- 3
Add the link to your AI
You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:
- Click your name, then Settings › Connectors › Add custom connector.
- Paste your link as the Remote MCP server URL.
- Switch it on from the + menu in a chat.
Questions
What can the AI do in MailSlurp?
The AI can create, list, find, read and update inboxes, wait for new emails, and list, search and read received and sent emails. It can extract verification codes, list links and attachments, download attachments and mark emails as read. It can send, reply to and forward emails, list templates, and list and create contacts. It can also delete an inbox or an email if you switch those tools on.
Does the AI see my MailSlurp API key?
No. Your MailSlurp credentials are encrypted at rest and never shown to the AI. After you save them, they are not shown again, not even to you. The AI only sees the results of the tools it calls.
Can I control what the AI is allowed to do?
Yes. You choose which tools are switched on, so you can start read-only. Sending, replying and forwarding go out immediately, and deleting an inbox or an email cannot be undone. These can require your approval before they run. Every tool call is logged.
Does it work with ChatGPT?
Yes. In ChatGPT go to Settings › Apps & Connectors › Advanced and turn on Developer mode, then add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.
What does it cost?
HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own MailSlurp account.
Can the AI wait for an email to arrive?
Yes. The AI can wait until an email arrives in an inbox, up to a timeout you set in milliseconds, or until a number of emails that match conditions such as subject or sender have arrived. That is handy when you test a signup or password reset: it waits for the email, then reads it and pulls out the code or link.
Let your AI work in MailSlurp today.
Start free. Your key stays encrypted, and you decide what the AI may do.
Connect MailSlurp freeHeyMyApps is not affiliated with MailSlurp. Product names are trademarks of their owners.