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 でエンコードされた文字列。

メッセージ パート

単一の 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

Methods

batchDelete

メッセージ ID で多くのメッセージを削除します。

batchModify

指定したメッセージのラベルを変更します。

delete

指定したメッセージを直ちに完全に削除されます。

get

指定されたメッセージを取得します。

import

メールをこのユーザーのメールボックスにのみ読み込み、SMTP 経由での受信と同様の標準的なメール配信スキャンと分類を行います。

insert

IMAP APPEND と同様の方法で、このユーザーのメールボックスだけにメールを直接挿入します。このとき、ほとんどのスキャンと分類は省略されます。

list

ユーザーのメールボックス内のメールを一覧表示します。

modify

指定されたメッセージのラベルを変更します。

send

ToCcBcc ヘッダーで受信者に指定されたメッセージを送信します。

trash

指定したメールをゴミ箱に移動します。

untrash

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