Skip to Content

The HeadEntry type of the TypeScript SDK, part of HeadBatch.

type HeadEntry = {
  header: string | null
  truncated: boolean
}

Fields

FieldTypeDescription
headerstring | nullBase64 of the message's raw header block as stored — every header line byte-for-byte, line endings preserved, up to and including the blank separator line (what IMAP BODY[HEADER] returns). The separator is the first empty line, LF or CRLF on either side; a message with no blank line at all is all headers and is returned whole. Null when truncated.
truncatedbooleanTrue when the header block runs past the 64 KB head window this read is bounded to; the caller must read the whole message (/raw) for it. Header is null in that case.

Used in

HeadBatch.

On this page