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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview