Class GmailApp

Создает черновик электронного письма. Размер письма (включая заголовки) ограничен установленной квотой .

// 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()}`,
);

Параметры

Возвращаться

GmailDraft — недавно созданный GmailDraft

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• createDraft(recipient, subject, body, options)

Создает черновик электронного письма с необязательными аргументами. Письмо может содержать обычный текст или HTML-тело. Размер письма (включая заголовки, но исключая вложения) ограничен квотой .

// 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',
    },
);

Параметры

Расширенные параметры

Возвращаться

GmailDraft — недавно созданный GmailDraft

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• createDraft(recipient, subject, body)

Создайте новый пользовательский ярлык с заданным именем.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Параметры

Возвращаться

GmailLabel — недавно созданный ярлык.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• deleteLabel(label)

Удаляет указанную метку.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• createLabel(name)

Получает список электронных адресов, которые настроены как псевдонимы для этой учетной записи в Gmail.

Вы можете отправить сообщение с любого из этих псевдонимов, используя необязательный аргумент "from".

// 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.');
}

Возвращаться

String[] — массив псевдонимов для этой учетной записи

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• sendEmail(recipient, subject, body, options)

Получить черновик электронного письма по идентификатору.

Используйте это в сочетании с функцией getId() в черновиках Gmail.

// 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(),
);

Параметры

Возвращаться

GmailDraft — черновик с указанным ID

Броски

Error — если черновик с указанным идентификатором не найден.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает все черновики сообщений.

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Возвращаться

GmailMessage[] — массив черновиков сообщений Gmail

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает все черновики сообщений Gmail.

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Возвращаться

GmailDraft[] — массив черновиков сообщений Gmail

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает все ветки сообщений во входящих, независимо от меток.

Этот вызов завершится ошибкой, если размер всех потоков окажется слишком большим для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте вызов 'paged' и указывайте диапазоны потоков для получения данных в каждом вызове.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Возвращаться

GmailThread[] — массив цепочек сообщений Gmail во входящих сообщениях.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает диапазон веток сообщений во входящих сообщениях независимо от меток.

// 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());
}

Параметры

Возвращаться

GmailThread[] — массив цепочек сообщений Gmail во входящих сообщениях.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает количество непрочитанных сообщений во входящих.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

Возвращаться

Integer — количество веток входящих сообщений, содержащих непрочитанные сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает сообщение по идентификатору.

Используйте это в сочетании с функцией getId() для сообщений Gmail.

// 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());

Параметры

Возвращаться

GmailMessage — сообщение с указанным ID

Броски

Error — если сообщение с указанным идентификатором не найдено.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• getThreadById(id)

Получить все сообщения в указанной ветке обсуждения.

// 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()}`);
}

Параметры

Возвращаться

GmailMessage[] — массив сообщений, соответствующих этой ветке обсуждения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• getMessagesForThreads(threads)

Получить все сообщения в указанных ветках обсуждения.

// 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()}`);
  }
}

Параметры

Возвращаться

GmailMessage[][] — массив массивов сообщений, где каждый элемент внешнего массива соответствует потоку сообщений, а внутренний массив содержит сообщения в этом потоке.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• getMessagesForThread(thread)

Извлекает все приоритетные ветки сообщений в папке «Входящие» независимо от меток.

Этот вызов завершится ошибкой, если размер всех потоков окажется слишком большим для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте вызов 'paged' и указывайте диапазоны потоков для получения данных в каждом вызове.

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

Возвращаться

GmailThread[] — массив цепочек сообщений Gmail в папке «Приоритетные входящие».

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает диапазон приоритетных веток сообщений в папке «Входящие» независимо от меток.

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

Параметры

Возвращаться

GmailThread[] — массив цепочек сообщений Gmail в папке «Приоритетные входящие».

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает количество непрочитанных сообщений в папке «Приоритетные входящие».

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

Возвращаться

Integer — количество веток в папке «Приоритетные входящие», содержащих непрочитанные сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает все спам-сообщения независимо от меток.

Этот вызов завершится ошибкой, если размер всех потоков окажется слишком большим для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте вызов 'paged' и указывайте диапазоны потоков для получения данных в каждом вызове.

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

Возвращаться

GmailThread[] — массив цепочек писем Gmail в папке «Спам».

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает диапазон спам-сообщений независимо от меток.

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

Параметры

Возвращаться

GmailThread[] — массив цепочек писем Gmail в папке «Спам».

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает количество непрочитанных сообщений, являющихся спамом.

// 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()}`);

Возвращаться

Integer — количество спам-сообщений, содержащих непрочитанные сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает все отмеченные звездочкой ветки независимо от меток.

Этот вызов завершится ошибкой, если размер всех потоков окажется слишком большим для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте вызов 'paged' и указывайте диапазоны потоков для получения данных в каждом вызове.

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

Возвращаться

GmailThread[] — массив отмеченных звездочкой цепочек писем Gmail

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает диапазон помеченных звездочкой веток независимо от меток.

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

Параметры

Возвращаться

GmailThread[] — массив отмеченных звездочкой цепочек писем Gmail

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает количество непрочитанных тем, помеченных звездочкой.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

Возвращаться

Integer — количество отмеченных звездочкой потоков, содержащих непрочитанные сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает ветку обсуждения по ID.

Используйте это в сочетании с функцией getId() в цепочках сообщений Gmail.

