Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.google.com/apps-script/reference/gmail/gmail-message below:

Class GmailMessage | Apps Script

Stay organized with collections Save and categorize content based on your preferences.

A message in a user's Gmail account.

Creates a draft message replying to the sender of this message using the reply-to address. The size of the email (including headers) is quota limited.

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

GmailDraft — The newly created draft message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

Creates a draft message replying to the sender of this message using the reply-to address, with optional arguments.

The email can contain both plain text and an HTML body. The size of the email (including headers) is quota limited.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

GmailDraft — The newly created draft message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• reply(body, options)
• createDraftReply(body)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

Creates a draft message replying to the sender using the reply-to address and all recipients of this message. The size of the email (including headers) is quota limited.

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

GmailDraft — The newly created draft message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body, options)

Creates a draft message replying to the sender of this message using the reply-to address and all recipients, with optional arguments.

The email can contain both plain text and an HTML body. The size of the email (including headers) is quota limited.

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

GmailDraft — The newly created draft message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• replyAll(body, options)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)

Forwards this message to new recipients. The size of the email (including headers) is quota limited.

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com');

GmailMessage — This message, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• forward(recipient, options)

Forwards this message to new recipients, with optional arguments.

The email can contain both plain text, and also an HTML body. The size of the email (including headers) is quota limited.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com', {
  cc: 'myboss@example.com',
  bcc: 'mybosses-boss@example.com,vp@example.com',
});

GmailMessage — This message, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• forward(recipient)

Gets all the attachments for this message.

GmailAttachment[] — An array of Blob attachments for this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets all the attachments for this message.

GmailAttachment[] — An array of Blob attachments for this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets the comma-separated recipients bcc'd on this message.

This is empty for all received messages, by definition.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

String — The comma-separated recipients bcc'd on this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getTo()

Gets the HTML content of the body of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

String — The body content of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getSubject()

Gets the comma-separated recipients cc'd on this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

String — The comma-separated recipients cc'd on this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getTo()

Gets the date and time of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

Date — The date and time of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets the sender of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

String — The email address of the message sender.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getReplyTo()

Gets the ID of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

String — The message ID.

Gets the content of the body of this message without HTML formatting. This is more complex than getBody() and takes longer.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

String — The plain body content of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getSubject()

Gets the raw content of this message. This is equivalent to "Show Original" in the Gmail UI.

String — The raw content of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets the reply-to address of this message (usually the sender).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

String — The email address for replies.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getCc()

Gets the subject of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

String — The subject of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getAttachments()

Gets the thread that contains this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

GmailThread — The GmailThread that contains this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets the comma-separated recipients of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

String — The comma-separated recipients of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• getCc()

Gets whether this message is a draft.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Boolean — Whether this message is a draft.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets whether this message is a chat.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Boolean — Whether this message is a chat.

Gets whether this message is in the inbox.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

Boolean — Whether this message is in the inbox.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Returns true if this message is in the priority inbox; returns false otherwise.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

Boolean — Whether this message is in the priority inbox.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Gets whether this message is in the trash.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

Boolean — Whether this message is in the trash.

Gets whether this message is starred.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Boolean — Whether this message is starred.

Gets whether this message is unread.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

Boolean — The unread status of this message.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Marks the message as read.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

GmailMessage — This GmailMessage, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• isUnread()

Marks the message as unread.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

GmailMessage — This GmailMessage, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• isUnread()

Moves the message to the trash.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

GmailMessage — This GmailMessage, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• isInTrash()

Reloads this message and associated state from Gmail (useful in case the labels, read state, etc., have changed).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

GmailMessage — This message for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

Replies to the sender of this message using the reply-to address. The size of the email (including headers) is quota limited.

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

GmailMessage — This message, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• reply(body, options)
• replyAll(body)
• replyAll(body, options)

Replies to the sender of this message using the reply-to address, with optional arguments.

The email can contain both plain text, and also an HTML body. The size of the email (including headers) is quota limited.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

GmailMessage — This message, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• reply(body)
• replyAll(body)
• replyAll(body, options)

Replies to the sender using the reply-to address and all recipients of this message. The size of the email (including headers) is quota limited.

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

GmailMessage — This message,useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• reply(body)
• reply(body, options)
• replyAll(body, options)

Replies to the sender of this message using the reply-to address and all recipients, with optional arguments.

The email can contain both plain text, and also an HTML body. The size of the email (including headers) is quota limited.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

GmailMessage — This message, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• reply(body)
• reply(body, options)
• replyAll(body)

Stars the message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

GmailMessage — This GmailMessage, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• unstar()

Unstars the message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

GmailMessage — This GmailMessage, useful for chaining.

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

• https://mail.google.com/

• star()

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["The `GmailMessage` object in Google Apps Script allows you to interact with emails in a user's Gmail account."],["You can use methods to get email information (subject, sender, body, etc.), check email status (read, starred, in trash, etc.), and take actions (reply, forward, move to trash, etc.)."],["Most methods require authorization with the `https://mail.google.com/` scope to access the user's Gmail data."],["The `reply`, `replyAll`, `createDraftReply`, `createDraftReplyAll`, and `forward` methods offer advanced options for customizing your email responses."],["Chaining is supported, allowing you to call multiple GmailMessage methods in sequence on a single email object."]]],[]]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4