jmap-kit
    Preparing search index...

    Type Alias EmailGetRequestInvocationArgs

    EmailGetRequestInvocationArgs: BaseGetRequestInvocationArgs<EmailObject> & {
        bodyProperties?: string[];
        fetchAllBodyValues?: boolean;
        fetchHTMLBodyValues?: boolean;
        fetchTextBodyValues?: boolean;
        maxBodyValueBytes?: UnsignedInt;
    }

    The arguments for fetching Email objects via an Email/get call

    Type Declaration

    • OptionalbodyProperties?: string[]

      A list of properties to fetch for each EmailBodyPart returned. If omitted, this defaults to:

      [ "partId", "blobId", "size", "name", "type", "charset", "disposition", "cid", "language", "location" ]

    • OptionalfetchAllBodyValues?: boolean

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

    • OptionalfetchHTMLBodyValues?: boolean

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

    • OptionalfetchTextBodyValues?: boolean

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

    • OptionalmaxBodyValueBytes?: 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.

    Settings

    Member Visibility