jmap-kit
    Preparing search index...

    Type Alias EmailBodyPart

    These properties are derived from the message body RFC 5322 and its MIME entities RFC 2045.

    type EmailBodyPart = {
        blobId?: Id | null;
        charset?: string | null;
        cid?: string | null;
        disposition?: string | null;
        headers: EmailHeader[];
        language?: string[] | null;
        location?: string | null;
        name?: string | null;
        partId?: string | null;
        size: UnsignedInt;
        subParts?: EmailBodyPart[] | null;
        type: string;
    }
    Index

    Properties

    blobId? charset? cid? disposition? headers language? location? name? partId? size subParts? type

    Properties

    blobId?: Id | null

    The id representing the raw octets of the contents of the part, after decoding any known Content-Transfer-Encoding (as defined in RFC 2045), or null if, and only if, the part is of type multipart/*. Note that two parts may be transfer-encoded differently but have the same blob id if their decoded octets are identical and the server is using a secure hash of the data for the blob id. If the transfer encoding is unknown, it is treated as though it had no transfer encoding.

    charset?: string | null

    The value of the charset parameter of the Content-Type header field, if present, or null if the header field is present but not of type text/*. If there is no Content-Type header field, or it exists and is of type text/* but has no charset parameter, this is the implicit charset as per the MIME standard: us-ascii.

    cid?: string | null

    The value of the Content-Id header field of the part, if present; otherwise it’s null. CFWS and surrounding angle brackets (<>) are removed. This may be used to reference the content from within a text/html body part HTML using the cid: protocol, as defined in RFC 2392.

    disposition?: string | null

    The value of the Content-Disposition header field of the part, if present; otherwise, it’s null. CFWS is removed and any parameters are stripped.

    headers: EmailHeader[]

    This is a list of all header fields in the part, in the order they appear in the message. The values are in Raw form.

    language?: string[] | null

    The list of language tags, as defined in RFC 3282, in the Content-Language header field of the part, if present.

    location?: string | null

    The URI, as defined in RFC 2557, in the Content-Location header field of the part, if present.

    name?: string | null

    This is the decoded filename parameter of the Content-Disposition header field per RFC 2231, or (for compatibility with existing systems) if not present, then it’s the decoded name parameter of the Content-Type header field per RFC 2047.

    partId?: string | null

    Identifies this part uniquely within the Email. This is scoped to the emailId and has no meaning outside of the JMAP Email object representation. This is null if, and only if, the part is of type multipart/*.

    size: UnsignedInt

    The size, in octets, of the raw data after content transfer decoding (as referenced by the blobId, i.e., the number of octets in the file the user would download).

    subParts?: EmailBodyPart[] | null

    If the type is multipart/*, this contains the body parts of each child.

    type: string

    The value of the Content-Type header field of the part, if present; otherwise, the implicit type as per the MIME standard (text/plain or message/rfc822 if inside a multipart/digest). CFWS is removed and any parameters are stripped.

    Settings

    Member Visibility

    On This Page

    Properties