BotMailRoom

Support

Verify Domain

DNSRecordStatus

Location

Message

Error Type

ValidationError

HTTPBearer

VerifyDomainResponse

HTTPValidationError

Create an inbox and start receiving emails

Quickstart

Send an Email

Specify who is allowed to send emails to your inbox

Custom Authentication Rules

Automatically trigger workflows and agents when an email is received

Receiving Emails via Webhook

Use your own domain in your inbox email address

Custom Domains

Send Email

Get a list of all emails for the user - only returns the metadata of the emails

Get Emails

Get the metadata and content of an email. Only attachment metadata is included, use the `Get Email Attachment` endpoint to get the raw attachment. Only available for valid emails.

Get Email Content

Get the raw attachment bytes of an email. Only available for valid emails.

Get Email Attachment

Get the entire unparsed email file as an EML file. Only available for valid
emails.

Get Email Raw

Mark an email as valid (if it is not already valid) or invalid (if it is not
already invalid).

Mark Email

Add an attachment to the attachments pool. Only attachments in the pool can be used in `send_email` requests.

Add Attachment To Pool

Get the a list of all emails sent by the user - only returns the metadata of the outbound emails

Get Outbound Emails

Get the metadata and content of an outbound email. Only attachment metadata is included, use the `Get Outbound Email Attachment` endpoint to get the raw attachment.

Getting Started

Email

Inbox

Domain

Tools

Verify Domain

Authorizations

Path Parameters

Response