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. リクエストする threadId は、リクエストで指定した Message または Draft.Message で指定する必要があります。
  2. References ヘッダーと In-Reply-To ヘッダーは、RFC 2822 標準に従って設定する必要があります。
  3. Subject ヘッダーは一致している必要があります。

labelIds[]

string

このメッセージに適用されたラベルの ID のリスト。

snippet

string

メッセージ テキストの短い部分。

historyId

string

このメッセージを変更した最後の履歴レコードの ID。

internalDate

string (int64 format)

内部メッセージ作成タイムスタンプ(エポックミリ秒)。受信トレイでの順序を決定します。通常の SMTP 受信メールの場合、これはメッセージが Google で最初に受け入れられた時刻を表し、Date ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールについては、Date ヘッダーに基づいてクライアントで構成できます。

payload

object (MessagePart)

メッセージ部分の解析されたメールの構造。

sizeEstimate

integer

メッセージの推定サイズ(バイト単位)。

raw

string (bytes format)

RFC 2822 形式の base64url でエンコードされた文字列のメール メッセージ全体。format=RAW パラメータが指定されている場合、messages.get レスポンスと drafts.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)

このメッセージ パートのヘッダーのリスト。最上位のメッセージ パート(メッセージ ペイロード全体を表す)には、ToFromSubject などの標準の RFC 2822 メールヘッダーが含まれます。

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

指定したメッセージをゴミ箱から削除します。