管理執行緒

Gmail API 會使用 Thread 資源,將電子郵件回覆與原始郵件歸入單一會話或會話串。這樣一來,您就能依序擷取對話中的所有訊息,方便瞭解訊息內容或精進搜尋結果。

訊息一樣,會話串也可以套用標籤。不過,與訊息不同的是,您無法建立會話串,只能刪除。不過,您可以將訊息插入會話串。

目錄

擷取執行緒

您可以透過會話串,輕鬆依序擷取對話中的訊息。您可以列出一系列的會話串,選擇依對話群組訊息,並提供其他背景資訊。您可以使用 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. 您必須在 MessageDraft.Message 中指定所要求的 threadId
  2. ReferencesIn-Reply-To 標頭必須符合 RFC 2822 標準。
  3. Subject 標頭必須相符。

請參閱建立草稿傳送訊息的範例。無論是哪種情況,您只需將與執行緒 ID 配對的 threadId 鍵新增至訊息的中繼資料 (message 物件) 即可。