スレッドの管理

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

メッセージと同様に、スレッドにもラベルが適用される場合があります。ただし、メッセージとは異なり、スレッドは作成できず、削除のみ可能です。ただし、スレッドにはメッセージを挿入できます。

目次

スレッドを取得する

スレッドを使用すると、会話内のメッセージを順に簡単に取得できます。 スレッドのセットを一覧表示すると、会話ごとにメッセージをグループ化し、追加のコンテキストを提供できます。スレッドのリストを取得するには、threads.list メソッドを使用します。また、特定のスレッドを取得するには、threads.get を使用します。Message リソースと同じクエリ パラメータを使用して、スレッドをフィルタリングすることもできます。スレッド内のいずれかのメッセージがクエリと一致すると、そのスレッドが結果で返されます。

以下のコードサンプルは、受信トレイに最も通信量の多いスレッドを表示するサンプルでは、両方のメソッドを使用する方法を示しています。threads.list メソッドはすべてのスレッド ID を取得し、threads.get は各スレッドのすべてのメッセージを取得します。返信が 3 件以上の場合は、Subject 行を抽出し、空でない返信とスレッド内のメッセージ数を表示します。このコードサンプルは、対応する DevByte の動画でも紹介されています。

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

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

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

下書きは、下書きメッセージの作成、更新、送信の過程でスレッドに追加できます。メッセージの挿入または送信の一環として、スレッドにメッセージを追加することもできます。

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

  1. リクエストされた threadId は、リクエストと一緒に指定する Message または Draft.Message で指定する必要があります。
  2. References ヘッダーと In-Reply-To ヘッダーは、RFC 2822 規格に従って設定する必要があります。
  3. Subject ヘッダーは一致する必要があります。

下書きの作成またはメッセージの送信の例をご覧ください。どちらの場合も、threadId キーとスレッド ID のペアをメッセージのメタデータ（message オブジェクト）に追加するだけです。