Skip to Content

Get parsed message content and attachments.

Returns decoded email headers, inline plain text and HTML bodies, and attachment metadata for a message.

openemail.messages.getContent(
  mailboxId: string,
  messageId: string,
  options?: MessagesGetContentOptions,
): ApiPromise<ContentResult>

It calls GET /mailboxes/{mailboxId}/messages/{messageId}/content: Get parsed message content and attachments in the API reference.

Example

const contentResult = await openemail.messages.getContent(mailboxId, messageId)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
messageIdstringMessage ULID identifier. The path's {messageId}.

Options

The last argument, options, a MessagesGetContentOptions, takes:

OptionTypeSent asDescription
ifNoneMatchstringheader if-none-matchRevalidation ETag from a previous response; on match the answer is 304

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, ContentResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox or message not found
413message_too_large
422unparseable_message or message_too_complex
500blob_missing
503temporary_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.

Types

It names these types of the API, each on a page of its own: ContentResult.