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

На этой странице объясняется, как вызвать метод users.messages.list API Gmail.

Метод возвращает массив ресурсов Gmail Message , содержащий id сообщения и threadId . Чтобы получить полную информацию о сообщении, используйте метод users.messages.get .

Предпосылки

Питон

Проект Google Cloud с включённым API Gmail. Инструкции см. в кратком руководстве по Gmail API Python .

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

Метод users.messages.list поддерживает несколько параметров запроса для фильтрации сообщений:

  • maxResults : Максимальное количество возвращаемых сообщений (по умолчанию 100, максимум 500).
  • pageToken : токен для получения определенной страницы результатов.
  • q : Строка запроса для фильтрации сообщений, например from:someuser@example.com is:unread" .
  • labelIds : возвращать только сообщения с метками, которые соответствуют всем указанным идентификаторам меток.
  • includeSpamTrash : Включить сообщения из SPAM и TRASH в результаты.

Пример кода

Питон

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

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

Метод users.messages.list возвращает тело ответа, содержащее следующее:

  • messages[] : Массив ресурсов Message .
  • nextPageToken : для запросов с несколькими страницами результатов — токен, который можно использовать с последующими вызовами для вывода большего количества сообщений.
  • resultSizeEstimate : предполагаемое общее количество результатов.

Чтобы получить полное содержимое сообщения и метаданные, используйте поле message.id для вызова метода users.messages.get .