Method: users.messages.list

Mencantumkan pesan di kotak surat pengguna.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna yang diautentikasi.

Parameter kueri

Parameter
maxResults

integer (uint32 format)

Jumlah maksimum pesan yang akan ditampilkan. Setelan default kolom ini adalah 100. Nilai maksimum yang diizinkan untuk kolom ini adalah 500.
pageToken

string

Token halaman untuk mengambil halaman hasil tertentu dalam daftar.
q

string

Hanya menampilkan pesan yang cocok dengan kueri yang ditentukan. Mendukung format kueri yang sama dengan kotak penelusuran Gmail. Misalnya, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter tidak dapat digunakan saat mengakses API menggunakan cakupan gmail.metadata.
labelIds[]

string

Hanya menampilkan pesan dengan label yang cocok dengan semua ID label yang ditentukan. Pesan dalam rangkaian pesan mungkin memiliki label yang tidak dimiliki pesan lain dalam rangkaian pesan yang sama. Untuk mempelajari lebih lanjut, lihat Mengelola label pada pesan dan rangkaian pesan.
includeSpamTrash

boolean

Sertakan pesan dari SPAM dan TRASH dalam hasil.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Kolom
messages[]

object (Message)

Daftar pesan. Perhatikan bahwa setiap resource pesan hanya berisi id dan threadId. Detail pesan tambahan dapat diambil menggunakan metode messages.get.
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya dalam daftar.
resultSizeEstimate

integer (uint32 format)

Estimasi jumlah total hasil.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.