Getting Started
Tools
Get Outbound Email Content
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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
The id of the email that this email is a reply to, as passed in the In-Reply-To header. If null, this email is not a reply to another email
The message id of the email, as passed in the Message-ID header. This is not the same as the BotMailRoom email id but rather is an id used by email clients and servers to identify emails
The email formatted as markdown that can be passed into an LLM prompt
A list of ids of emails that precede this email in a conversation thread, as passed in the References header. If null, this email is not part of a conversation thread
The entire email thread formatted as markdown that can be passed into an LLM prompt. If the email is not part of a thread or is not the root email, this will be the same as the prompt property
If true, html and plain_text are alternative representations of the same content
Metadata about the attachments of the email, does not include the actual attachment data. Use the relevant get attachment endpoints to retrieve the attachment data
The encoding of the attachment, as passed in the Content-Transfer-Encoding header
Uniquely identifies a part of a multipart message, as passed in the Content-ID header
The html content of the email. Can be null if the email is only available in plain text
The plain text content of the email. Can be null if the email is only available in html
A list of emails that precede the root email in a conversation thread, as passed in the References header. If an email is not part of a conversation thread or is not the root email, this field will be null
The id of the email that this email is a reply to, as passed in the In-Reply-To header. If null, this email is not a reply to another email
The message id of the email, as passed in the Message-ID header. This is not the same as the BotMailRoom email id but rather is an id used by email clients and servers to identify emails
The email formatted as markdown that can be passed into an LLM prompt
A list of ids of emails that precede this email in a conversation thread, as passed in the References header. If null, this email is not part of a conversation thread
The entire email thread formatted as markdown that can be passed into an LLM prompt. If the email is not part of a thread or is not the root email, this will be the same as the prompt property
If true, html and plain_text are alternative representations of the same content
Metadata about the attachments of the email, does not include the actual attachment data. Use the relevant get attachment endpoints to retrieve the attachment data
The encoding of the attachment, as passed in the Content-Transfer-Encoding header
Uniquely identifies a part of a multipart message, as passed in the Content-ID header
The html content of the email. Can be null if the email is only available in plain text
The plain text content of the email. Can be null if the email is only available in html
A list of emails that precede the root email in a conversation thread, as passed in the References header. If an email is not part of a conversation thread or is not the root email, this field will be null
The id of the email that this email is a reply to, as passed in the In-Reply-To header. If null, this email is not a reply to another email
The message id of the email, as passed in the Message-ID header. This is not the same as the BotMailRoom email id but rather is an id used by email clients and servers to identify emails
The email formatted as markdown that can be passed into an LLM prompt
A list of ids of emails that precede this email in a conversation thread, as passed in the References header. If null, this email is not part of a conversation thread
The entire email thread formatted as markdown that can be passed into an LLM prompt. If the email is not part of a thread or is not the root email, this will be the same as the prompt property
If true, html and plain_text are alternative representations of the same content
Metadata about the attachments of the email, does not include the actual attachment data. Use the relevant get attachment endpoints to retrieve the attachment data
The encoding of the attachment, as passed in the Content-Transfer-Encoding header
Uniquely identifies a part of a multipart message, as passed in the Content-ID header
The html content of the email. Can be null if the email is only available in plain text
The plain text content of the email. Can be null if the email is only available in html
A list of emails that precede the root email in a conversation thread, as passed in the References header. If an email is not part of a conversation thread or is not the root email, this field will be null
The id of the email that this email is a reply to, as passed in the In-Reply-To header. If null, this email is not a reply to another email
The message id of the email, as passed in the Message-ID header. This is not the same as the BotMailRoom email id but rather is an id used by email clients and servers to identify emails
The email formatted as markdown that can be passed into an LLM prompt
A list of ids of emails that precede this email in a conversation thread, as passed in the References header. If null, this email is not part of a conversation thread
The entire email thread formatted as markdown that can be passed into an LLM prompt. If the email is not part of a thread or is not the root email, this will be the same as the prompt property
If true, html and plain_text are alternative representations of the same content
Metadata about the attachments of the email, does not include the actual attachment data. Use the relevant get attachment endpoints to retrieve the attachment data
The encoding of the attachment, as passed in the Content-Transfer-Encoding header
Uniquely identifies a part of a multipart message, as passed in the Content-ID header
The html content of the email. Can be null if the email is only available in plain text
The plain text content of the email. Can be null if the email is only available in html
A list of emails that precede the root email in a conversation thread, as passed in the References header. If an email is not part of a conversation thread or is not the root email, this field will be null
The id of the email that this email is a reply to, as passed in the In-Reply-To header. If null, this email is not a reply to another email
The message id of the email, as passed in the Message-ID header. This is not the same as the BotMailRoom email id but rather is an id used by email clients and servers to identify emails
The email formatted as markdown that can be passed into an LLM prompt
A list of ids of emails that precede this email in a conversation thread, as passed in the References header. If null, this email is not part of a conversation thread
The entire email thread formatted as markdown that can be passed into an LLM prompt. If the email is not part of a thread or is not the root email, this will be the same as the prompt property
If true, html and plain_text are alternative representations of the same content
Metadata about the attachments of the email, does not include the actual attachment data. Use the relevant get attachment endpoints to retrieve the attachment data
The html content of the email. Can be null if the email is only available in plain text
The plain text content of the email. Can be null if the email is only available in html
A list of emails that precede the root email in a conversation thread, as passed in the References header. If an email is not part of a conversation thread or is not the root email, this field will be null