nylas
    Preparing search index...

    Interface SendMessageRequest

    Interface representing a request to send a message.

    interface SendMessageRequest {
        attachments?: CreateAttachmentRequest[];
        bcc?: EmailName[];
        body?: string;
        cc?: EmailName[];
        customHeaders?: CustomHeader[];
        from?: EmailName[];
        replyTo?: EmailName[];
        replyToMessageId?: string;
        sendAt?: number;
        starred?: boolean;
        subject?: string;
        to: EmailName[];
        trackingOptions?: TrackingOptions;
        useDraft?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attachments? bcc? body? cc? customHeaders? from? replyTo? replyToMessageId? sendAt? starred? subject? to trackingOptions? useDraft?

    Properties

    attachments?: CreateAttachmentRequest[]

    An array of files to attach 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.

    from?: EmailName[]

    An array of message senders.

    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.

    starred?: boolean

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

    subject?: string

    The message subject.

    to: EmailName[]

    An array of message recipients.

    trackingOptions?: TrackingOptions

    Options for tracking opens, links, and thread replies.

    useDraft?: boolean

    Whether or not to use draft support. This is primarily used when dealing with large attachments.

    Settings

    Member Visibility

    On This Page

    Properties