เอกสารนี้อธิบายวิธีเรียกใช้
messages.list
ของ Gmail API
เมธอดจะแสดงผลอาร์เรย์ของออบเจ็กต์ messages ของ Gmail ซึ่งมี id และ threadId ของข้อความ หากต้องการดึงข้อมูลรายละเอียดข้อความทั้งหมด ให้ใช้
messages.get
เมธอด
ออบเจ็กต์ messages ที่แสดงผลจะแสดงตามลำดับเวลาแบบย้อนกลับ (ใหม่สุดก่อน)
ข้อกำหนดเบื้องต้น
Python
โปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google Cloud ที่เปิดใช้ Gmail API หากต้องการดูขั้นตอน ให้ทำตามคู่มือเริ่มต้นใช้งานฉบับย่อของ Gmail API Python
แสดงรายการข้อความ
เมธอด messages.list รองรับพารามิเตอร์การค้นหาหลายรายการเพื่อกรองข้อความ ดังนี้
maxResults: จำนวนข้อความสูงสุดที่จะแสดงผล (ค่าเริ่มต้นคือ 100 และสูงสุดคือ 500)pageToken: โทเค็นเพื่อดึงข้อมูลผลลัพธ์หน้าใดหน้าหนึ่งq: สตริงค้นหาเพื่อกรองข้อความ เช่นfrom:someuser@example.com is:unreadlabelIds: แสดงผลเฉพาะข้อความที่มีป้ายกำกับที่ตรงกับรหัสป้ายกำกับที่ระบุทั้งหมดincludeSpamTrash: รวมข้อความจากSPAMและTRASHไว้ในผลลัพธ์
ตัวอย่างโค้ด
Python
ตัวอย่างโค้ดต่อไปนี้แสดงวิธีแสดงรายการข้อความสำหรับผู้ใช้ Gmail ที่ได้รับการตรวจสอบสิทธิ์ โค้ดจะจัดการการแบ่งหน้าเพื่อดึงข้อมูลข้อความทั้งหมดที่ตรงกับการค้นหา
เมธอด messages.list จะแสดงผลเนื้อหาการตอบกลับที่มีข้อมูลต่อไปนี้
messages[]: อาร์เรย์ของแหล่งข้อมูลMessagenextPageToken: สำหรับคำขอที่มีผลลัพธ์หลายหน้า โทเค็นที่ใช้กับการเรียกครั้งต่อๆ ไปเพื่อแสดงข้อความเพิ่มเติมresultSizeEstimate: จำนวนผลลัพธ์ทั้งหมดโดยประมาณ
หากต้องการดึงข้อมูลเนื้อหาและข้อมูลเมตาของข้อความทั้งหมด ให้ใช้ช่อง message.id เพื่อ
เรียกใช้
messages.get
เมธอด