Skip to Content

Get specific message MIME part.

Streams a single decoded MIME part or raw encoded slice from message storage by section number.

openemail.messages.getPart(
  mailboxId: string,
  messageId: string,
  section: string,
  options?: MessagesGetPartOptions,
): ApiPromise<Blob>

It calls GET /mailboxes/{mailboxId}/messages/{messageId}/parts/{section}: Get specific message MIME part in the API reference.

Example

const blob = await openemail.messages.getPart(mailboxId, messageId, section)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
messageIdstringMessage ULID identifier. The path's {messageId}.
sectionstringIMAP section number (e.g. 1, 2, 3.1) from /content attachments[].section. The path's {section}.

Options

The last argument, options, a MessagesGetPartOptions, takes:

OptionTypeSent asDescription
rawbooleanquery rawSet to 'true' to return raw undecoded transfer bytes instead of decoded content
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 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

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox, message, or MIME section 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.