Method: users.messages.list

ユーザーのメールボックス内のメッセージを一覧表示します。使用例については、Gmail メッセージを一覧表示するをご覧ください。

HTTP リクエスト

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId

string

ユーザーのメールアドレス。特別な値 me を使用して、認証済みユーザーを示すことができます。

クエリ パラメータ

パラメータ
maxResults

integer (uint32 format)

返すメッセージの最大数。このフィールドのデフォルトは 100 です。このフィールドに設定可能な最大値は 500 です。
pageToken

string

リスト内の結果の特定のページを取得するためのページトークン。
q

string

指定されたクエリに一致するメッセージのみを返します。Gmail の検索ボックスと同じクエリ形式をサポートしています。たとえば、"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".gmail.metadata スコープを使用して API にアクセスする場合、このパラメータは使用できません。
labelIds[]

string

指定されたすべてのラベル ID に一致するラベルが付いたメッセージのみを返します。スレッド内のメッセージには、同じスレッド内の他のメッセージにはないラベルが付いている場合があります。詳しくは、メッセージとスレッドのラベルを管理するをご覧ください。
includeSpamTrash

boolean

SPAM と TRASH からのメッセージを結果に含めます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
フィールド
messages[]

object (Message)

メッセージのリスト。各メッセージ リソースには id と threadId のみが含まれています。追加のメッセージの詳細は、messages.get メソッドを使用して取得できます。
nextPageToken

string

リスト内の結果の次のページを取得するためのトークン。
resultSizeEstimate

integer (uint32 format)

推定結果の合計数。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

詳しくは、承認ガイドをご覧ください。