Skip to Content

The HeadBatch type of the TypeScript SDK, which messages.getRawHeaders take or answer.

type HeadBatch = {
  heads: Record<string, HeadEntry | null>
}

Fields

FieldTypeDescription
headsRecord<string, HeadEntry | null>Map of message ID to its header block, one entry per distinct requested id. Null means the message is unknown, not live (pending or in the trash tier), outside the caller's folder scope, or its blob is unreadable — in every case, read the whole message instead.

Used by

MethodWhat it does
messages.getRawHeadersBatch get raw header blocks

On this page