Skip to main content
MailSlurp logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: MAILSLURP
  • Version: 20261101_00

Tools

Slug: MAILSLURP_CREATE_INBOXCreate a MailSlurp HTTP or SMTP inbox. HTTP inboxes are the default and can send and receive; SMTP inboxes are receive-only. You can specify tags and other inbox settings. If requested tags cannot be applied, the tool attempts to delete the new inbox; it may remain if deletion fails.

Input Parameters

string
Human-readable inbox name, also usable as the sender display name.
array
Tags used to group and search inboxes.
string
Optional prefix for an automatically assigned email address.
string
Optional verified custom-domain UUID.
boolean
Mark the new inbox as a favorite.
string
Optional ISO-8601 expiration timestamp; do not combine with expires_in.
integer
Optional lifetime in milliseconds; do not combine with expires_at.
string ("HTTP_INBOX" | "SMTP_INBOX")
HTTP_INBOX for send/receive workflows or SMTP_INBOX for receive-only workflows.
string
Description used for labeling and search.
string
Optional verified domain name used with an assigned local part.
string
Optional address on a verified custom domain; omit for an assigned MailSlurp address.
boolean
Prevent real outbound delivery while still creating sent-email records.
boolean
Use MailSlurp’s varied domain pool for an HTTP inbox.
boolean
Request an automatically generated address shorter than 31 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_DELETE_INBOXPermanently delete one MailSlurp inbox by UUID, including its email address and all emails it contains. This destructive action cannot be undone.

Input Parameters

string
required
Exact inbox UUID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_GET_ACCOUNT_INFOReturn the connected MailSlurp account identity, state, account type, subscription type, and creation time. Use this to check account availability before attempting quota- or plan-sensitive operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_GET_EMAILGet one fully hydrated received email by UUID, including parsed headers, body content, recipients, and attachment IDs. Fetching hydrated content may mark the email as read.

Input Parameters

string
required
Email UUID returned by list emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_GET_INBOXGet one MailSlurp inbox by UUID, including its email address, type, labels, and lifecycle state.

Input Parameters

string
required
Inbox UUID returned by create or list inboxes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_CONTACT_GROUPSList saved MailSlurp contact groups with optional creation-time filters. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum groups in this page (1-100).
string ("ASC" | "DESC")
Sort by creation time: ASC or DESC.
string
Only groups created at or after this ISO-8601 timestamp.
string
Only groups created before this ISO-8601 timestamp.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_CONTACTSList saved MailSlurp contacts with optional search and creation-time filters. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum contacts in this page (1-100).
string ("ASC" | "DESC")
Sort by creation time: ASC or DESC.
string
Only contacts created at or after this ISO-8601 timestamp.
string
Only contacts created before this ISO-8601 timestamp.
Search contact names and addresses.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_DOMAINSList custom domains configured for the connected MailSlurp account, including identifiers, domain type, and DNS verification state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_EMAILSList received emails across the account or one selected inbox with unread, exact-search, favorite, plus-address, and time filters. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum emails in this page (1-100).
string ("ASC" | "DESC")
Sort by received time: ASC or DESC.
string
Only emails received at or after this ISO-8601 timestamp. Set this explicitly to avoid the provider’s default previous-24-hours window.
string
Only emails received before this ISO-8601 timestamp.
string
Inbox UUID to include; omit to search all account inboxes.
boolean
When set, filter by favorite status.
string
Opaque cursor returned by the previous page; omit for the first page.
boolean
Return unread emails only.
string
Exact match against email ID, inbox ID, sender, receiving address, or plus address.
string
Optional plus-address UUID filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_INBOXESList MailSlurp inboxes with optional search, tag, type, domain, favorite, and creation-time filters. Returns one page and a continuation cursor.

Input Parameters

string
Return inboxes containing this tag.
integer
Maximum inboxes in this page (1-100).
string ("ASC" | "DESC")
Sort by creation time: ASC or DESC.
string
Only inboxes created at or after this ISO-8601 timestamp.
string
Only inboxes created before this ISO-8601 timestamp.
string
Partial search over inbox name and email address.
string
Filter by custom domain UUID.
boolean
When set, filter by favorite status.
string ("HTTP_INBOX" | "SMTP_INBOX")
Filter by HTTP_INBOX or SMTP_INBOX.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_SENT_EMAILSList sent-email records, optionally filtered by source inbox, exact identifier/address search, and creation time. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum sent-email records in this page (1-100).
string ("ASC" | "DESC")
Sort by creation time: ASC or DESC.
string
Only records created at or after this ISO-8601 timestamp.
string
Only records created before this ISO-8601 timestamp.
string
Only messages sent from this inbox UUID.
string
Opaque cursor returned by the previous page; omit for the first page.
string
Exact match for sent-email ID, inbox ID, sender, or reply-to address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_LIST_TEMPLATESList saved MailSlurp email templates with optional creation-time filters. Returns one page and a continuation cursor without large template bodies.

Input Parameters

integer
Maximum templates in this page (1-100).
string ("ASC" | "DESC")
Sort by creation time: ASC or DESC.
string
Only templates created at or after this ISO-8601 timestamp.
string
Only templates created before this ISO-8601 timestamp.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_SEND_EMAILSend an email from a specific MailSlurp inbox to addresses, saved contacts, or one contact group. Supports plain text or HTML, uploaded attachment IDs, and saved templates. The legacy endpoint confirms acceptance but does not return a sent-email record.

Input Parameters

array
CC recipient addresses.
array
RFC 5322 recipient addresses; provide this, contact_ids, or contact_group_id.
array
BCC recipient addresses.
string
Plain-text or HTML body; omit when template_id supplies the body.
boolean
Set true when body contains HTML.
string
Email subject.
string
required
HTTP inbox UUID to send from; SMTP inboxes cannot send.
string
Optional Reply-To address.
array
Saved contact UUIDs; each contact receives a separate message.
string
Saved template UUID; do not combine with body because the template overrides it.
array
Previously uploaded MailSlurp attachment IDs.
boolean
Use the inbox name as the sender display name.
string
Saved contact-group UUID; recipients receive separate messages.
boolean
Add an open-tracking pixel.
object
Values for moustache variables used by the subject, body, or saved template.
boolean
Remove recipients previously recorded as bounced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSLURP_UPDATE_INBOXUpdate an inbox’s name, description, tags, expiration, or favorite status. Provide at least one field to update. The inbox email address cannot be changed.

Input Parameters

string
New inbox name; omit to leave unchanged.
array
Replacement tag list; omit to leave unchanged.
string
required
Inbox UUID to update.
boolean
New favorite status; omit to leave unchanged.
string
New ISO-8601 expiration timestamp; omit to leave unchanged or set null to make the inbox permanent.
string
New inbox description; omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not