jmap-kit
    Preparing search index...

    Type Alias EmailParseRequestInvocationArgs

    The arguments for parsing Email objects via an Email/parse call

    type EmailParseRequestInvocationArgs = {
        accountId: Id;
        blobIds: Id[];
        bodyProperties?: string[];
        fetchAllBodyValues?: boolean;
        fetchHTMLBodyValues?: boolean;
        fetchTextBodyValues?: boolean;
        maxBodyValueBytes?: UnsignedInt;
        properties?: (keyof EmailObject)[];
    }
    Index

    Properties

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

    Properties

    accountId: Id

    The id of the account to use.

    blobIds: Id[]

    The ids of the blobs to parse.

    bodyProperties?: string[]

    A list of properties to fetch for each EmailBodyPart returned. If omitted, defaults to the same value as the Email/get “bodyProperties” default argument.

    fetchAllBodyValues?: boolean

    (default: false) If true, the bodyValues property includes any text/* part in the bodyStructure property.

    fetchHTMLBodyValues?: boolean

    (default: false) If true, the bodyValues property includes any text/* part in the htmlBody property.

    fetchTextBodyValues?: boolean

    (default: false) If true, the bodyValues property includes any text/* part in the textBody property.

    maxBodyValueBytes?: UnsignedInt

    (default: 0) If greater than zero, the value property of any EmailBodyValue object returned in bodyValues MUST be truncated if necessary so it does not exceed this number of octets in size. If 0 (the default), no truncation occurs.

    properties?: (keyof EmailObject)[]

    If supplied, only the properties listed in the array are returned for each Email object. If omitted, defaults to:

    [ "messageId", "inReplyTo", "references", "sender", "from", "to",
  "cc", "bcc", "replyTo", "subject", "sentAt", "hasAttachment",
  "preview", "bodyValues", "textBody", "htmlBody", "attachments" ]`

    Settings

    Member Visibility

    On This Page

    Properties