Method: users.messages.list

แสดงรายการข้อความในกล่องจดหมายของผู้ใช้ ดูตัวอย่างการใช้งานได้ที่แสดงข้อความ Gmail

คำขอ HTTP

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

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" ใช้พารามิเตอร์ไม่ได้เมื่อเข้าถึง API โดยใช้ขอบเขต gmail.metadata
labelIds[]

string

แสดงเฉพาะข้อความที่มีป้ายกำกับที่ตรงกับรหัสป้ายกำกับที่ระบุทั้งหมด ข้อความในชุดข้อความอาจมีป้ายกำกับที่ข้อความอื่นๆ ในชุดข้อความเดียวกันไม่มี ดูข้อมูลเพิ่มเติมได้ที่หัวข้อจัดการป้ายกำกับในข้อความและเธรด
includeSpamTrash

boolean

รวมข้อความจาก SPAM และ TRASH ไว้ในผลการค้นหา

เนื้อความของคำขอ

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

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

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

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

object (Message)

รายการข้อความ โปรดทราบว่าทรัพยากรข้อความแต่ละรายการมีเพียง 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.readonly
  • https://www.googleapis.com/auth/gmail.metadata

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