Interface EmailGetRequest

RFC 8621 (4.2) - https://datatracker.ietf.org/doc/html/rfc8621#section-4.2

interface EmailGetRequest {
    accountId: string;
    bodyProperties?: (keyof EmailBodyPartFields)[];
    fetchAllBodyValues?: boolean;
    fetchHTMLBodyValues?: boolean;
    fetchTextBodyValues?: boolean;
    ids?: null | string[];
    maxBodyValueBytes?: number;
    properties?:
        | null
        | (
            | (keyof EmailMetadataFields)
            | (keyof EmailHeaderFields)
            | (keyof EmailBodyPart)
        )[];
}

Hierarchy (View Summary)

Properties

accountId bodyProperties? fetchAllBodyValues? fetchHTMLBodyValues? fetchTextBodyValues? ids? maxBodyValueBytes? properties?

Properties

accountId

accountId: string

OptionalbodyProperties

bodyProperties?: (keyof EmailBodyPartFields)[]

Props in textBody and etc. default: [ "partId", "blobId", "size", "name", "type", "charset", "disposition", "cid", "language", "location" ]

OptionalfetchAllBodyValues

fetchAllBodyValues?: boolean

default: false

OptionalfetchHTMLBodyValues

fetchHTMLBodyValues?: boolean

default: false

OptionalfetchTextBodyValues

fetchTextBodyValues?: boolean

default: false

Optionalids

ids?: null | string[]

If null, then all records of the data type are returned, if this is supported for that data type and the number of records does not exceed the "maxObjectsInGet" limit.

OptionalmaxBodyValueBytes

maxBodyValueBytes?: number

uint default: 0

Optionalproperties

properties?:
    | null
    | (
        | (keyof EmailMetadataFields)
        | (keyof EmailHeaderFields)
        | (keyof EmailBodyPart)
    )[]

[ "id", "blobId", "threadId", "mailboxIds", "keywords", "size", "receivedAt", "messageId", "inReplyTo", "references", "sender", "from", "to", "cc", "bcc", "replyTo", "subject", "sentAt", "hasAttachment", "preview", "bodyValues", "textBody", "htmlBody", "attachments" ]

Settings

Member Visibility

On This Page

Properties