// 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(),
);

Параметры

Возвращаться

GmailThread |null — Ветка с указанным ID или null , если не найдена.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• getMessageById(id)

Удаляет все ненужные потоки независимо от меток.

Этот вызов завершится ошибкой, если размер всех потоков окажется слишком большим для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте вызов 'paged' и указывайте диапазоны потоков для получения данных в каждом вызове.

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

Возвращаться

GmailThread[] — массив цепочек писем Gmail в корзине

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает ряд мусорных потоков независимо от меток.

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

Параметры

Возвращаться

GmailThread[] — массив цепочек писем Gmail в корзине

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Извлекает метку по её названию.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Параметры

Возвращаться

GmailLabel — метка Gmail с указанным именем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Получает список созданных пользователем меток.

// 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()}`);
}

Возвращаться

GmailLabel[] — массив созданных пользователями меток

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Помечает это сообщение как прочитанное и принудительно обновляет его.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markMessageUnread(message)

Помечает это сообщение как непрочитанное и принудительно обновляет его.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markMessageRead(message)

Помечает эти сообщения как прочитанные и принудительно обновляет их.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markMessagesUnread(messages)

Помечает эти сообщения как непрочитанные и принудительно обновляет их.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markMessagesRead(messages)

Помечает эту ветку как важную и принудительно обновляет её.

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadUnimportant(thread)

Помечает эту ветку как прочитанную и принудительно обновляет её.

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadUnread(thread)

Помечает эту ветку как неважную и принудительно обновляет её.

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadImportant(thread)

Помечает эту ветку обсуждения как непрочитанную и принудительно обновляет её.

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadRead(thread)

Помечает эти темы как важные и принудительно обновляет их.

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadsUnimportant(threads)

Помечает эти ветки как прочитанные и принудительно обновляет их.

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadsUnread(threads)

Помечает эти темы как неважные и принудительно обновляет их.

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadsImportant(threads)

Помечает эти темы как непрочитанные и принудительно обновляет их.

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• markThreadsRead(threads)

Перемещает сообщение в корзину и принудительно обновляет его.

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Параметры

Возвращаться

GmailApp — сервис Gmail (удобен для создания цепочек писем)

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveMessagesToTrash(messages)

Перемещает указанные сообщения в корзину и принудительно обновляет их.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail (удобен для создания цепочек писем)

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveMessageToTrash(message)

Перемещает эту ветку обсуждения в архив и принудительно обновляет её.

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

Перемещает эту ветку обсуждения во входящие и принудительно обновляет её.

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Перемещает эту ветку в спам и принудительно обновляет её.

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

Перемещает этот поток в корзину и принудительно обновляет его.

// Move first thread in inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToTrash(firstThread);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Перемещает эти темы в архив и принудительно обновляет их.

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

Перемещает эти сообщения во входящие и принудительно обновляет их.

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Перемещает эти темы в спам и принудительно обновляет их.

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

Перемещает эти потоки в корзину и принудительно обновляет их.

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Перезагружает сообщение и связанное с ним состояние из Gmail (полезно в случае изменения меток, состояния прочтения и т. д.).

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...

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• refreshMessages(messages)

Перезагружает сообщения и связанное с ними состояние из Gmail (полезно в случае изменения меток, состояния прочтения и т. д.).

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...

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• refreshMessage(message)

Перезагружает цепочку сообщений и связанное с ней состояние из Gmail (полезно в случае изменения меток, состояния прочтения и т. д.).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• refreshThreads(threads)

Перезагружает цепочки сообщений и связанное с ними состояние из Gmail (полезно в случае изменения меток, состояния прочтения и т. д.).

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• refreshThread(thread)

Выполните поиск в Gmail по указанному запросу.

Этот вызов завершится ошибкой, если размер всех потоков окажется слишком большим для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте вызов 'paged' и указывайте диапазоны потоков для получения данных в каждом вызове.

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Параметры

Возвращаться

GmailThread[] — массив цепочек писем Gmail, соответствующих этому запросу.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Выполните поиск в Gmail по указанному запросу.

// 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);

Параметры

Возвращаться

GmailThread[] — массив цепочек писем Gmail, соответствующих этому запросу.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Отправляет электронное письмо. Размер письма (включая заголовки) ограничен установленной квотой .

// 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()}`,
);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• sendEmail(recipient, subject, body, options)

Отправляет электронное письмо с необязательными аргументами. Письмо может содержать обычный текст или HTML-тело. Размер письма (включая заголовки, но исключая вложения) ограничен квотой .

// 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',
    },
);

Параметры

Расширенные параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• sendEmail(recipient, subject, body)

Устанавливает текущий токен доступа к сообщению , который позволяет скрипту получить доступ к текущим свойствам GmailMessage .

Этот метод требуется только для проектов -дополнений Google Workspace, использующих область действия текущих сообщений Gmail.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

Параметры

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

Добавляет звездочку к этому сообщению и принудительно обновляет его.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• starMessages(messages)

Добавляет звёздочки к этим сообщениям и принудительно обновляет их.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• starMessage(message)

Удаляет звездочку из этого сообщения и принудительно обновляет его.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• unstarMessages(messages)

Удаляет звёздочки из этих сообщений и принудительно обновляет их.

// 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);

Параметры

Возвращаться

GmailApp — сервис Gmail, полезный для создания цепочек писем.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

• https://mail.google.com/

См. также

• unstarMessage(message)