GmailApp Provides access to Gmail threads, messages, and labels. ### Methods | Method | Return type | Brief description | |---|---|---| | `https://developers.google.com/apps-script/reference/gmail/gmail-app#createDraft(String,String,String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-draft` | Creates a draft email message. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#createDraft(String,String,String,Object)` | `https://developers.google.com/apps-script/reference/gmail/gmail-draft` | Creates a draft email message with optional arguments. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#createLabel(String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-label` | Create a new user label of the given name. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#deleteLabel(GmailLabel)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Deletes the specified label. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getAliases()` | `String[]` | Gets a list of the emails that are set up as aliases for this account in Gmail. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getDraft(String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-draft` | Retrieve an email message draft by ID. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getDraftMessages()` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | Retrieves all draft messages. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getDrafts()` | `https://developers.google.com/apps-script/reference/gmail/gmail-draft` | Gets all Gmail draft messages. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getInboxThreads()` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves all Inbox threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getInboxThreads(Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves a range of Inbox threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getInboxUnreadCount()` | `Integer` | Gets the number of unread threads in the inbox. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getMessageById(String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | Gets a message by ID. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getMessagesForThread(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | Retrieve all messages in the specified thread. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getMessagesForThreads(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | Retrieve all messages in the specified threads. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getPriorityInboxThreads()` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves all Priority Inbox threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getPriorityInboxThreads(Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves a range of Priority Inbox threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getPriorityInboxUnreadCount()` | `Integer` | Gets the number of unread threads in the Priority Inbox. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getSpamThreads()` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves all spam threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getSpamThreads(Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves a range of spam threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getSpamUnreadCount()` | `Integer` | Gets the number of unread threads that are spam. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getStarredThreads()` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves all starred threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getStarredThreads(Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves a range of starred threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getStarredUnreadCount()` | `Integer` | Gets the number of unread threads that are starred. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getThreadById(String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread|null` | Gets a thread by ID. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getTrashThreads()` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves all trash threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getTrashThreads(Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Retrieves a range of trash threads irrespective of labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getUserLabelByName(String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-label` | Retrieves a label given the label name. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getUserLabels()` | `https://developers.google.com/apps-script/reference/gmail/gmail-label` | Retrieves a list of user-created labels. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessageRead(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks this message read and forces the message to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessageUnread(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks this message unread and forces the message to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessagesRead(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks these messages read and forces the messages to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessagesUnread(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks these messages unread and forces the messages to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadImportant(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks this thread as important and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadRead(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks this thread as read and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadUnimportant(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks this thread as unimportant and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadUnread(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks this thread unread and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsImportant(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks these threads as important and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsRead(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks these threads as read and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsUnimportant(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks these threads as unimportant and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsUnread(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Marks these threads as unread and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveMessageToTrash(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves the message to the trash and forces the message to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveMessagesToTrash(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves the specified messages to the trash and forces the messages to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToArchive(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves this thread to the archive and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToInbox(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves this thread to the inbox and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToSpam(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves this thread to spam and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToTrash(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves this thread to the trash and forces the thread to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToArchive(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves these threads to the archive and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToInbox(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves these threads to the inbox and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToSpam(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves these threads to spam and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToTrash(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Moves these threads to the trash and forces the threads to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshMessage(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Reloads the message and associated state from Gmail (useful in case the labels, read state, etc., have changed). | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshMessages(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Reloads the messages and associated state from Gmail (useful in case the labels, read state, etc., have changed). | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshThread(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Reloads the thread and associated state from Gmail (useful in case the labels, read state, etc., have changed). | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshThreads(GmailThread)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Reloads the threads and associated state from Gmail (useful in case the labels, read state, etc., have changed). | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#search(String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Search Gmail with the given query. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#search(String,Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Search Gmail with the given query. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Sends an email message. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String,Object)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Sends an email message with optional arguments. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#setCurrentMessageAccessToken(String)` | `void` | Sets the [current message access token](https://developers.google.com/workspace/add-ons/concepts/gsuite-scopes#access_tokens) that enables the script to access the current `https://developers.google.com/apps-script/reference/gmail/gmail-message` properties. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#starMessage(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Adds a star to this message and forces the message to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#starMessages(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Adds stars to these messages and forces the messages to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#unstarMessage(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Removes a star from this message and forces the message to refresh. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#unstarMessages(GmailMessage)` | `https://developers.google.com/apps-script/reference/gmail/gmail-app#` | Removes stars from these messages and forces the messages to refresh. | ### Deprecated methods | Method | Return type | Brief description | |---|---|---| | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getChatThreads()` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Gets all classic Google Hangouts threads and Google Chat threads until Google switches all users of classic Hangouts to Chat later this year. | | `https://developers.google.com/apps-script/reference/gmail/gmail-app#getChatThreads(Integer,Integer)` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | Gets a range of classic Google Hangouts threads and Google Chat threads until Google switches all users of classic Hangouts to Chat later this year. | ## Detailed documentation ### `createDraft(recipient, subject, body)` Creates a draft email message. The size of the email (including headers) is [quota limited](https://developers.google.com/apps-script/guides/services/quotas#current_limitations). ```javascript // The code below creates a draft email with the current date and time. const now = new Date(); GmailApp.createDraft( 'mike@example.com', 'current time', `The time is: ${now.toString()}`, ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `recipient` | `String` | comma separated list of email addresses | | `subject` | `String` | subject of the email | | `body` | `String` | body of the email | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-draft` --- the newly created GmailDraft #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#createDraft(String,String,String,Object)` *** ** * ** *** ### `createDraft(recipient, subject, body, options)` Creates a draft email message with optional arguments. The email can contain plain text or an HTML body. The size of the email (including headers, but excluding attachments) is [quota limited](https://developers.google.com/apps-script/guides/services/quotas#current_limitations). ```javascript // Create a draft email with a file from Google Drive attached as a PDF. const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.createDraft( 'mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script', }, ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `recipient` | `String` | the addresses of the recipient | | `subject` | `String` | the subject line | | `body` | `String` | the body of the email | | `options` | `Object` | a JavaScript object that specifies advanced parameters, as listed below | #### Advanced parameters | Name | Type | Description | |---|---|---| | `attachments` | `https://developers.google.com/apps-script/reference/base/blob-source.html` | an array of files to send with the email | | `bcc` | `String` | a comma-separated list of email addresses to BCC | | `cc` | `String` | a comma-separated list of email addresses to CC | | `from` | `String` | the address that the email should be sent from, which must be one of the values returned by `https://developers.google.com/apps-script/reference/gmail/gmail-app#getAliases()` | | `htmlBody` | `String` | if set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional `inlineImages` field in HTML body if you have inlined images for your email | | `inlineImages` | `Object` | a JavaScript object containing a mapping from image key (`String`) to image data (`https://developers.google.com/apps-script/reference/base/blob-source.html`); this assumes that the `htmlBody` parameter is used and contains references to these images in the format `` | | `name` | `String` | the name of the sender of the email (default: the user's name) | | `replyTo` | `String` | an email address to use as the default reply-to address (default: the user's email address) | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-draft` --- the newly created GmailDraft #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#createDraft(String,String,String)` *** ** * ** *** ### `createLabel(name)` Create a new user label of the given name. ```javascript // Creates the label @FOO and logs label: FOO Logger.log(`label: ${GmailApp.createLabel('FOO')}`); ``` #### Parameters | Name | Type | Description | |---|---|---| | `name` | `String` | the name of the new label | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-label` --- the newly created label #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#deleteLabel(GmailLabel)` *** ** * ** *** ### `deleteLabel(label)` Deletes the specified label. ```javascript // Have to get the label by name first const label = GmailApp.getUserLabelByName('FOO'); GmailApp.deleteLabel(label); ``` #### Parameters | Name | Type | Description | |---|---|---| | `label` | `https://developers.google.com/apps-script/reference/gmail/gmail-label` | the label to delete | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#createLabel(String)` *** ** * ** *** ### `getAliases()` Gets a list of the emails that are set up as aliases for this account in Gmail. You can send a message from any of these aliases by using the "from" optional argument. ```javascript // Log the aliases for this Gmail account and send an email as the first one. const me = Session.getActiveUser().getEmail(); const aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', { from: aliases[0], }); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); } ``` #### Return `String[]` --- an array of aliases for this account #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String,Object)` *** ** * ** *** ### `getDraft(draftId)` Retrieve an email message draft by ID. Use this in conjunction with getId() on Gmail drafts. ```javascript // Get the first draft message in your drafts folder const draft = GmailApp.getDrafts()[0]; // Get its ID const draftId = draft.getId(); // Now fetch the same draft using that ID. const draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log( draft.getMessage().getSubject() === draftById.getMessage().getSubject(), ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `draftId` | `String` | the ID of the draft to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-draft` --- the draft with the given ID #### Throws [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if no draft with the given ID can be found #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getDraftMessages()` Retrieves all draft messages. ```javascript // Logs the number of draft messages const drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length); ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-message` --- an array of draft Gmail messages #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getDrafts()` Gets all Gmail draft messages. ```javascript const drafts = GmailApp.getDrafts(); for (let i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); } ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-draft` --- an array of Gmail draft messages #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getInboxThreads()` Retrieves all Inbox threads irrespective of labels. This call will fail when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, please use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript // Log the subject lines of your Inbox const threads = GmailApp.getInboxThreads(); for (let i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); } ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the Inbox #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getInboxThreads(start, max)` Retrieves a range of Inbox threads irrespective of labels. ```javascript // Log the subject lines of up to the first 50 emails in your Inbox const threads = GmailApp.getInboxThreads(0, 50); for (let i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); } ``` #### Parameters | Name | Type | Description | |---|---|---| | `start` | `Integer` | the index of the first thread to retrieve | | `max` | `Integer` | the maximum number of threads to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the Inbox #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getInboxUnreadCount()` Gets the number of unread threads in the inbox. ```javascript Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`); ``` #### Return `Integer` --- the number of threads in the inbox that have unread messages #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getMessageById(id)` Gets a message by ID. Use this in conjunction with getId() on Gmail messages. ```javascript // Get the first message in the first thread of your inbox const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID const messageId = message.getId(); // Now fetch the same message using that ID. const messageById = GmailApp.getMessageById(messageId); // Should always log true as they should be the same message Logger.log(message.getSubject() === messageById.getSubject()); ``` #### Parameters | Name | Type | Description | |---|---|---| | `id` | `String` | the ID of the message to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-message` --- the message with the given ID #### Throws [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if no message with the given ID can be found #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#getThreadById(String)` *** ** * ** *** ### `getMessagesForThread(thread)` Retrieve all messages in the specified thread. ```javascript // Log all the subject lines in the first thread of your inbox const thread = GmailApp.getInboxThreads(0, 1)[0]; const messages = GmailApp.getMessagesForThread(thread); for (let i = 0; i < messages.length; i++) { Logger.log(`subject: ${messages[i].getSubject()}`); } ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread of messages to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-message` --- array of messages corresponding to this thread #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#getMessagesForThreads(GmailThread)` *** ** * ** *** ### `getMessagesForThreads(threads)` Retrieve all messages in the specified threads. ```javascript // Log the subject lines of all messages in the first two threads of your inbox const thread = GmailApp.getInboxThreads(0, 2); const messages = GmailApp.getMessagesForThreads(thread); for (let i = 0; i < messages.length; i++) { for (let j = 0; j < messages[i].length; j++) { Logger.log(`subject: ${messages[i][j].getSubject()}`); } } ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the threads of messages to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-message` --- an array of arrays of messages, where each item in the outer array corresponds to a thread and the inner array contains the messages in that thread #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#getMessagesForThread(GmailThread)` *** ** * ** *** ### `getPriorityInboxThreads()` Retrieves all Priority Inbox threads irrespective of labels. This call will fail when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, please use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript Logger.log( `# of messages in your Priority Inbox: ${ GmailApp.getPriorityInboxThreads().length}`, ); ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the Priority Inbox #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getPriorityInboxThreads(start, max)` Retrieves a range of Priority Inbox threads irrespective of labels. ```javascript // Will log some number 2 or less Logger.log( `# of messages in your Priority Inbox: ${ GmailApp.getPriorityInboxThreads(0, 2).length}`, ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `start` | `Integer` | the index of the first thread to retrieve | | `max` | `Integer` | the maximum number of threads to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the Priority Inbox #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getPriorityInboxUnreadCount()` Gets the number of unread threads in the Priority Inbox. ```javascript Logger.log( `Number of unread emails in your Priority Inbox : ${ GmailApp.getPriorityInboxUnreadCount()}`, ); ``` #### Return `Integer` --- the number of threads in the Priority Inbox that have unread messages #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getSpamThreads()` Retrieves all spam threads irrespective of labels. This call will fail when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, please use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`); ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the spam folder #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getSpamThreads(start, max)` Retrieves a range of spam threads irrespective of labels. ```javascript // Will log a number at most 5 Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`); ``` #### Parameters | Name | Type | Description | |---|---|---| | `start` | `Integer` | the index of the first thread to retrieve | | `max` | `Integer` | the maximum number of threads to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the spam folder #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getSpamUnreadCount()` Gets the number of unread threads that are spam. ```javascript // Unless you actually read stuff in your spam folder, this should be the same // as the number of messages in your spam folder. Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`); ``` #### Return `Integer` --- the number spam threads that have unread messages #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getStarredThreads()` Retrieves all starred threads irrespective of labels. This call will fail when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, please use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript // Logs the number of starred threads Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`); ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of starred Gmail threads #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getStarredThreads(start, max)` Retrieves a range of starred threads irrespective of labels. ```javascript // Logs the number of starred threads to a maximum of 5 Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`); ``` #### Parameters | Name | Type | Description | |---|---|---| | `start` | `Integer` | the index of the first thread to retrieve | | `max` | `Integer` | the maximum number of threads to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of starred Gmail threads #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getStarredUnreadCount()` Gets the number of unread threads that are starred. ```javascript Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`); ``` #### Return `Integer` --- the number of starred threads that have unread messages #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getThreadById(id)` Gets a thread by ID. Use this in conjunction with getId() on Gmail threads. ```javascript // Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0, 1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log( firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject(), ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `id` | `String` | The ID of the thread to retrieve. | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread|null` --- The thread with the given ID or `null` if not found. #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#getMessageById(String)` *** ** * ** *** ### `getTrashThreads()` Retrieves all trash threads irrespective of labels. This call will fail when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, please use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`); ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the trash #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getTrashThreads(start, max)` Retrieves a range of trash threads irrespective of labels. ```javascript // Will log a number at most 5 Logger.log( `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`, ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `start` | `Integer` | the index of the first thread to retrieve | | `max` | `Integer` | the maximum number of threads to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads in the trash #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getUserLabelByName(name)` Retrieves a label given the label name. ```javascript const labelObject = GmailApp.getUserLabelByName('myLabel'); ``` #### Parameters | Name | Type | Description | |---|---|---| | `name` | `String` | the name of the label to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-label` --- the Gmail label with the given name #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getUserLabels()` Retrieves a list of user-created labels. ```javascript // Logs all of the names of your labels const labels = GmailApp.getUserLabels(); for (let i = 0; i < labels.length; i++) { Logger.log(`label: ${labels[i].getName()}`); } ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-label` --- array of user created labels #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `markMessageRead(message)` Marks this message read and forces the message to refresh. ```javascript // Mark the first message in the first thread of your inbox as read const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message); ``` #### Parameters | Name | Type | Description | |---|---|---| | `message` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the message to mark as read | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessageUnread(GmailMessage)` *** ** * ** *** ### `markMessageUnread(message)` Marks this message unread and forces the message to refresh. ```javascript // Mark the first message in the first thread of your inbox as unread const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message); ``` #### Parameters | Name | Type | Description | |---|---|---| | `message` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the message to mark as unread | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessageRead(GmailMessage)` *** ** * ** *** ### `markMessagesRead(messages)` Marks these messages read and forces the messages to refresh. ```javascript // Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); const messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(messages); ``` #### Parameters | Name | Type | Description | |---|---|---| | `messages` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | an array of messages to mark as read | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessagesUnread(GmailMessage)` *** ** * ** *** ### `markMessagesUnread(messages)` Marks these messages unread and forces the messages to refresh. ```javascript // Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); const messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(messages); ``` #### Parameters | Name | Type | Description | |---|---|---| | `messages` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | an array of messages to mark as unread | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markMessagesRead(GmailMessage)` *** ** * ** *** ### `markThreadImportant(thread)` Marks this thread as important and forces the thread to refresh. ```javascript // Marks first inbox thread as important const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to mark as important | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadUnimportant(GmailThread)` *** ** * ** *** ### `markThreadRead(thread)` Marks this thread as read and forces the thread to refresh. ```javascript // Marks first inbox thread as read const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to mark as read | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadUnread(GmailThread)` *** ** * ** *** ### `markThreadUnimportant(thread)` Marks this thread as unimportant and forces the thread to refresh. ```javascript // Marks first inbox thread as unimportant const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to mark as unimportant | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadImportant(GmailThread)` *** ** * ** *** ### `markThreadUnread(thread)` Marks this thread unread and forces the thread to refresh. ```javascript // Marks first inbox thread as unread const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to mark as unread | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadRead(GmailThread)` *** ** * ** *** ### `markThreadsImportant(threads)` Marks these threads as important and forces the threads to refresh. ```javascript // Marks first two threads in inbox as important const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to mark as important | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsUnimportant(GmailThread)` *** ** * ** *** ### `markThreadsRead(threads)` Marks these threads as read and forces the threads to refresh. ```javascript // Marks first two threads in inbox as read const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to mark as read | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsUnread(GmailThread)` *** ** * ** *** ### `markThreadsUnimportant(threads)` Marks these threads as unimportant and forces the threads to refresh. ```javascript // Marks first two threads in inbox as unimportant const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to mark as unimportant | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsImportant(GmailThread)` *** ** * ** *** ### `markThreadsUnread(threads)` Marks these threads as unread and forces the threads to refresh. ```javascript // Marks first two threads in inbox as unread const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to mark as unread | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#markThreadsRead(GmailThread)` *** ** * ** *** ### `moveMessageToTrash(message)` Moves the message to the trash and forces the message to refresh. ```javascript // Move the first message in your inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage); ``` #### Parameters | Name | Type | Description | |---|---|---| | `message` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the message to be trashed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service (useful for chaining) #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveMessagesToTrash(GmailMessage)` *** ** * ** *** ### `moveMessagesToTrash(messages)` Moves the specified messages to the trash and forces the messages to refresh. ```javascript // Move first two messages in your inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const messages = firstThread.getMessages(); const toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete); ``` #### Parameters | Name | Type | Description | |---|---|---| | `messages` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the messages to be trashed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service (useful for chaining) #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveMessageToTrash(GmailMessage)` *** ** * ** *** ### `moveThreadToArchive(thread)` Moves this thread to the archive and forces the thread to refresh. ```javascript // Archive the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToArchive(firstThread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to be archive | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToInbox(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToSpam(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToTrash(GmailThread)` *** ** * ** *** ### `moveThreadToInbox(thread)` Moves this thread to the inbox and forces the thread to refresh. ```javascript // Find a thread not already in your inbox const thread = GmailApp.search('-in:inbox')[0]; // Get the first one GmailApp.moveThreadToInbox(thread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to be moved to the inbox | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToTrash(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToSpam(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToArchive(GmailThread)` *** ** * ** *** ### `moveThreadToSpam(thread)` Moves this thread to spam and forces the thread to refresh. ```javascript // Tag first thread in inbox as spam const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToSpam(firstThread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to be moved to spam | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToTrash(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToInbox(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToArchive(GmailThread)` *** ** * ** *** ### `moveThreadToTrash(thread)` Moves this thread to the trash and forces the thread to refresh. ```javascript // Move first thread in inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToTrash(firstThread); ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to be trashed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToInbox(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToSpam(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadToArchive(GmailThread)` *** ** * ** *** ### `moveThreadsToArchive(threads)` Moves these threads to the archive and forces the threads to refresh. ```javascript // Move first two threads in your inbox to the archive const firstTwoThreads = GmailApp.getInboxThreads(0, 2); GmailApp.moveThreadsToArchive(firstTwoThreads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to be archived | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToInbox(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToSpam(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToTrash(GmailThread)` *** ** * ** *** ### `moveThreadsToInbox(threads)` Moves these threads to the inbox and forces the threads to refresh. ```javascript // Find two threads not already in your inbox const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to be moved to the inbox | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToTrash(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToSpam(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToArchive(GmailThread)` *** ** * ** *** ### `moveThreadsToSpam(threads)` Moves these threads to spam and forces the threads to refresh. ```javascript // Move first two threads in your inbox to spam const firstTwoThreads = GmailApp.getInboxThreads(0, 2); GmailApp.moveThreadsToSpam(firstTwoThreads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to be moved to spam | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToInbox(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToTrash(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToArchive(GmailThread)` *** ** * ** *** ### `moveThreadsToTrash(threads)` Moves these threads to the trash and forces the threads to refresh. ```javascript // Move first two threads in your inbox to trash const firstTwoThreads = GmailApp.getInboxThreads(0, 2); GmailApp.moveThreadsToTrash(firstTwoThreads); ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | an array of threads to be trashed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToInbox(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToSpam(GmailThread)` - `https://developers.google.com/apps-script/reference/gmail/gmail-app#moveThreadsToArchive(GmailThread)` *** ** * ** *** ### `refreshMessage(message)` Reloads the message and associated state from Gmail (useful in case the labels, read state, etc., have changed). ```javascript const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const firstMessage = firstThread.getMessages()[0]; // ...Do something that may take a while here.... GmailApp.refreshMessage(firstMessage); // ...Do more stuff with firstMessage... ``` #### Parameters | Name | Type | Description | |---|---|---| | `message` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the message to be refreshed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshMessages(GmailMessage)` *** ** * ** *** ### `refreshMessages(messages)` Reloads the messages and associated state from Gmail (useful in case the labels, read state, etc., have changed). ```javascript const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const coupleOfMessages = firstThread.getMessages().slice(0, 2); // ...Do something that may take a while here.... GmailApp.refreshMessages(coupleOfMessages); // ...Do more stuff with coupleOfMessages... ``` #### Parameters | Name | Type | Description | |---|---|---| | `messages` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the messages to be refreshed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshMessage(GmailMessage)` *** ** * ** *** ### `refreshThread(thread)` Reloads the thread and associated state from Gmail (useful in case the labels, read state, etc., have changed). ```javascript const firstThread = GmailApp.getInboxThreads(0, 1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ... ``` #### Parameters | Name | Type | Description | |---|---|---| | `thread` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the thread to be refreshed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshThreads(GmailThread)` *** ** * ** *** ### `refreshThreads(threads)` Reloads the threads and associated state from Gmail (useful in case the labels, read state, etc., have changed). ```javascript const threads = GmailApp.getInboxThreads(0, 3); // ...Do something that may take a while here.... GmailApp.refreshThreads(threads); // ... Do more stuff with threads ... ``` #### Parameters | Name | Type | Description | |---|---|---| | `threads` | `https://developers.google.com/apps-script/reference/gmail/gmail-thread` | the threads to be refreshed | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#refreshThread(GmailThread)` *** ** * ** *** ### `search(query)` Search Gmail with the given query. This call will fail when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, please use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript // Find starred messages with subject IMPORTANT const threads = GmailApp.search('is:starred subject:"IMPORTANT"'); ``` #### Parameters | Name | Type | Description | |---|---|---| | `query` | `String` | the search query, as you would type it into Gmail | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads matching this query #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `search(query, start, max)` Search Gmail with the given query. ```javascript // Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty // array. const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10); ``` #### Parameters | Name | Type | Description | |---|---|---| | `query` | `String` | the search query, as you would type it into Gmail | | `start` | `Integer` | the index of the starting thread | | `max` | `Integer` | the maximum number of threads to return | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of Gmail threads matching this query #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `sendEmail(recipient, subject, body)` Sends an email message. The size of the email (including headers) is [quota limited](https://developers.google.com/apps-script/guides/services/quotas#current_limitations). ```javascript // The code below will send an email with the current date and time. const now = new Date(); GmailApp.sendEmail( 'mike@example.com', 'current time', `The time is: ${now.toString()}`, ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `recipient` | `String` | comma separated list of email addresses | | `subject` | `String` | subject of the email (250 characters maximum) | | `body` | `String` | body of the email | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String,Object)` *** ** * ** *** ### `sendEmail(recipient, subject, body, options)` Sends an email message with optional arguments. The email can contain plain text or an HTML body. The size of the email (including headers, but excluding attachments) is [quota limited](https://developers.google.com/apps-script/guides/services/quotas#current_limitations). ```javascript // Send an email with a file from Google Drive attached as a PDF. const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.sendEmail( 'mike@example.com', 'Attachment example', 'Please see the attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script', }, ); ``` #### Parameters | Name | Type | Description | |---|---|---| | `recipient` | `String` | the addresses of the recipient | | `subject` | `String` | the subject line (250 characters maximum) | | `body` | `String` | the body of the email | | `options` | `Object` | a JavaScript object that specifies advanced parameters, as listed below | #### Advanced parameters | Name | Type | Description | |---|---|---| | `attachments` | `https://developers.google.com/apps-script/reference/base/blob-source.html` | an array of files to send with the email | | `bcc` | `String` | a comma-separated list of email addresses to BCC | | `cc` | `String` | a comma-separated list of email addresses to CC | | `from` | `String` | the address that the email should be sent from, which must be one of the values returned by `https://developers.google.com/apps-script/reference/gmail/gmail-app#getAliases()` | | `htmlBody` | `String` | if set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional `inlineImages` field in HTML body if you have inlined images for your email | | `inlineImages` | `Object` | a JavaScript object containing a mapping from image key (`String`) to image data (`https://developers.google.com/apps-script/reference/base/blob-source.html`); this assumes that the `htmlBody` parameter is used and contains references to these images in the format `` | | `name` | `String` | the name of the sender of the email (default: the user's name) | | `noReply` | `Boolean` | `true` if the email should be sent from a generic no-reply email address to discourage recipients from responding to emails; this option is only possible for Google Workspace accounts, not Gmail users | | `replyTo` | `String` | an email address to use as the default reply-to address (default: the user's email address) | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String)` *** ** * ** *** ### `setCurrentMessageAccessToken(accessToken)` Sets the [current message access token](https://developers.google.com/workspace/add-ons/concepts/gsuite-scopes#access_tokens) that enables the script to access the current `https://developers.google.com/apps-script/reference/gmail/gmail-message` properties. Only [Google Workspace add-on](https://developers.google.com/workspace/add-ons/gmail) projects using Gmail [current message scopes](https://developers.google.com/workspace/add-ons/concepts/workspace-scopes#gmail-scopes) require this method. ```javascript function handleAddonActionEvent(e) { GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken); const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId); // Do something with mailMessage } ``` #### Parameters | Name | Type | Description | |---|---|---| | `accessToken` | `String` | the temporary access token obtained from a Gmail add-on [action event object](https://developers.google.com/gmail/add-ons/concepts/actions#action_event_objects). | #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `starMessage(message)` Adds a star to this message and forces the message to refresh. ```javascript // Stars the first message in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const message = firstThread.getMessages()[0]; GmailApp.starMessage(message); ``` #### Parameters | Name | Type | Description | |---|---|---| | `message` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the message to star | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#starMessages(GmailMessage)` *** ** * ** *** ### `starMessages(messages)` Adds stars to these messages and forces the messages to refresh. ```javascript // Stars the first three messages in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages); ``` #### Parameters | Name | Type | Description | |---|---|---| | `messages` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | an array of messages to star | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#starMessage(GmailMessage)` *** ** * ** *** ### `unstarMessage(message)` Removes a star from this message and forces the message to refresh. ```javascript // Unstars the first message in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message); ``` #### Parameters | Name | Type | Description | |---|---|---| | `message` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | the message to unstar | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#unstarMessages(GmailMessage)` *** ** * ** *** ### `unstarMessages(messages)` Removes stars from these messages and forces the messages to refresh. ```javascript // Unstars the first three messages in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages); ``` #### Parameters | Name | Type | Description | |---|---|---| | `messages` | `https://developers.google.com/apps-script/reference/gmail/gmail-message` | an array of messages to unstar | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-app#` --- the Gmail service, useful for chaining #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` #### See also - `https://developers.google.com/apps-script/reference/gmail/gmail-app#unstarMessage(GmailMessage)` ## Deprecated methods ### `getChatThreads()` **Deprecated.** This function is deprecated and should not be used in new scripts. Gets all classic Google Hangouts threads and Google Chat threads until Google switches all users of classic Hangouts to Chat later this year. To learn more, see [Learn about the switch from classic Hangouts to Google Chat](https://support.google.com/chat/answer/9854901). This call fails when the size of all threads is too large for the system to handle. Where the thread size is unknown, and potentially very large, use the 'paged' call, and specify ranges of the threads to retrieve in each call. ```javascript const threads = GmailApp.getChatThreads(); Logger.log(`# of chat threads: ${threads.length}`); ``` #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- An array of chat threads from Gmail. #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/` *** ** * ** *** ### `getChatThreads(start, max)` **Deprecated.** This function is deprecated and should not be used in new scripts. Gets a range of classic Google Hangouts threads and Google Chat threads until Google switches all users of classic Hangouts to Chat later this year. To learn more, see [Learn about the switch from classic Hangouts to Google Chat](https://support.google.com/chat/answer/9854901). ```javascript // Get first 50 chat threads const threads = GmailApp.getChatThreads(0, 50); // Will log no more than 50.0 Logger.log(threads.length); Logger.log(threads[0].getFirstMessageSubject()); ``` #### Parameters | Name | Type | Description | |---|---|---| | `start` | `Integer` | the index of the first thread to retrieve | | `max` | `Integer` | the maximum number of threads to retrieve | #### Return `https://developers.google.com/apps-script/reference/gmail/gmail-thread` --- an array of chat Gmail threads #### Authorization Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](https://developers.google.com/identity/protocols/googlescopes#gmailv1): - `https://mail.google.com/`