Method: users.drafts.list

แสดงรายการร่างจดหมายในกล่องจดหมายของผู้ใช้

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
userId

string

อีเมลของผู้ใช้ ค่าพิเศษ me สามารถใช้เพื่อระบุผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

พารามิเตอร์การค้นหา

พารามิเตอร์
maxResults

integer (uint32 format)

จำนวนสูงสุดของข้อความร่างที่จะแสดง ช่องนี้จะมีค่าเริ่มต้นเป็น 100 ค่าสูงสุดที่อนุญาตสําหรับช่องนี้คือ 500
pageToken

string

โทเค็นหน้าเพื่อเรียกข้อมูลหน้าผลลัพธ์ที่เจาะจงในรายการ
q

string

แสดงผลข้อความร่างที่ตรงกับคำค้นหาที่ระบุเท่านั้น รองรับการค้นหารูปแบบเดียวกับช่องค้นหาของ Gmail เช่น "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"
includeSpamTrash

boolean

รวมฉบับร่างจาก SPAM และ TRASH ไว้ในผลลัพธ์

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
ช่อง
drafts[]

object (Draft)

รายการฉบับร่าง โปรดทราบว่าพร็อพเพอร์ตี้ Message ในทรัพยากร Draft แต่ละรายการจะมีเฉพาะ 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.compose
  • https://www.googleapis.com/auth/gmail.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์