REST Resource: users.messages

リソース: メッセージ

メール メッセージ。

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)

内部メッセージの作成タイムスタンプ（エポック ms）。受信トレイでの順序を決定します。通常の 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 ドライブ ラベル API を使用してクエリできます。各分類ラベル ID は一意である必要があります。重複する ID が指定された場合、1 つだけが保持され、選択は任意です。Google Workspace アカウントでのみ使用されます。リクエストごとに指定できる分類ラベル値は 20 個までです。分類ラベル値が許容される最大数を超えると、リクエストは失敗します。

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 メッセージ パーツ。これは、multipart/* などのコンテナ MIME メッセージ パーツにのみ適用されます。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

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