nylas
    Preparing search index...

    Interface Draft

    Interface representing a Nylas Draft object.

    interface Draft {
        attachments?: Attachment[];
        bcc?: EmailName[];
        body?: string;
        cc?: EmailName[];
        customHeaders?: CustomHeader[];
        date: number;
        folders: string[];
        from?: EmailName[];
        grantId: string;
        id: string;
        isPlaintext?: boolean;
        object: "draft";
        replyTo?: EmailName[];
        replyToMessageId?: string;
        sendAt?: number;
        snippet?: string;
        starred?: boolean;
        subject?: string;
        threadId?: string;
        to: EmailName[];
        trackingOptions?: TrackingOptions;
        unread?: boolean;
    }

    Hierarchy

    Index

    Properties

    attachments? bcc? body? cc? customHeaders? date folders from? grantId id isPlaintext? object replyTo? replyToMessageId? sendAt? snippet? starred? subject? threadId? to trackingOptions? unread?

    Properties

    attachments?: Attachment[]

    An array of files attached to the message.

    bcc?: EmailName[]

    An array of bcc recipients.

    Optionalbody

    body?: string

    The full HTML message body. Messages with only plain-text representations are up-converted to HTML.

    cc?: EmailName[]

    An array of cc recipients.

    customHeaders?: CustomHeader[]

    An array of custom headers to add to the message.

    date: number

    Unix timestamp of when the message was received by the mail server. This may be different from the unverified Date header in raw message object.

    folders: string[]

    The ID of the folder(s) the message appears in.

    from?: EmailName[]

    An array of message senders.

    grantId: string

    Grant ID of the Nylas account.

    id: string

    The unique identifier for the message.

    isPlaintext?: boolean

    When true, the message body is sent as plain text and the MIME data doesn't include the HTML version of the message. When false, the message body is sent as HTML. Defaults to false.

    object: "draft"

    The type of object.

    replyTo?: EmailName[]

    An array of name and email pairs that override the sent reply-to headers.

    replyToMessageId?: string

    The ID of the message that you are replying to.

    sendAt?: number

    Unix timestamp to send the message at.

    snippet?: string

    A short snippet of the message body. This is the first 100 characters of the message body, with any HTML tags removed.

    starred?: boolean

    Whether or not the message has been starred by the user.

    subject?: string

    The message subject.

    threadId?: string

    A reference to the parent thread object. If this is a new draft, the thread will be empty.

    to: EmailName[]

    An array of message recipients.

    trackingOptions?: TrackingOptions

    Options for tracking opens, links, and thread replies.

    unread?: boolean

    Whether or not the message has been read by the user.

    Settings

    Member Visibility

    On This Page

    Properties