Google Apps Script API
    Preparing search index...

    Interface GmailApp

    Provides access to Gmail threads, messages, and labels.

    interface GmailApp {
        createDraft(
            recipient: string,
            subject: string,
            body: string,
        ): GmailDraft;
        createDraft(
            recipient: string,
            subject: string,
            body: string,
            options: GmailAdvancedOptions,
        ): GmailDraft;
        createLabel(name: string): GmailLabel;
        deleteLabel(label: GmailLabel): GoogleAppsScript.Gmail.GmailApp;
        getAliases(): string[];
        getChatThreads(): GmailThread[];
        getChatThreads(start: number, max: number): GmailThread[];
        getDraft(draftId: string): GmailDraft;
        getDraftMessages(): GmailMessage[];
        getDrafts(): GmailDraft[];
        getInboxThreads(): GmailThread[];
        getInboxThreads(start: number, max: number): GmailThread[];
        getInboxUnreadCount(): number;
        getMessageById(id: string): GmailMessage;
        getMessagesForThread(thread: GmailThread): GmailMessage[];
        getMessagesForThreads(threads: GmailThread[]): GmailMessage[][];
        getPriorityInboxThreads(): GmailThread[];
        getPriorityInboxThreads(start: number, max: number): GmailThread[];
        getPriorityInboxUnreadCount(): number;
        getSpamThreads(): GmailThread[];
        getSpamThreads(start: number, max: number): GmailThread[];
        getSpamUnreadCount(): number;
        getStarredThreads(): GmailThread[];
        getStarredThreads(start: number, max: number): GmailThread[];
        getStarredUnreadCount(): number;
        getThreadById(id: string): GmailThread;
        getTrashThreads(): GmailThread[];
        getTrashThreads(start: number, max: number): GmailThread[];
        getUserLabelByName(name: string): GmailLabel;
        getUserLabels(): GmailLabel[];
        markMessageRead(message: GmailMessage): GoogleAppsScript.Gmail.GmailApp;
        markMessagesRead(messages: GmailMessage[]): GoogleAppsScript.Gmail.GmailApp;
        markMessagesUnread(
            messages: GmailMessage[],
        ): GoogleAppsScript.Gmail.GmailApp;
        markMessageUnread(message: GmailMessage): GoogleAppsScript.Gmail.GmailApp;
        markThreadImportant(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        markThreadRead(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        markThreadsImportant(
            threads: GmailThread[],
        ): GoogleAppsScript.Gmail.GmailApp;
        markThreadsRead(threads: GmailThread[]): GoogleAppsScript.Gmail.GmailApp;
        markThreadsUnimportant(
            threads: GmailThread[],
        ): GoogleAppsScript.Gmail.GmailApp;
        markThreadsUnread(threads: GmailThread[]): GoogleAppsScript.Gmail.GmailApp;
        markThreadUnimportant(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        markThreadUnread(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        moveMessagesToTrash(
            messages: GmailMessage[],
        ): GoogleAppsScript.Gmail.GmailApp;
        moveMessageToTrash(message: GmailMessage): GoogleAppsScript.Gmail.GmailApp;
        moveThreadsToArchive(
            threads: GmailThread[],
        ): GoogleAppsScript.Gmail.GmailApp;
        moveThreadsToInbox(threads: GmailThread[]): GoogleAppsScript.Gmail.GmailApp;
        moveThreadsToSpam(threads: GmailThread[]): GoogleAppsScript.Gmail.GmailApp;
        moveThreadsToTrash(threads: GmailThread[]): GoogleAppsScript.Gmail.GmailApp;
        moveThreadToArchive(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        moveThreadToInbox(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        moveThreadToSpam(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        moveThreadToTrash(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        refreshMessage(message: GmailMessage): GoogleAppsScript.Gmail.GmailApp;
        refreshMessages(messages: GmailMessage[]): GoogleAppsScript.Gmail.GmailApp;
        refreshThread(thread: GmailThread): GoogleAppsScript.Gmail.GmailApp;
        refreshThreads(threads: GmailThread[]): GoogleAppsScript.Gmail.GmailApp;
        search(query: string): GmailThread[];
        search(query: string, start: number, max: number): GmailThread[];
        sendEmail(
            recipient: string,
            subject: string,
            body: string,
        ): GoogleAppsScript.Gmail.GmailApp;
        sendEmail(
            recipient: string,
            subject: string,
            body: string,
            options: GmailAdvancedOptions,
        ): GoogleAppsScript.Gmail.GmailApp;
        setCurrentMessageAccessToken(accessToken: string): void;
        starMessage(message: GmailMessage): GoogleAppsScript.Gmail.GmailApp;
        starMessages(messages: GmailMessage[]): GoogleAppsScript.Gmail.GmailApp;
        unstarMessage(message: GmailMessage): GoogleAppsScript.Gmail.GmailApp;
        unstarMessages(messages: GmailMessage[]): GoogleAppsScript.Gmail.GmailApp;
    }
    Index

    Methods

    createDraft createLabel deleteLabel getAliases getChatThreads getDraft getDraftMessages getDrafts getInboxThreads getInboxUnreadCount getMessageById getMessagesForThread getMessagesForThreads getPriorityInboxThreads getPriorityInboxUnreadCount getSpamThreads getSpamUnreadCount getStarredThreads getStarredUnreadCount getThreadById getTrashThreads getUserLabelByName getUserLabels markMessageRead markMessagesRead markMessagesUnread markMessageUnread markThreadImportant markThreadRead markThreadsImportant markThreadsRead markThreadsUnimportant markThreadsUnread markThreadUnimportant markThreadUnread moveMessagesToTrash moveMessageToTrash moveThreadsToArchive moveThreadsToInbox moveThreadsToSpam moveThreadsToTrash moveThreadToArchive moveThreadToInbox moveThreadToSpam moveThreadToTrash refreshMessage refreshMessages refreshThread refreshThreads search sendEmail setCurrentMessageAccessToken starMessage starMessages unstarMessage unstarMessages

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    createDraft createLabel deleteLabel getAliases getChatThreads getDraft getDraftMessages getDrafts getInboxThreads getInboxUnreadCount getMessageById getMessagesForThread getMessagesForThreads getPriorityInboxThreads getPriorityInboxUnreadCount getSpamThreads getSpamUnreadCount getStarredThreads getStarredUnreadCount getThreadById getTrashThreads getUserLabelByName getUserLabels markMessageRead markMessagesRead markMessagesUnread markMessageUnread markThreadImportant markThreadRead markThreadsImportant markThreadsRead markThreadsUnimportant markThreadsUnread markThreadUnimportant markThreadUnread moveMessagesToTrash moveMessageToTrash moveThreadsToArchive moveThreadsToInbox moveThreadsToSpam moveThreadsToTrash moveThreadToArchive moveThreadToInbox moveThreadToSpam moveThreadToTrash refreshMessage refreshMessages refreshThread refreshThreads search sendEmail setCurrentMessageAccessToken starMessage starMessages unstarMessage unstarMessages