Listar mensagens do Gmail

Esta página explica como chamar o método users.messages.list da API Gmail.

O método retorna uma matriz de recursos Message do Gmail que contêm a mensagem id e threadId. Para recuperar todos os detalhes da mensagem, use o método users.messages.get.

Pré-requisitos

Python

Um projeto do Google Cloud com a API Gmail ativada. Para conferir as etapas, conclua o guia de início rápido da API Gmail em Python.

Listar mensagens

O método users.messages.list é compatível com vários parâmetros de consulta para filtrar as mensagens:

  • maxResults: número máximo de mensagens a serem retornadas (o padrão é 100, e o máximo é 500).
  • pageToken: token para recuperar uma página específica de resultados.
  • q: string de consulta para filtrar mensagens, como from:someuser@example.com is:unread".
  • labelIds: retorna apenas mensagens com rótulos que correspondem a todos os IDs de rótulo especificados.
  • includeSpamTrash: inclua mensagens de SPAM e TRASH nos resultados.

Exemplo de código

Python

O exemplo de código a seguir mostra como listar mensagens do usuário autenticado do Gmail. O código processa a paginação para recuperar todas as mensagens que correspondem à consulta.

gmail/snippet/list_messages.py
import os.path
from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# If modifying these scopes, delete the file token.json.
SCOPES = ["https://www.googleapis.com/auth/gmail.readonly"]


def main():
    """Shows basic usage of the Gmail API.
    Lists the user's Gmail messages.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists("token.json"):
        creds = Credentials.from_authorized_user_file("token.json", SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file("credentials.json", SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open("token.json", "w") as token:
            token.write(creds.to_json())

    try:
        # Call the Gmail API
        service = build("gmail", "v1", credentials=creds)
        results = (
            service.users().messages().list(userId="me", labelIds=["INBOX"]).execute()
        )
        messages = results.get("messages", [])

        if not messages:
            print("No messages found.")
            return

        print("Messages:")
        for message in messages:
            print(f'Message ID: {message["id"]}')
            msg = (
                service.users().messages().get(userId="me", id=message["id"]).execute()
            )
            print(f'  Subject: {msg["snippet"]}')

    except HttpError as error:
        # TODO(developer) - Handle errors from gmail API.
        print(f"An error occurred: {error}")


if __name__ == "__main__":
    main()

O método users.messages.list retorna um corpo de resposta que contém o seguinte:

  • messages[]: uma matriz de recursos Message.
  • nextPageToken: para solicitações com várias páginas de resultados, um token que pode ser usado com chamadas subsequentes para listar mais mensagens.
  • resultSizeEstimate: um número total estimado de resultados.

Para buscar o conteúdo completo da mensagem e os metadados, use o campo message.id para chamar o método users.messages.get.