Method: users.drafts.list

Mencantumkan draf dalam kotak surat pengguna.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna terautentikasi.

Parameter kueri

Parameter
maxResults

integer (uint32 format)

Jumlah maksimum draf yang akan ditampilkan. Kolom ini ditetapkan secara default ke 100. Nilai maksimum yang diizinkan untuk kolom ini adalah 500.
pageToken

string

Token halaman untuk mengambil halaman hasil tertentu dalam daftar.
q

string

Hanya tampilkan pesan draf 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".
includeSpamTrash

boolean

Sertakan draf 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 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Kolom
drafts[]

object (Draft)

Daftar draf. Perhatikan bahwa properti Message di setiap resource Draft hanya berisi id dan threadId. Metode messages.get dapat mengambil detail pesan tambahan.
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.compose
  • https://www.googleapis.com/auth/gmail.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.