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. リクエストされた 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 でエンコードされた文字列。
classificationLabelValues[]

object (ClassificationLabelValue)

メッセージの分類ラベルの値。使用可能な分類ラベル スキーマは、Google Drive Labels API を使用してクエリできます。各分類ラベル ID は一意である必要があります。重複する ID が指定された場合、1 つのみが保持されます。選択は任意です。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)

このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表す最上位のメッセージ部分には、To、From、Subject などの標準の RFC 2822 メールヘッダーが含まれます。
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 または未加工の英数字の分類ラベル 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

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