REST Resource: users.messages

資源:訊息

電子郵件訊息。

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

string

訊息的不可變更 ID。

threadId

string

訊息所屬的討論串 ID。如要在討論串中新增郵件或草稿,必須符合下列條件:

  1. 您必須在要求中提供的 MessageDraft.Message 中指定要求的 threadId
  2. ReferencesIn-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.getdrafts.get 回應中傳回。

Base64 編碼的字串。

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 電子郵件標頭,例如 ToFromSubject

body

object (MessagePartBody)

這部分的郵件部分內文;如果是容器 MIME 郵件部分,可能會留空。

parts[]

object (MessagePart)

這個部分的子項 MIME 郵件部分。這僅適用於容器 MIME 郵件部分,例如 multipart/*。如果是非容器 MIME 郵件部分類型 (例如 text/plain),則這個欄位會留空。詳情請參閱 RFC 1521

JSON 表示法
{
  "name": string,
  "value": string
}
欄位
name

string

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

value

string

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

方法

batchDelete

依郵件 ID 刪除多封郵件。

batchModify

修改指定郵件的標籤。

delete

立即永久刪除指定的郵件。

get

取得指定訊息。

import

將郵件匯入這位使用者的信箱,並提供標準電子郵件傳送掃描和分類功能,與透過 SMTP 接收類似。

insert

直接將郵件插入 (類似 IMAP APPEND) 的信箱中,略過大部分的掃描和分類作業。

list

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

modify

修改指定郵件的標籤。

send

將指定郵件傳送給 ToCcBcc 標頭中的收件者。

trash

將指定郵件移至垃圾桶。

untrash

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