เอกสารนี้อธิบายวิธีเรียกใช้เมธอด
messages.list
ของ Gmail API
เมธอดจะแสดงผลอาร์เรย์ของออบเจ็กต์ messages ของ Gmail ซึ่งมีidและthreadIdของข้อความ หากต้องการดึงรายละเอียดข้อความทั้งหมด ให้ใช้เมธอด messages.get
ข้อกำหนดเบื้องต้น
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