Interface GmailDraft

A user-created draft message in a user's Gmail account.

interface GmailDraft {
    deleteDraft(): void;
    getId(): string;
    getMessage(): GmailMessage;
    getMessageId(): string;
    send(): GmailMessage;
    update(recipient: string, subject: string, body: string): GmailDraft;
    update(
        recipient: string,
        subject: string,
        body: string,
        options: GmailAdvancedOptions,
    ): GmailDraft;
}

Index

Methods

deleteDraft getId getMessage getMessageId send update

Methods

deleteDraft

deleteDraft(): void
Deletes this draft message.

Returns void
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:119

getId

getId(): string
Gets the ID of this draft message.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:123

getMessage

getMessage(): GmailMessage
Returns a GmailMessage representing this draft.

Returns GmailMessage
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:127

getMessageId

getMessageId(): string
Returns the ID of the GmailMessage representing this draft.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:131

send

send(): GmailMessage
Sends this draft email message.

Returns GmailMessage
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:135

update

update(recipient: string, subject: string, body: string): GmailDraft
Replaces the contents of this draft message.
Parameters
- recipient: string
- subject: string
- body: string
Returns GmailDraft
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:139
update(
    recipient: string,
    subject: string,
    body: string,
    options: GmailAdvancedOptions,
): GmailDraft
Replaces the contents of this draft message using optional arguments.
Parameters
- recipient: string
- subject: string
- body: string
- options: GmailAdvancedOptions
Returns GmailDraft
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.gmail.d.ts:143