REST Resource: users.messages

資源：Message

電子郵件訊息。

JSON 表示法 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
欄位
id

string

郵件的固定 ID。
threadId

string

訊息所屬的討論串 ID。如要將訊息或草稿新增至討論串，必須符合下列條件：

  1. 您在要求中提供的 Message 或 Draft.Message 必須指定要求的 threadId。
  2. References 和 In-Reply-To 標頭必須按照 RFC 2822 標準設定。
  3. Subject 標頭必須相符。
labelIds[]

string

套用至這封郵件的標籤 ID 清單。
snippet

string

訊息文字的一小部分。
historyId

string

修改這則訊息的最後一筆記錄 ID。
internalDate

string (int64 format)

內部郵件建立時間戳記 (以 Epoch 毫秒為單位)，決定收件匣中的排序方式。如果是透過一般 SMTP 接收的電子郵件，這代表 Google 最初接受郵件的時間，比 Date 標頭更可靠。不過，如果是透過 API 遷移的郵件，用戶端可以設定根據 Date 標頭進行分類。
payload

object (MessagePart)

郵件部分的剖析電子郵件結構。
sizeEstimate

integer

郵件的預估大小 (以位元組為單位)。
raw

string (bytes format)

以 RFC 2822 格式設定的完整電子郵件，並以 base64url 編碼的字串。提供 format=RAW 參數時，會在 messages.get 和 drafts.get 回應中傳回。

Base64 編碼字串。
classificationLabelValues[]

object (ClassificationLabelValue)

郵件的分類標籤值。您可以使用 Google Drive Labels API 查詢可用的分類標籤結構定義。每個分類標籤 ID 均不得重複。如果提供重複的 ID，系統只會保留其中一個，且會任意選取。僅適用於 Google Workspace 帳戶。

MessagePart

單一 MIME 郵件部分。

JSON 表示法 
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
欄位
partId

string

郵件部分的固定 ID。
mimeType

string

郵件部分的 MIME 類型。
filename

string

附件的檔案名稱。只有當這個郵件部分代表附件時才會顯示。
headers[]

object (Header)

這個郵件部分的標頭清單。對於代表整個郵件酬載的頂層郵件部分，其中會包含標準 RFC 2822 電子郵件標頭，例如 To、From 和 Subject。
body

object (MessagePartBody)

這個部分的郵件部分內文，容器 MIME 郵件部分可能為空白。
parts[]

object (MessagePart)

這個部分的子 MIME 郵件部分。這項功能僅適用於容器 MIME 郵件部分，例如 multipart/*。如果是 text/plain 等非容器 MIME 郵件部分類型，這個欄位會空白。詳情請參閱 RFC 1521。
JSON 表示法 
{
  "name": string,
  "value": string
}
欄位
name

string

: 分隔符號前的標頭名稱。例如 To。
value

string

: 分隔符號後的標頭值。例如 someuser@example.com。

ClassificationLabelValue

套用至電子郵件的分類標籤。分類標籤與 Gmail 收件匣標籤不同。僅適用於 Google Workspace 帳戶。進一步瞭解分類標籤。

JSON 表示法 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
欄位
labelId

string

必要欄位。標準或原始的英數字元分類標籤 ID。對應至 Google 雲端硬碟標籤資源的 ID 欄位。
fields[]

object (ClassificationLabelFieldValue)

指定分類標籤 ID 的欄位值。

ClassificationLabelFieldValue

分類標籤的欄位值。

JSON 表示法 
{
  "fieldId": string,
  "selection": string
}
欄位
fieldId

string

必要欄位。分類標籤值的欄位 ID。對應至 Google 雲端硬碟 Label.Field 物件的 ID 欄位。
selection

string

選取選項的選取選項 ID。只有在 Google 雲端硬碟 Label.Field 物件中的欄位類型為 SELECTION 時，才需要設定。對應至 Google 雲端硬碟 Label.Field.SelectionOptions 資源的 ID 欄位。

方法

batchDelete

 依訊息 ID 刪除多封郵件。

batchModify

 修改指定郵件的標籤。

delete

 立即永久刪除指定郵件。

get

 取得指定的訊息。

import

 將郵件匯入這個使用者的信箱，並進行標準電子郵件傳輸掃描和分類，與透過 SMTP 接收郵件類似。

insert

 直接將郵件插入這位使用者的信箱，類似於 IMAP APPEND，略過大部分的掃描和分類程序。

list

 列出使用者信箱中的郵件。

modify

 修改指定郵件的標籤。

send

 將指定訊息傳送給 To、Cc 和 Bcc 標頭中的收件者。

trash

 將指定郵件移至垃圾桶。

untrash

 從垃圾桶中移除指定郵件。