Skip to main content
POST
email.message.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
inbox
string
required

The inbox address the message belongs to.

Required string length: 1 - 320
ref
string

The ref a send, reply or draft-send returned. Preferred over messageId.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
messageId
string

The message's public RFC Message-ID, e.g. abc@example.com.

Required string length: 1 - 998

Response

The result

messageId
string
required

The message's RFC Message-ID, e.g. abc@example.com. It is public: pass it wherever a capability asks for a message.

inbox
string
required

The inbox address the message belongs to.

from
string
required

Sender, e.g. "Jane Doe jane@example.com".

to
string[]
required

Recipient addresses.

text
string
required

Sanitised plain-text body: the text part, or the HTML part read as text.

autoSubmitted
enum<string>

Automatic mail marker; absent for ordinary mail.

Available options:
auto-generated,
auto-replied,
other
cc
string[]

Copy recipients.

subject
string

Subject line.

preview
string

Short plain-text preview of the body.

timestamp
string

When the message was sent or received, ISO 8601.

labels
string[]

Labels on the message.

attachments
object[]

Attachments, metadata only.

extractedText
string

New content only, quoted history and boilerplate stripped.

bcc
string[]

Hidden copy recipients.

replyTo
string[]

Addresses replies were requested to go to.

inReplyTo
string

RFC Message-ID this message replies to, when it is a reply.

size
number

Size in bytes.