Skip to Content

The AttachmentRef type of the TypeScript SDK, part of ContentResult.

type AttachmentRef = {
  contentId: string | null
  contentType: string
  degraded?: boolean
  filename: string
  inline: boolean
  section: string
  size: number
}

Fields

FieldTypeDescription
contentIdstring | nullContent-ID header value for inline referencing, or null
contentTypestringAttachment MIME content type
degradedbooleanOptional. True if attachment was generated from fallback decoding
filenamestringAttachment filename
inlinebooleanTrue if attachment is meant for inline rendering
sectionstringMIME part section identifier to fetch via /parts/:section
sizenumberDecoded attachment file size in bytes

Used in

ContentResult.

On this page