ユーザーのメールボックス内のメールを一覧表示します。
HTTP リクエスト
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
userId |
ユーザーのメールアドレス。特別な値 |
クエリ パラメータ
パラメータ | |
---|---|
maxResults |
返されるメッセージの最大数。このフィールドのデフォルトは 100 です。このフィールドに指定できる最大値は 500 です。 |
pageToken |
リスト内の結果の特定のページを取得するためのページトークン。 |
q |
指定したクエリに一致するメッセージのみを返します。Gmail の検索ボックスと同じクエリ形式をサポートします。たとえば、 |
labelIds[] |
指定したすべてのラベル ID に一致するラベルを持つメールのみを返します。スレッド内のメールに、同じスレッド内の他のメールにはないラベルが付いていることがあります。詳しくは、メッセージとスレッドのラベルを管理するをご覧ください。 |
includeSpamTrash |
結果に |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"messages": [
{
object ( |
フィールド | |
---|---|
messages[] |
メッセージのリスト。各メッセージ リソースには |
nextPageToken |
リスト内の結果の次のページを取得するためのトークン。 |
resultSizeEstimate |
結果の推定総数。 |
認可スコープ
次の 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
詳細については、承認ガイドをご覧ください。