Расширенный сервис Gmail

Расширенный сервис Gmail позволяет использовать API Gmail в Apps Script. Подобно встроенному сервису Gmail в Apps Script, этот API позволяет скриптам находить и изменять цепочки писем, сообщения и метки в почтовом ящике Gmail. В большинстве случаев встроенный сервис проще в использовании, но этот расширенный сервис предоставляет несколько дополнительных функций и доступ к более подробной информации о содержимом Gmail.

Примечание: это расширенная услуга, которую необходимо включить перед использованием .

Ссылка

Подробную информацию об этом сервисе см. в справочной документации по API Gmail. Как и все расширенные сервисы в Apps Script, расширенный сервис Gmail использует те же объекты, методы и параметры, что и общедоступный API. Подробнее см. в статье «Как определяются сигнатуры методов» .

Примечание: Для повышения производительности API Gmail часто ограничивает объём информации, возвращаемой по запросам на list , идентификаторами цепочек, сообщений или ярлыков, а также другими простыми данными. Более подробную информацию о конкретной цепочке, сообщении или ярлыке можно получить, выполнив дополнительный запрос get , используя соответствующий идентификатор.

Чтобы сообщить о проблемах и найти другую поддержку, см. руководство по поддержке Gmail .

Пример кода

В примере кода ниже используется версия API 1 .

Список информации на этикетке

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

расширенный/gmail.gs

Посмотреть на GitHub

/**
 * Lists the user's labels, including name, type,
 * ID and visibility information.
 */
function listLabelInfo() {
  try {
    const response =
      Gmail.Users.Labels.list('me');
    for (let i = 0; i < response.labels.length; i++) {
      const label = response.labels[i];
      console.log(JSON.stringify(label));
    }
  } catch (err) {
    console.log(err);
  }
}

Список фрагментов входящих сообщений

В следующем примере показано, как составить список фрагментов текста, связанных с каждой цепочкой сообщений в папке «Входящие» пользователя. Обратите внимание на использование токенов страниц для доступа к полному списку результатов.

расширенный/gmail.gs

Посмотреть на GitHub

/**
 * Lists, for each thread in the user's Inbox, a
 * snippet associated with that thread.
 */
function listInboxSnippets() {
  try {
    let pageToken;
    do {
      const threadList = Gmail.Users.Threads.list('me', {
        q: 'label:inbox',
        pageToken: pageToken
      });
      if (threadList.threads && threadList.threads.length > 0) {
        threadList.threads.forEach(function (thread) {
          console.log('Snippet: %s', thread.snippet);
        });
      }
      pageToken = threadList.nextPageToken;
    } while (pageToken);
  } catch (err) {
    console.log(err);
  }
}

Список недавней истории

В следующем примере показано, как регистрировать историю недавних действий. В частности, этот пример восстанавливает идентификатор записи истории, связанный с последним отправленным пользователем сообщением, а затем регистрирует идентификаторы всех сообщений, изменённых с этого момента. Каждое изменённое сообщение регистрируется только один раз, независимо от количества событий изменения в записях истории. Обратите внимание на использование токенов страниц для доступа к полному списку результатов.

расширенный/gmail.gs

Посмотреть на GitHub

/**
 * Gets a history record ID associated with the most
 * recently sent message, then logs all the message IDs
 * that have changed since that message was sent.
 */
function logRecentHistory() {
  try {
    // Get the history ID associated with the most recent
    // sent message.
    const sent = Gmail.Users.Threads.list('me', {
      q: 'label:sent',
      maxResults: 1
    });
    if (!sent.threads || !sent.threads[0]) {
      console.log('No sent threads found.');
      return;
    }
    const historyId = sent.threads[0].historyId;

    // Log the ID of each message changed since the most
    // recent message was sent.
    let pageToken;
    const changed = [];
    do {
      const recordList = Gmail.Users.History.list('me', {
        startHistoryId: historyId,
        pageToken: pageToken
      });
      const history = recordList.history;
      if (history && history.length > 0) {
        history.forEach(function (record) {
          record.messages.forEach(function (message) {
            if (changed.indexOf(message.id) === -1) {
              changed.push(message.id);
            }
          });
        });
      }
      pageToken = recordList.nextPageToken;
    } while (pageToken);

    changed.forEach(function (id) {
      console.log('Message Changed: %s', id);
    });
  } catch (err) {
    console.log(err);
  }
}

Список сообщений

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

расширенный/gmail.gs

Посмотреть на GitHub

/**
 * Lists unread messages in the user's inbox using the advanced Gmail service.
 */
function listMessages() {
  // The special value 'me' indicates the authenticated user.
  const userId = 'me';

  // Define optional parameters for the request.
  const options = {
    maxResults: 10, // Limit the number of messages returned.
    q: 'is:unread', // Search for unread messages.
  };

  try {
    // Call the Gmail.Users.Messages.list method.
    const response = Gmail.Users.Messages.list(userId, options);
    const messages = response.messages;
    console.log('Unread Messages:');

    for (const message of messages) {
      console.log(`- Message ID: ${message.id}`);
    }
  } catch (err) {
    // Log any errors to the Apps Script execution log.
    console.log(`Failed with error: ${err.message}`);
  }
}