Serviço avançado do Gmail

O serviço avançado do Gmail permite usar a API Gmail no Google Apps Script. Assim como o serviço integrado do Gmail do Apps Script, essa API permite que os scripts encontrem e modifiquem conversas, mensagens e marcadores em uma caixa de e-mails do Gmail. Na maioria dos casos, o serviço integrado é mais fácil de usar, mas esse serviço avançado oferece alguns recursos extras e acesso a informações mais detalhadas sobre o conteúdo do Gmail.

Esse é um serviço avançado que precisa ser ativado antes do uso.

Referência

Para informações detalhadas sobre esse serviço, consulte a documentação de referência para a API Gmail. Assim como todos os serviços avançados no Apps Script, o serviço avançado do Gmail usa os mesmos objetos, métodos e parâmetros que a API pública. Para mais informações, consulte Como as assinaturas de método são determinadas.

Para informar problemas e encontrar outros tipos de suporte, consulte o guia de suporte do Gmail.

Exemplo de código

O exemplo de código a seguir usa a versão 1 da API.

Listar informações de marcadores

O exemplo a seguir demonstra como listar todas as informações de marcadores do usuário. Isso inclui o nome, o tipo, o ID e as configurações de visibilidade do marcador.

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

Listar snippets da caixa de entrada

O exemplo a seguir demonstra como listar snippets de texto associados a cada conversa na caixa de entrada do usuário. Observe o uso de tokens de página para acessar a lista completa de resultados.

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) {
        for (const thread of threadList.threads) {
          console.log(`Snippet: ${thread.snippet}`);
        }
      }
      pageToken = threadList.nextPageToken;
    } while (pageToken);
  } catch (err) {
    console.log(err);
  }
}

Listar histórico recente

O exemplo a seguir demonstra como registrar o histórico de atividades recentes. Especificamente, esse exemplo recupera o ID do registro de histórico associado à mensagem enviada mais recentemente pelo usuário e, em seguida, registra os IDs de mensagem de todas as mensagens que foram alteradas desde então. Cada mensagem alterada é registrada apenas uma vez, não importa quantos eventos de mudança estejam nos registros de histórico. Observe o uso de tokens de página para acessar a lista completa de resultados.

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) {
        for (const record of history) {
          for (const message of record.messages) {
            if (changed.indexOf(message.id) === -1) {
              changed.push(message.id);
            }
          }
        }
      }
      pageToken = recordList.nextPageToken;
    } while (pageToken);

    for (const id of changed) {
      console.log("Message Changed: %s", id);
    }
  } catch (err) {
    console.log(err);
  }
}

Listar mensagens

O exemplo a seguir demonstra como listar as mensagens não lidas do usuário do Gmail.

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