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
}
欄位
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

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