Zaawansowana usługa Gmail

Usługa Gmail Advanced umożliwia korzystanie z interfejsu Gmail API w Apps Script. Podobnie jak wbudowana usługa Gmail w Apps Script, ten interfejs API umożliwia skryptom znajdowanie i modyfikowanie wątków, wiadomości i etykiet w skrzynce pocztowej Gmail. W większości przypadków wbudowana usługa jest łatwiejsza w użyciu, ale ta zaawansowana usługa zapewnia kilka dodatkowych funkcji i dostęp do bardziej szczegółowych informacji o treściach Gmaila.

Dokumentacja

Szczegółowe informacje o tej usłudze znajdziesz w dokumentacji referencyjnej interfejsu Gmail API. Podobnie jak wszystkie zaawansowane usługi w Apps Script, zaawansowana usługa Gmail używa tych samych obiektów, metod i parametrów co publiczny interfejs API. Więcej informacji znajdziesz w artykule Jak określane są podpisy metod.

Aby zgłaszać problemy i uzyskać inną pomoc, zapoznaj się z przewodnikiem pomocy Gmaila.

Przykładowy kod

Poniżej przykładowy kod korzysta z wersji 1 interfejsu API.

Wyświetlanie informacji o etykietach

Ten przykład pokazuje, jak wyświetlić wszystkie informacje o etykietach użytkownika. Obejmuje to nazwę, typ, identyfikator i ustawienia widoczności etykiety.

advanced/gmail.gs
/**
 * 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);
  }
}

Wyświetlanie fragmentów skrzynki odbiorczej

Ten przykład pokazuje, jak wyświetlić fragmenty tekstu powiązane z każdym wątkiem w skrzynce odbiorczej użytkownika. Zwróć uwagę, że do uzyskania dostępu do pełnej listy wyników używasz tokenów strony.

advanced/gmail.gs
/**
 * 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);
  }
}

Lista najnowszej historii

Ten przykład pokazuje, jak rejestrować historię ostatniej aktywności. W tym przykładzie odzyskiwany jest identyfikator rekordu historii powiązany z ostatnią wysłaną przez użytkownika wiadomością, a następnie rejestrowane są identyfikatory wszystkich wiadomości, które uległy zmianie od tego czasu. Każda zmieniona wiadomość jest rejestrowana tylko raz, niezależnie od liczby zdarzeń zmiany w rekordach historii. Zwróć uwagę na użycie tokenów strony, aby uzyskać dostęp do pełnej listy wyników.

advanced/gmail.gs
/**
 * 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);
  }
}