スレッドを管理する

このドキュメントでは、Gmail API を使用してスレッド メッセージを取得し、スレッドにメッセージを追加する方法について説明します。

Gmail API は、threads リソースを使用して、メールの返信とその元のメッセージを 1 つのスレッドにまとめます。これにより、会話内のすべてのメッセージを順番に取得できるため、メッセージのコンテキストを把握したり、検索結果を絞り込んだりすることが容易になります。

messages リソースと同様に、スレッドにラベルを適用することもできます。ただし、メッセージとは異なり、スレッドは作成できません。削除のみ可能です。ただし、メッセージをスレッドに挿入することはできます。

スレッドを取得する

スレッドを使用すると、会話内のメッセージを順番に取得できます。一連のスレッドをリストすることで、会話ごとにメッセージをグループ化し、追加のコンテキストを提供できます。threads.list メソッドを使用してスレッドのリストを取得するか、threads.get メソッドを使用して特定のスレッドを取得できます。

次のコードサンプルは、受信トレイで最もチャットの多いスレッドを取得するサンプルで threads.get メソッドと threads.list メソッドを使用する方法を示しています。threads.list メソッドはすべてのスレッド ID を取得し、threads.get は各スレッド内のすべてのメッセージを取得します。返信が 3 件以上のメッセージについては、Subject 行を抽出し、空でない行とスレッド内のメッセージ数を表示します。

Python

gmail/snippet/thread/threads.py
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def show_chatty_threads():
  """Display threads with long conversations(>= 3 messages)
  Return: None

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    # pylint: disable=maybe-no-member
    # pylint: disable:R1710
    threads = (
        service.users().threads().list(userId="me").execute().get("threads", [])
    )
    for thread in threads:
      tdata = (
          service.users().threads().get(userId="me", id=thread["id"]).execute()
      )
      nmsgs = len(tdata["messages"])

      # skip if <3 msgs in thread
      if nmsgs > 2:
        msg = tdata["messages"][0]["payload"]
        subject = ""
        for header in msg["headers"]:
          if header["name"] == "Subject":
            subject = header["value"]
            break
        if subject:  # skip if no Subject line
          print(f"- {subject}, {nmsgs}")
    return threads

  except HttpError as error:
    print(f"An error occurred: {error}")


if __name__ == "__main__":
  show_chatty_threads()

messages リソースで使用されるものと同じクエリ パラメータを使用して、スレッドをフィルタすることもできます。スレッド内のいずれかのメッセージがクエリと一致すると、そのスレッドが結果として返されます。

スレッドに下書きとメッセージを追加する

別のメールへの返信や会話の一部であるメッセージを送信または移行する場合は、アプリケーションでそのメッセージを関連するスレッドに追加する必要があります。これにより、会話に参加している Gmail ユーザーはメッセージのコンテキストを把握しやすくなります。

下書きは、drafts リソースを使用してメッセージを作成、更新、または送信する際に、スレッドに追加できます。

messages リソースを使用してメッセージを挿入または送信する際に、スレッドにメッセージを追加することもできます。

スレッドの一部となるには、下書きまたはメッセージが次の条件を満たしている必要があります。

  1. リクエストされた threadId は、リクエストで指定する drafts.message または messages リソースの一部として指定する必要があります。

  2. References ヘッダーと In-Reply-To ヘッダーは、RFC 2822 標準に準拠して設定する必要があります。

  3. Subject ヘッダーが一致している必要があります。

threadId の使用方法のコードサンプルについては、下書きを作成するまたはメッセージを送信するをご覧ください。どちらの場合も、リクエストの messages リソース内にターゲット threadId を含める必要があります。