messages.getRaw
Get raw MIME message body.
Streams the full raw RFC 5322 MIME message bytes directly from storage. Works for active messages and trash messages.
openemail.messages.getRaw(
mailboxId: string,
messageId: string,
options?: MessagesGetRawOptions,
): ApiPromise<Blob>It calls GET /mailboxes/{mailboxId}/messages/{messageId}/raw: Get raw MIME message body in the API reference.
Example
const blob = await openemail.messages.getRaw(mailboxId, messageId)Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
messageId | string | Message ULID identifier. The path's {messageId}. |
Options
The last argument, options, a MessagesGetRawOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
ifNoneMatch | string | header if-none-match | Revalidation ETag from previous response |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is a Blob: the bytes the API answers, with their media type. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Mailbox or message not found |
500 | blob_missing — metadata exists but message storage blob read failed |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.